ruborg 0.3.1 → 0.4.0

data/ruborg.yml.example

@@ -1,28 +1,142 @@
-# Ruborg configuration example
+# Ruborg Example Configuration
+#
+# To use this configuration:
+#   cp ruborg.yml.example ruborg.yml
+#   chmod 600 ruborg.yml
+#   # Edit ruborg.yml with your settings
 
-# Repository path
-repository: /path/to/borg/repository
+# Global settings (applied to all repositories unless overridden)
+compression: lz4          # Options: lz4 (fast), zstd (balanced), lzma (high compression), none
+encryption: repokey       # Options: repokey, keyfile, none (NOT recommended)
+auto_init: true           # Automatically initialize repositories on first use
+auto_prune: true          # Automatically prune old backups after each backup
+log_file: ~/.ruborg/logs/ruborg.log  # Log file path (optional)
 
-# Paths to backup
-backup_paths:
-  - /home/user/documents
-  - /home/user/projects
-  - /etc
+# Custom Borg executable path (optional)
+# Use this if borg is not in PATH or you want to use a specific version
+# borg_path: /usr/local/bin/borg
 
-# Exclude patterns
-exclude_patterns:
-  - "*.tmp"
-  - "*.log"
-  - "*/.cache/*"
-  - "*/node_modules/*"
-  - "*/.git/*"
+# Global Passbolt integration (optional)
+# Store passphrases securely in Passbolt instead of config files
+passbolt:
+  resource_id: "your-global-passbolt-resource-id"
 
-# Compression algorithm (lz4, zstd, zlib, lzma, none)
-compression: lz4
+# Borg environment options (optional)
+# Configure security settings for Borg operations
+borg_options:
+  allow_relocated_repo: false      # Reject repos that have been moved (recommended: false)
+  allow_unencrypted_repo: false    # Reject unencrypted repos (recommended: false)
 
-# Encryption mode (repokey, keyfile, none)
-encryption: repokey
+# Global retention policy (can be overridden per repository)
+# Specify how many backups to keep
+retention:
+  keep_hourly: 24      # Keep 24 hourly backups
+  keep_daily: 7        # Keep 7 daily backups
+  keep_weekly: 4       # Keep 4 weekly backups
+  keep_monthly: 6      # Keep 6 monthly backups
+  keep_yearly: 1       # Keep 1 yearly backup
+  # Alternative time-based retention:
+  # keep_within: "7d"  # Keep all backups within 7 days
+  # keep_last: 30      # Keep last 30 backups
 
-# Passbolt integration (optional)
-passbolt:
-  resource_id: "your-passbolt-resource-uuid"
+# Multiple repositories
+repositories:
+  # Repository 1: Documents backup
+  - name: documents
+    description: "Personal and work documents backup"
+    path: /mnt/backup/borg-documents
+    sources:
+      - name: home-docs
+        paths:
+          - /home/user/Documents
+          - /home/user/Desktop
+        exclude:
+          - "*.tmp"
+          - "*.cache"
+          - ".git"
+      - name: work-docs
+        paths:
+          - /home/user/Work
+        exclude:
+          - "*.log"
+          - "node_modules"
+
+  # Repository 2: Database backups with per-file mode
+  - name: databases
+    description: "MySQL and PostgreSQL database dumps"
+    path: /mnt/backup/borg-databases
+    retention_mode: per_file  # Each file gets its own archive
+    # Repository-specific passbolt (overrides global)
+    passbolt:
+      resource_id: "database-backup-passbolt-id"
+    # Repository-specific retention policy
+    retention:
+      keep_files_modified_within: "30d"  # For per-file mode: keep files modified in last 30 days
+      keep_daily: 14
+    sources:
+      - name: mysql-dumps
+        paths:
+          - /var/backups/mysql
+      - name: postgres-dumps
+        paths:
+          - /var/backups/postgresql
+
+  # Repository 3: System configuration backups
+  - name: system-config
+    description: "System and application configuration files"
+    path: /mnt/backup/borg-config
+    compression: zstd         # Repository-specific compression (overrides global)
+    encryption: keyfile       # Repository-specific encryption (overrides global)
+    auto_prune: false         # Disable auto-pruning for this repo
+    sources:
+      - name: etc-configs
+        paths:
+          - /etc/nginx
+          - /etc/systemd/system
+          - /etc/fstab
+      - name: app-configs
+        paths:
+          - /home/user/.ssh/config
+          - /home/user/.gitconfig
+        exclude:
+          - "*.key"           # Don't backup private keys
+          - "*.pem"
+
+  # Repository 4: Media files (minimal compression, longer retention)
+  - name: media
+    description: "Photos and videos"
+    path: /mnt/backup/borg-media
+    compression: none         # Media files are already compressed
+    retention:
+      keep_monthly: 12        # Keep 12 monthly backups
+      keep_yearly: 5          # Keep 5 yearly backups
+    sources:
+      - name: photos
+        paths:
+          - /home/user/Pictures
+        exclude:
+          - "*.thumbs"
+          - "Thumbs.db"
+
+# Usage Examples:
+#
+# Backup all repositories:
+#   ruborg backup --all
+#
+# Backup specific repository:
+#   ruborg backup --repository documents
+#
+# List archives in a repository:
+#   ruborg list --repository documents
+#
+# Restore an archive:
+#   ruborg restore archive-name --repository documents --destination /restore/path
+#
+# Check repository integrity:
+#   ruborg check --repository documents --verify-data
+#
+# Initialize a new repository manually:
+#   ruborg init /path/to/repository --passbolt-id "your-passbolt-id"
+#
+# Get repository information:
+#   ruborg info --repository documents

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruborg
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Michail Pantelelis
@@ -10,33 +10,33 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: psych
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: psych
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -51,6 +51,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -93,10 +107,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: Ruborg is a Ruby gem that provides a user-friendly interface to Borg
-  backup. It reads YAML configuration files and orchestrates backup operations, supporting
-  repository creation, backup management, and integration with Passbolt for encryption
-  password management.
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruborg provides a user-friendly interface to Borg backup. It reads YAML
+  configuration files and orchestrates backup operations, supporting repository creation,
+  backup management, and Passbolt integration.
 email:
 - mpantel@aegean.gr
 executables:
@@ -105,6 +132,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CLAUDE.md
 - LICENSE
@@ -128,6 +156,7 @@ metadata:
   homepage_uri: https://github.com/mpantel/ruborg
   source_code_uri: https://github.com/mpantel/ruborg.git
   changelog_uri: https://github.com/mpantel/ruborg/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -142,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A friendly Ruby frontend for Borg backup
 test_files: []