kamal-backup 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2402ed466c957ae450d1e3196018d7099da3e01c59e7cc27e0a8dd7db0dbec5b
-  data.tar.gz: 43d46f5648d0a2e410ea3fee13876a65c032b42a7260adb7a9210f8e8452ae6c
+  metadata.gz: aa8276219db8c5d8aa820e85e0f289f87715889cb5ea18ae2c99e3e12bbfe6b9
+  data.tar.gz: 626824ed56029bf3b713676d3376ab38d571942ee3809e7cf18abbfde9c24a45
 SHA512:
-  metadata.gz: 645f1b5d3a0da81237a3391efde6f22747447b93504580693ebe2dd0e7fb2d81024a00d54d427890992234687034948b25053d741e8a974ee379a385b9e6a9d3
-  data.tar.gz: 83577eddd32f3cd423408fea71c75769138d5b67041d555b369478129f20045eea2d51fd031b45067e6862a53dc6b4a2f7218a374e57a879d9ff606a41258c2d
+  metadata.gz: 75d362d35409c0447c29994a7bf4d23ac47d287fc88621eb46f32a56296537217cee76a28799983f45154361ecd61e4f553b609144969bed2b10016bf0ecc09c
+  data.tar.gz: e5f664a15123066441b940d945caed2335d8b50356acaa64d9ae6f49d87a7705894234e55db42ec6508aa188f727b01d4e4d4c71688ecd93b4dbf4c12d53ef5d

data/README.md

@@ -99,6 +99,8 @@ backup:
   schedule: 1d
 ```
 
+Only paths explicitly listed under `paths` are included in file snapshots. Omit `paths` for a database-only backup; `kamal-backup` never infers `storage` from Rails.
+
 Boot it. The container runs `kamal-backup schedule` by default:
 
 ```sh

data/lib/kamal_backup/app.rb

@@ -32,6 +32,7 @@ module KamalBackup
     def backup(force: false)
       started_at = Time.now.utc
       config.validate_backup
+      return disabled_backup_result(started_at) unless config.backup_enabled? || force
       return skipped_backup_result(started_at) unless force || backup_due?(started_at)
 
       restic.ensure_repository
@@ -136,6 +137,18 @@ module KamalBackup
       due_at.nil? || now >= due_at
     end
 
