Files

check / check (pull_request) Successful in 4m57s

Details

feat: implement daemon mode with filesystem watching

Replace the daemon mode stub with a full implementation that:

- Watches configured snapshot paths for filesystem changes using
  fsnotify (inotify on Linux, FSEvents on macOS, etc.)
- Runs an initial full backup on startup
- Triggers incremental backups at backup_interval when changes are
  detected, only for snapshots whose paths were affected
- Performs full periodic scans at full_scan_interval regardless of
  detected changes
- Respects min_time_between_run to prevent excessive backup runs
- Handles SIGTERM/SIGINT for graceful shutdown, completing any
  in-progress backup before exiting
- Automatically watches newly created subdirectories
- Uses a backup semaphore to prevent concurrent backup runs

New files:
- internal/vaultik/daemon.go: RunDaemon(), changeTracker, watcher setup
- internal/vaultik/daemon_test.go: Tests for changeTracker, isSubpath,
  concurrency safety, and daemon constants

closes #3

2026-03-24 09:48:06 -07:00

3.6 KiB

Raw Blame History

Vaultik 1.0 TODO

Linear list of tasks to complete before 1.0 release.

Rclone Storage Backend (Complete)

Add rclone as a storage backend via Go library import, allowing vaultik to use any of rclone's 70+ supported cloud storage providers.

Configuration:

storage_url: "rclone://myremote/path/to/backups"

User must have rclone configured separately (via rclone config).

Implementation Steps:

Add rclone dependency to go.mod
Create internal/storage/rclone.go implementing Storer interface
- NewRcloneStorer(remote, path) - init with configfile.Install() and fs.NewFs()
- Put / PutWithProgress - use operations.Rcat()
- Get - use fs.NewObject() then obj.Open()
- Stat - use fs.NewObject() for size/metadata
- Delete - use obj.Remove()
- List / ListStream - use operations.ListFn()
- Info - return remote name
Update internal/storage/url.go - parse rclone://remote/path URLs
Update internal/storage/module.go - add rclone case to storerFromURL()
Test with real rclone remote

Error Mapping:

fs.ErrorObjectNotFound → ErrNotFound
fs.ErrorDirNotFound → ErrNotFound
fs.ErrorNotFoundInConfigFile → ErrRemoteNotFound (new)

CLI Polish (Priority)

Improve error messages throughout
- Ensure all errors include actionable context
- Add suggestions for common issues (e.g., "did you set VAULTIK_AGE_SECRET_KEY?")

Security (Priority)

Audit encryption implementation
- Verify age encryption is used correctly
- Ensure no plaintext leaks in logs or errors
- Verify blob hashes are computed correctly
Secure memory handling for secrets
- Clear S3 credentials from memory after client init
- Document that age_secret_key is env-var only (already implemented)

Testing

Write integration tests for restore command
Write end-to-end integration test
- Create backup
- Verify backup
- Restore backup
- Compare restored files to originals
Add tests for edge cases
- Empty directories
- Symlinks
- Special characters in filenames
- Very large files (multi-GB)
- Many small files (100k+)
Add tests for error conditions
- Network failures during upload
- Disk full during restore
- Corrupted blobs
- Missing blobs

Performance

Profile and optimize restore performance
- Parallel blob downloads
- Streaming decompression/decryption
- Efficient chunk reassembly
Add bandwidth limiting option
- --bwlimit flag for upload/download speed limiting

Documentation

Add man page or --help improvements
- Detailed help for each command
- Examples in help output

Final Polish

Ensure version is set correctly in releases
Create release process
- Binary releases for supported platforms
- Checksums for binaries
- Release notes template
Final code review
- Remove debug statements
- Ensure consistent code style
Tag and release v1.0.0

Daemon Mode (Complete)

Implement cross-platform filesystem watcher (via fsnotify)
- Watches source directories for changes
- Tracks dirty paths in memory
- Automatically watches new directories
Implement backup scheduler in daemon mode
- Respects backup_interval config
- Triggers backup when dirty paths exist and interval elapsed
- Implements full_scan_interval for periodic full scans
- Respects min_time_between_run to prevent excessive runs
Add proper signal handling for daemon
- Graceful shutdown on SIGTERM/SIGINT
- Completes in-progress backup before exit
Write tests for daemon mode

3.6 KiB Raw Blame History