kamal-backup 0.3.0.beta20 → 0.3.0.beta21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85d6ee6e04e1765b7dcb8666deb42f63b151437a57bccfbc79c18c94b53e0af7
-  data.tar.gz: 6d456b02c442c3316eb48f990d2b486410ed1541fd363abd4bed62e3d6018e68
+  metadata.gz: fac561fdadaa41333d7fb9a45c57ccce8fad9d941d5e1bf1b6505d11ed4455e9
+  data.tar.gz: 62f685b06d6ad3360fe652b2d1642a910dc3438427110eef548748ef5bb8de55
 SHA512:
-  metadata.gz: 9b7bd98124f478da8b1ee5bea4382880f924ab44dd9cb2325dd86d862dfb8fdcaf8f851fbaaf4003ba205243e81bcbdb7bbec928571655239964495e8753731b
-  data.tar.gz: a70c403b8b36a474339bd30ee84b8ae22fd11ff60b42aca6459abafc4fb43d3cb431ba1ab9f477f66326c0133d760043c7d35b28fca831451dfa705197132de3
+  metadata.gz: a2fc20a82dfa6f13531a10f93d10c23d50bfdc35adee3fa387551b33d8e22ba223c1b6416d99c113489b62b51e9ea0437213b9b7eeaa0e2c6d09030dbdf68e86
+  data.tar.gz: 3eb54b5786843e6290b9db9a89e078780a86196577acc8927b25a4f2abfe847b5dceaa1279e24293a66b24cb413158fcbb81acb1edc921fa4f3f836d1b27089d

data/README.md

