{"id":21147394,"url":"https://github.com/lytexdev/remote-backup","last_synced_at":"2025-04-13T11:11:20.087Z","repository":{"id":262153587,"uuid":"886274680","full_name":"lytexdev/remote-backup","owner":"lytexdev","description":"🔒 Remote Backup: Create backups to a remote server over SSH 🔒","archived":false,"fork":false,"pushed_at":"2024-11-30T21:47:19.000Z","size":29,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-27T02:21:32.258Z","etag":null,"topics":["backup","backup-tool","encrypted-backup","remote-backup","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lytexdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-10T16:40:25.000Z","updated_at":"2025-03-12T10:35:29.000Z","dependencies_parsed_at":"2024-11-10T21:32:45.147Z","dependency_job_id":"f50a15a1-61e5-4ebd-97d3-890369dad57d","html_url":"https://github.com/lytexdev/remote-backup","commit_stats":null,"previous_names":["lytexdev/remote-backup"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lytexdev%2Fremote-backup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lytexdev%2Fremote-backup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lytexdev%2Fremote-backup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lytexdev%2Fremote-backup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lytexdev","download_url":"https://codeload.github.com/lytexdev/remote-backup/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248703198,"owners_count":21148118,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backup","backup-tool","encrypted-backup","remote-backup","rust"],"created_at":"2024-11-20T09:01:30.013Z","updated_at":"2025-04-13T11:11:20.055Z","avatar_url":"https://github.com/lytexdev.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Remote Backup\n\n## Overview\nA Rust-based command-line application for creating, encrypting, and uploading backups to a remote server over SSH. This tool supports compression, encryption, and configurable backup retention policies.\n\n## Installation\n\n### Prerequisites\n- Rust\n- Cargo\n\n**Clone the repository**\n```bash\ngit clone https://github.com/lytexdev/remote-backup.git\ncd remote-backup\n```\n\n**Edit the `config.toml` configuration file**\n1. Copy and rename `config.example.toml` to `config.toml`\n2. Edit the `config.toml` file with the appropriate paths, encryption key path, and server information\n\n**Build the application**\n```bash\ncargo build --release\n```\nThe binary will be available in `./target/release/remote-backup`.\n\n## Configuration\nConfigure `config.toml` as follows:\n\n```toml\n[backup]\nbackup_folder = \"/path/to/folder\"           # Folder to backup\nexclude_paths = [\"/path/to/folder/cache\"]   # Paths to exclude from backup\nexclude_hidden = false                      # Exclude hidden files and directories (files/directories starting with .)\nremote_backup_dir = \"/path/to/remote/dir\"   # Directory on the remote server\nrestore_path = \"/path/to/restore\"           # Directory to restore files locally\ncompression_level = 9                       # Compression level (1-9)\nmax_backups = 3                             # Maximum number of backups to retain\ntmp_path = \"/path/to/tmp\"                   # Temporary file path for local backup\n\n[ssh]\nhost = \"127.0.0.1\"                          # Remote server hostname or IP\nport = 22                                   # SSH port\nuser = \"your-username\"                      # SSH user\nidentity_file = \"/path/to/ssh/key\"          # Path to SSH private key file\n\n[encryption]\nkey_path = \"/path/to/encryption/key\"        # Path were the encryption key will be generated and stored\n```\n\n## Key Generation\nBefore running backups, generate a 32-byte encryption key file in the configured `key_path`:\n```bash\n./target/release/remote-backup generate-key\n```\nThis will create a binary encryption key file at the specified `key_path`, used to securely encrypt and decrypt backups\n\n## Usage\n\n### Running a Backup\nTo create, encrypt, and upload a backup to the remote server:\n```bash\n./target/release/remote-backup backup\n```\n\n### Listing Backups\nTo list all backups stored on the remote server:\n```bash\n./target/release/remote-backup list\n```\n\n### Restoring a Backup\nTo download and decrypt a specific backup:\n```bash\n./target/release/remote-backup restore \u003cbackup-file-name\u003e\n```\n\n### Automatic backups\nUpload backups to the remote server every 24 hours with cron:\n```bash\ncrontab -e\n```\nAdd the following line to your crontab:\n```bash\n0 0 * * * /home/user/remote-backup/target/release/remote-backup -c /home/user/remote-backup/config.toml backup \u003e\u003e /var/log/remote_backup.log 2\u003e\u00261\n```\n\n#### Automatic backup log\nThe log file can be found at `/var/log/remote_backup.log`\n\n## Features\n- **Compression**: Backups are compressed using XZ for storage efficiency\n- **Encryption**: Ensures secure backup storage with encryption key specified in `config.toml`\n- **Configurable Paths**: Custom paths for backup, restoration, and temporary files\n- **Retention Policy**: Automatically deletes the oldest backup when the limit is reached\n\n## License\nThis project is licensed under the GNU General Public License v2. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flytexdev%2Fremote-backup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flytexdev%2Fremote-backup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flytexdev%2Fremote-backup/lists"}