+    def disabled_backup_result(now)
+      Schema.record(
+        kind: 'backup_result',
+        status: 'skipped',
+        reason: 'disabled',
+        last_backup_at: last_backup_finished_at&.iso8601,
+        next_backup_at: nil,
+        force_command: 'kamal-backup backup --force',
+        finished_at: now.iso8601
+      )
+    end
+
     def skipped_backup_result(now)
       Schema.record(
         kind: 'backup_result',

data/lib/kamal_backup/cli/helpers.rb

@@ -140,6 +140,13 @@ module KamalBackup
       end
 
       def print_backup_result(result)
+        if result[:status] == 'skipped' && result[:reason] == 'disabled'
+          puts('Backups are disabled for this app (backup.enabled is false).')
+          puts('Set backup.enabled to true and redeploy the accessory to resume scheduled backups.')
+          puts("Run `#{result.fetch(:force_command)}` to take one anyway.")
+          return
+        end
+
         if result[:status] == 'skipped'
           puts("No backup due. Last backup finished at #{result.fetch(:last_backup_at)}.")
           puts("Next backup is due at #{result.fetch(:next_backup_at)}.")

data/lib/kamal_backup/cli.rb

@@ -26,15 +26,15 @@ module KamalBackup
         CLI.basename
       end
 
-      desc 'local [SNAPSHOT]', 'Restore the backup into the local database and Active Storage path'
+      desc 'local [SNAPSHOT]', 'Restore the backup into the local database and configured file paths'
       def local(snapshot = 'latest')
-        confirm!("Restore #{snapshot} into the local database and Active Storage path? This will overwrite local data.")
+        confirm!("Restore #{snapshot} into the local database and configured file paths? This will overwrite local data.")
         puts(JSON.pretty_generate(local_restore_app.restore_to_local_machine(snapshot)))
       end
 
       method_option :"confirm-production-restore", type: :boolean, default: false,
                                                    desc: 'Confirm production restore without interactive prompts'
-      desc 'production [SNAPSHOT]', 'Restore the backup into the production database and Active Storage path'
+      desc 'production [SNAPSHOT]', 'Restore the backup into the production database and configured file paths'
       def production(snapshot = 'latest')
         confirm_production_restore!(snapshot)
 
@@ -133,7 +133,7 @@ module KamalBackup
     class_option :config_file, aliases: '-c', type: :string, desc: 'Path to Kamal deploy config file'
     class_option :destination, aliases: '-d', type: :string, desc: 'Kamal destination to use'
     remove_command :tree
-    desc 'restore SUBCOMMAND ...ARGS', 'Restore a database and Active Storage backup locally or into production'
+    desc 'restore SUBCOMMAND ...ARGS', 'Restore database and configured file backups locally or into production'
     subcommand 'restore', RestoreCLI
     desc 'drill SUBCOMMAND ...ARGS', 'Run a restore drill on the local machine or on production infrastructure'
     subcommand 'drill', DrillCLI
@@ -162,7 +162,7 @@ module KamalBackup
 
     method_option :force, type: :boolean, default: false,
                           desc: 'Run a backup even if the configured schedule is not due'
-    desc 'backup', 'Run a due database and Active Storage backup'
+    desc 'backup', 'Run a due database and configured file backup'
     def backup
       if remote_command_mode?
         argv = %w[kamal-backup backup]
@@ -238,10 +238,11 @@ module KamalBackup
       puts
       puts deploy_snippet
       puts
-      puts 'The accessory runs scheduled database and file backups with backup.schedule.'
-      puts 'For most Rails apps, restore local and drill local can infer the development database, Active Storage path, and tmp state directory.'
+      puts 'The accessory runs scheduled database and configured file backups with backup.schedule.'
+      puts 'File backups run only for paths explicitly configured in config/kamal-backup.yml.'
+      puts 'Rails local restores infer the development database and tmp state directory, but never file paths.'
       puts 'Local restore and drill also require the restic binary on your machine.'
-      puts 'Create config/kamal-backup.local.yml only if you need to override those local defaults.'
+      puts 'When production paths are configured, set their local targets in config/kamal-backup.local.yml.'
     end
 
     desc 'schedule', 'Run the foreground scheduler loop'

data/lib/kamal_backup/config.rb

@@ -168,6 +168,10 @@ module KamalBackup
       truthy?('KAMAL_BACKUP_ALLOW_SUSPICIOUS_PATHS')
     end
 
+    def backup_enabled?
+      !falsey?('BACKUP_ENABLED')
+    end
+
     def backup_schedule_seconds
       integer('BACKUP_SCHEDULE_SECONDS', 86_400, minimum: 1)
     end
@@ -214,7 +218,10 @@ module KamalBackup
       source_paths = local_restore_source_paths
       target_paths = backup_paths
 
-      raise ConfigurationError, 'local restore source paths must contain the same number of paths as file paths' unless source_paths.size == target_paths.size
+      unless source_paths.size == target_paths.size
+        raise ConfigurationError,
+              'local file paths must be explicitly configured and match the number of production restore source paths'
+      end
 
       source_paths.zip(target_paths)
     end

data/lib/kamal_backup/config_file.rb

@@ -271,6 +271,7 @@ module KamalBackup
       hash = require_mapping(raw_value, "#{@path} backup")
       env = {}
       env['BACKUP_SCHEDULE_SECONDS'] = normalize_duration(hash['schedule'], "#{@path} backup.schedule") if hash.key?('schedule')
+      env['BACKUP_ENABLED'] = normalize_value(hash['enabled']) if hash.key?('enabled')
       env.compact
     end
 

data/lib/kamal_backup/rails_app.rb

@@ -22,9 +22,6 @@ module KamalBackup
       {}.tap do |defaults|
         defaults.merge!(deploy_defaults)
         defaults.merge!(database_defaults)
-
-        defaults['BACKUP_PATHS'] = local_storage_path if local_storage_path
-
         defaults['KAMAL_BACKUP_STATE_DIR'] = File.join(@cwd, 'tmp', 'kamal-backup')
       end
     end
@@ -90,10 +87,6 @@ module KamalBackup
       end
     end
 
-    def local_storage_path
-      File.join(@cwd, 'storage')
-    end
-
     def local_database_config
       environment = fetch(parsed_yaml(database_config_path), DEVELOPMENT_ENV)
       return nil unless environment.is_a?(Hash)

data/lib/kamal_backup/scheduler.rb

@@ -15,6 +15,17 @@ module KamalBackup
       $stderr.sync = true
 
       install_signal_handlers
+
+      unless @config.backup_enabled?
+        # Stay up rather than exit: the accessory is still how restore, list, check and
+        # evidence reach the repository, and exiting would restart-loop under Kamal's
+        # `--restart unless-stopped`. Set backup.enabled to true and redeploy to resume.
+        log('scheduled backups are disabled (backup.enabled is false); no backups will be taken')
+        idle_until_stopped
+        log("scheduler stopped at #{Time.now.utc.iso8601}")
+        return
+      end
+
       sleep_interruptibly(@config.backup_start_delay_seconds)
 
       until @stop
@@ -43,6 +54,10 @@ module KamalBackup
       end
     end
 
+    def idle_until_stopped
+      sleep 1 until @stop
+    end
+
     def sleep_interruptibly(seconds)
       deadline = Time.now + seconds
       sleep([deadline - Time.now, 1].min) while !@stop && Time.now < deadline

data/lib/kamal_backup/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KamalBackup
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kamal-backup
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - crmne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-07-25 00:00:00.000000000 Z
+date: 2026-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor