Add remote backup capability using SCP
🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
20
README.md
20
README.md
@@ -40,6 +40,7 @@ Create new backup jobs by adding JSON configuration files to the `configs/` dire
|
||||
| `inputs` | List of directories/files to back up |
|
||||
| `ignorePatterns` | List of patterns to exclude from backup |
|
||||
| `archiveType` | Either `"tar"` (default, higher compression) or `"zip"` (faster, better compatibility) |
|
||||
| `remoteLocation` | Optional. Remote location for backup copy using scp format (e.g., `user@host:~/path`) |
|
||||
|
||||
Example configuration:
|
||||
|
||||
@@ -54,7 +55,8 @@ Example configuration:
|
||||
".git/",
|
||||
"node_modules/"
|
||||
],
|
||||
"archiveType": "zip"
|
||||
"archiveType": "zip",
|
||||
"remoteLocation": "user@remotehost:~/backups/"
|
||||
}
|
||||
```
|
||||
|
||||
@@ -89,6 +91,20 @@ The exclusion system uses simple string matching:
|
||||
- No regex or glob syntax is supported
|
||||
- For directories, adding a trailing slash (e.g., `.git/`) will exclude the directory and all its contents
|
||||
|
||||
## Remote Backup
|
||||
|
||||
With the optional `remoteLocation` setting, Simple-Backup can automatically:
|
||||
1. Check if the remote server is accessible
|
||||
2. Ensure the target directory exists on the remote server
|
||||
3. Copy the backup file via SCP after local backup completes
|
||||
|
||||
This requires:
|
||||
- SSH key-based authentication set up between your local and remote machines
|
||||
- The remote server must be accessible via SSH
|
||||
- You must have write permissions to the specified remote directory
|
||||
|
||||
If the remote copy fails for any reason, the local backup will still be preserved.
|
||||
|
||||
## What's Next?
|
||||
|
||||
After creating backups, you'll need to manually copy them to external storage or cloud services like Proton Drive, Google Drive, or Dropbox for off-site backup.
|
||||
If not using the remote backup feature, you'll need to manually copy your backups to external storage or cloud services like Proton Drive, Google Drive, or Dropbox for off-site backup.
|
||||
Reference in New Issue
Block a user