diff --git a/README.md b/README.md index 5641f08..07ef4bc 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # Albatross Back up what you care about in your Minecraft worlds. -Albatross backs up player files and region files within a certain configurable radius. It can also send Discord -webhooks. Backups are compressed and stored as `tar.gz` archives. +Albatross backs up player files and region files within a certain configurable radius. It can also send Discord +webhooks. Backups are compressed and stored as `tar.gz` archives. + +Backups can also be transferred to a remote server using SFTP. ## Help ``` @@ -40,14 +42,15 @@ Exporting a backup to a single player world: Restoring a single chunk (from -2,-2 to 2,2): -`albatorss -c test.toml restore world backups/04-11-20_01.51.27_backup.tar.gz sp.tar.gz (0,0)` +`albatorss -c test.toml restore world backups/04-11-20_01.51.27_backup.tar.gz sp.tar.gz` (0,0) Restoring a range of chunks (from -2,-2 to 2,2): -`albatorss -c test.toml restore world backups/04-11-20_01.51.27_backup.tar.gz sp.tar.gz (-2,-2) -u (2,2)` +`albatorss -c test.toml restore world backups/04-11-20_01.51.27_backup.tar.gz sp.tar.gz` (-2,-2) -u (2,2) ## Config ```toml +# Local Backup Config [backup] # Minecraft sever directory minecraft_dir = "/home/mc/server" @@ -55,13 +58,29 @@ minecraft_dir = "/home/mc/server" output_dir = "/home/mc/backups" # Number of backups to keep backups_to_keep = 10 -# Discord Webhook +# Optional Discord webhook discord_webhook = "https://discordapp.com/api/webhooks/" +# Optional remote backup config +[remote] +# SFTP server host:port +sftp_server_addr = "localhost:22" +# Remote directory +remote_dir = "/home/backup/" +# Remote user +username = "user" +# Password Auth +password = "cooluser123" +# Key Auth +#public_key = /home/user/.ssh/id_rsa.pub" +#private_key = /home/user/.ssh/id_rsa" +# Backups to keep on the remote host +backups_to_keep = 3 + # World config options [[world_config]] -# world name +# World name world_name = "world" -# world save radius (in blocks) +# World save radius (in blocks) save_radius = 8000 ``` \ No newline at end of file