Step-by-step guide to setting up egFtpBackup for remote servers
1. Prerequisites
- Server access: SSH or control-panel access to the remote server and the backup destination.
- Credentials: FTP(S)/SFTP hostname, username, password (or key), and port.
- Permissions: Ability to read files to back up and write to the remote FTP destination.
- Software: egFtpBackup package (installer or archive) and a system with a compatible runtime (e.g., Python/Java—assume egFtpBackup supports your OS).
2. Install egFtpBackup
- Download the latest egFtpBackup release to your local or remote machine.
- Extract or run the installer:
- Linux/macOS (tar/zip): unpack, then run the included install script:
Code
sudo ./install.sh - Windows: run the installer executable and follow prompts.
- Linux/macOS (tar/zip): unpack, then run the included install script:
3. Create configuration file
- Locate the sample config (often config.example.json or config.yaml).
- Copy it to config.json (or config.yaml).
- Edit required fields:
- source_paths: list of directories/files to back up.
- remote: { host, port, protocol (FTP/FTPS/SFTP), username, password or keypath }
- schedule: cron expression or interval (daily, hourly).
- retention: number of backups to keep.
- encryption: enable and provide passphrase if supported.
Example (JSON-like):
Code
{ “source_paths”: [“/var/www”, “/etc/nginx/nginx.conf”], “remote”: { “host”: “ftp.example.com”, “port”: 22, “protocol”: “sftp”, “username”: “backup”, “key_path”: “/home/backup/.ssh/id_rsa” }, “schedule”: “daily”, “retention”: 7, “encryption”: { “enabled”: true, “passphrase”: “REPLACEME” } }
4. Test connectivity
- Run egFtpBackup in test or dry-run mode (if available):
Code
egftpbackup –config /path/to/config.json –dry-run - Verify it can list/upload to the remote host; fix firewall or credential issues if it fails.
5. Run an initial backup
- Execute a manual backup to verify contents and uploads:
Code
egftpbackup –config /path/to/config.json –run - Confirm files appear on the remote server and checksums match (if provided).
6. Schedule automated backups
- Use built-in scheduling (if supported) or system scheduler:
- Cron (Linux/macOS): open crontab (
crontab -e) and add:Code
0 2 * * * /usr/local/bin/egftpbackup –config /path/to/config.json –run >> /var/log/egftpbackup.log 2>&1 - Windows Task Scheduler: create a task to run the egFtpBackup executable with –run and the config path.
- Cron (Linux/macOS): open crontab (
7. Configure retention and rotation
- Ensure retention settings are active in config or implement a rotation script that deletes older backups beyond retention limits on the remote host.
8. Enable notifications and monitoring
- Configure email or webhook alerts for success/failure in config (if supported) or wrap runs with scripts that send notifications based on exit codes.
9. Secure your setup
- Prefer SFTP or FTPS over plain FTP.
- Use SSH keys instead of passwords.
- Store encryption passphrases and keys in a protected secrets store (e.g., environment variables, OS keychain, or vault).
- Limit backup account permissions on the remote host to only the necessary directories.
10. Regular maintenance
- Test restore monthly: download a backup and restore to a staging server to verify integrity.
- Rotate keys/passphrases periodically.
- Monitor disk usage on both source and remote destination.
If you want, I can generate a ready-to-use sample config for your environment (specify OS, protocol, and sample source paths).
Leave a Reply