@@ -72,6 +72,7 @@ accessories:
 ```
 
 For SQLite databases stored on the mounted storage volume, omit `:ro` from that volume.
+When the configured SQLite database file lives under a configured file backup path, `kamal-backup` excludes the raw database, WAL, and shared-memory files from the restic file snapshot automatically.
 
 Put the backup settings in `config/kamal-backup.yml`:
 

data/lib/kamal_backup/config.rb

@@ -51,6 +51,7 @@ module KamalBackup
         new(env: {}, database_definitions: nil, path_definitions: nil, restore_from_definitions: nil)
       end
     end
+    PathDefinition = Struct.new(:path, :exclude, keyword_init: true)
 
     class DatabaseSource
       CONNECTION_KEYS = %w[
@@ -225,12 +226,18 @@ module KamalBackup
 
     def backup_paths
       if path_definitions?
-        @path_definitions
+        @path_definitions.map(&:path)
       else
         legacy_backup_paths
       end
     end
 
+    def backup_path_excludes(paths = backup_paths)
+      paths = Array(paths).compact.map(&:to_s).reject(&:empty?)
+
+      configured_backup_path_excludes(paths) + sqlite_backup_path_excludes(paths)
+    end
+
     def local_restore_source_paths
       if path_definitions?
         @restore_from_definitions || legacy_local_restore_source_paths || backup_paths
@@ -500,7 +507,7 @@ module KamalBackup
           when "databases"
             result.database_definitions = normalize_yaml_databases(raw_value, raw_env: raw_env, path: path)
           when "paths"
-            result.path_definitions = normalize_yaml_paths(raw_value, "#{path} paths")
+            result.path_definitions = normalize_yaml_backup_paths(raw_value, "#{path} paths")
           when "restore_from"
             result.restore_from_definitions = normalize_yaml_paths(raw_value, "#{path} restore_from")
           when "restic"
@@ -684,6 +691,48 @@ module KamalBackup
         normalize_yaml_value(raw_value)
       end
 
+      def normalize_yaml_backup_paths(raw_value, context)
+        case raw_value
+        when Array
+          raw_value.map.with_index(1) do |entry, index|
+            normalize_yaml_backup_path(entry, "#{context}[#{index}]")
+          end.reject { |definition| definition.path.to_s.empty? }
+        when NilClass
+          []
+        else
+          [normalize_yaml_backup_path(raw_value, "#{context}[1]")].reject { |definition| definition.path.to_s.empty? }
+        end
+      end
+
+      def normalize_yaml_backup_path(raw_value, context)
+        case raw_value
+        when Hash
+          hash = require_mapping(raw_value, context)
+          unknown_keys = hash.keys - %w[path exclude]
+          unless unknown_keys.empty?
+            raise ConfigurationError, "#{context} contains unknown key #{unknown_keys.first.inspect}; expected path and exclude"
+          end
+
+          path = required_yaml_string(hash, "path", context)
+          exclude = hash.key?("exclude") ? normalize_yaml_excludes(hash["exclude"], "#{context}.exclude") : []
+          PathDefinition.new(path: path, exclude: exclude)
+        when Array
+          raise ConfigurationError, "#{context} must be a path string or a mapping with path and optional exclude"
+        else
+          PathDefinition.new(path: normalize_yaml_value(raw_value), exclude: [])
+        end
+      end
+
+      def normalize_yaml_excludes(raw_value, context)
+        entries = require_array(raw_value, context)
+        entries.map.with_index(1) do |entry, index|
+          pattern = optional_yaml_string(entry, "#{context}[#{index}]")
+          raise ConfigurationError, "#{context}[#{index}] must not be empty" if pattern.to_s.strip.empty?
+
+          pattern
+        end
+      end
+
       def resolve_yaml_value(raw_value, raw_env:, context:)
         case raw_value
         when Hash
@@ -743,6 +792,23 @@ module KamalBackup
         stringify_keys(value)
       end
 
+      def optional_yaml_string(value, context)
+        if value.is_a?(Hash) || value.is_a?(Array)
+          raise ConfigurationError, "#{context} must be a string"
+        end
+
+        normalize_yaml_value(value)
+      end
+
+      def required_yaml_string(hash, key, context)
+        raise ConfigurationError, "#{context} #{key} is required" unless hash.key?(key)
+
+        value = optional_yaml_string(hash[key], "#{context}.#{key}")
+        raise ConfigurationError, "#{context} #{key} is required" if value.to_s.strip.empty?
+
+        value
+      end
+
       def required_yaml_scalar(hash, key, context)
         value = normalize_yaml_value(hash[key])
         raise ConfigurationError, "#{context} #{key} is required" if value.to_s.empty?
@@ -806,6 +872,36 @@ module KamalBackup
         !@path_definitions.nil?
       end
 
+      def backup_path_definitions
+        if path_definitions?
+          @path_definitions
+        else
+          legacy_backup_paths.map { |path| PathDefinition.new(path: path, exclude: []) }
+        end
+      end
+
+      def configured_backup_path_excludes(paths)
+        backup_path_definitions.each_with_object([]) do |definition, excludes|
+          excludes.concat(definition.exclude) if paths.include?(definition.path)
+        end
+      end
+
+      def sqlite_backup_path_excludes(paths)
+        databases.select { |database| database.database_adapter == "sqlite" }.flat_map do |database|
+          sqlite_database_path = database.value("SQLITE_DATABASE_PATH")
+          next [] if sqlite_database_path.to_s.empty?
+          next [] unless paths.any? { |path| path_contains?(path, sqlite_database_path) }
+
+          [sqlite_database_path, "#{sqlite_database_path}-wal", "#{sqlite_database_path}-shm"]
+        end.uniq
+      end
+
+      def path_contains?(parent, child)
+        expanded_parent = File.expand_path(parent)
+        expanded_child = File.expand_path(child)
+        expanded_child == expanded_parent || expanded_child.start_with?(expanded_parent + "/")
+      end
+
       def legacy_database_adapter
         if explicit = value("DATABASE_ADAPTER")
           normalize_adapter(explicit)

data/lib/kamal_backup/restic.rb

@@ -75,8 +75,9 @@ module KamalBackup
 
       if paths.any?
         path_tags = paths.map { |path| "path:#{config.backup_path_label(path)}" }
+        excludes = config.backup_path_excludes(paths)
         log("backing up #{paths.size} file path(s): #{paths.join(", ")}")
-        run(["backup"] + host_args + paths + tag_args(common_tags + tags + path_tags))
+        run(["backup"] + host_args + exclude_args(excludes) + paths + tag_args(common_tags + tags + path_tags))
       end
     end
 
@@ -236,6 +237,10 @@ module KamalBackup
         tags.compact.each_with_object([]) { |tag, args| args.concat(["--tag", tag]) }
       end
 
+      def exclude_args(patterns)
+        patterns.compact.each_with_object([]) { |pattern, args| args.concat(["--exclude", pattern]) }
+      end
+
       def host_args
         ["--host", restic_host]
       end

data/lib/kamal_backup/version.rb

@@ -1,3 +1,3 @@
 module KamalBackup
-  VERSION = "0.3.0.beta20"
+  VERSION = "0.3.0.beta21"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kamal-backup
 version: !ruby/object:Gem::Version
-  version: 0.3.0.beta20
+  version: 0.3.0.beta21
 platform: ruby
 authors:
 - crmne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-06-02 00:00:00.000000000 Z
+date: 2026-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor