Reorganize readme
This commit is contained in:
Nicolas Chan
parent
1c4162455f
commit
b8094d758e
1 changed files with 33 additions and 29 deletions
62
README.md
62
README.md
|
|
@ -2,13 +2,8 @@
|
|||
|
||||
[](https://codecov.io/gh/nicolaschan/minecraft-backup)
|
||||
|
||||
Backup script for Linux servers running a Minecraft server.
|
||||
Supports servers running in [GNU screen](https://en.wikipedia.org/wiki/GNU_Screen), [tmux](https://en.wikipedia.org/wiki/Tmux), or with [rcon](https://wiki.vg/RCON) enabled.
|
||||
|
||||
### Disclaimer
|
||||
Backups are essential to the integrity of your Minecraft world. You should automate regular backups and **check that your backups work**. While this script has been used in production for several years, it is up to you to make sure that your backups work and that you have a reliable backup policy.
|
||||
|
||||
Please refer to the LICENSE (MIT License) for the full legal disclaimer.
|
||||
Backup script for Minecraft servers on Linux.
|
||||
Supports servers running in [screen](https://en.wikipedia.org/wiki/GNU_Screen), [tmux](https://en.wikipedia.org/wiki/Tmux), or with [rcon](https://wiki.vg/RCON) enabled.
|
||||
|
||||
## Features
|
||||
- Create backups of your world folder
|
||||
|
|
@ -19,24 +14,19 @@ Please refer to the LICENSE (MIT License) for the full legal disclaimer.
|
|||
- Works on vanilla -- no plugins required
|
||||
- Able to print backup status and info to the Minecraft chat
|
||||
|
||||
## Why not just use `tar` directly?
|
||||
If the Minecraft server is currently running, you need to disable world autosaving, or you will likely get an error like this:
|
||||
```
|
||||
tar: /some/path/here/world/region/r.1.11.mca: file changed as we read it
|
||||
```
|
||||
This script will take care of disabling and then re-enabling autosaving for you, and also alert players in the chat of successful backups or errors. This script also manages deleting old backups.
|
||||
|
||||
## Requirements
|
||||
- Linux computer (tested on Ubuntu)
|
||||
- GNU Screen (running your Minecraft server)
|
||||
- Minecraft server
|
||||
|
||||
## Quick Start
|
||||
## Install
|
||||
```bash
|
||||
wget https://raw.githubusercontent.com/nicolaschan/minecraft-backup/master/backup.sh
|
||||
chmod +x backup.sh
|
||||
```
|
||||
|
||||
## Usage
|
||||
```bash
|
||||
./backup.sh -c -i /home/user/mcserver/world -o /mnt/storage/backups -s minecraft
|
||||
```
|
||||
|
||||
This will show chat messages (`-c`) in the screen called "minecraft" and save a backup of `/home/user/mcserver/world` into `/mnt/storage/backups` using the default thinning deletion policy for old backups.
|
||||
|
||||
Command line options:
|
||||
```text
|
||||
-a Compression algorithm (default: gzip)
|
||||
|
|
@ -56,16 +46,13 @@ Command line options:
|
|||
-w Window manager: screen (default) or tmux
|
||||
```
|
||||
|
||||
Example usage of command line options:
|
||||
```bash
|
||||
./backup.sh -c -i /home/nicolas/mcserver/world -o /mnt/storage/backups -s minecraft
|
||||
```
|
||||
This will show chat messages (`-c`) in the screen called "minecraft" and save a backup of `/home/nicolas/mcserver/world` into `/mnt/storage/backups` using the default thinning deletion policy for old backups.
|
||||
|
||||
### Create a cron job to automatically backup:
|
||||
### Automate backups with cron
|
||||
- Edit the crontab with `crontab -e`
|
||||
- Example for hourly backups: `00 * * * * /path/to/backup.sh ...`
|
||||
|
||||
- Example for hourly backups:
|
||||
```
|
||||
00 * * * * /path/to/backup.sh -c -i /home/user/mcserver/world -o /mnt/storage/backups -s minecraft
|
||||
```
|
||||
|
||||
## Retrieving Backups
|
||||
Always test your backups! Backups are in the `tar` format and compressed depending on the option you choose. To restore, first decompress if necessary and then extract using tar. You may be able to do this in one command if `tar` supports your compression option, as is the case with `gzip`:
|
||||
|
||||
|
|
@ -78,6 +65,13 @@ tar -xzvf /path/to/backups/2019-04-09_02-15-01.tar.gz
|
|||
|
||||
Then you can move your restored world (`restored-world` in this case) to your Minecraft server folder and rename it (usually called `world`) so the Minecraft server uses it.
|
||||
|
||||
## Why not use `tar` directly?
|
||||
If the Minecraft server is currently running, you need to disable world autosaving, or you will likely get an error like this:
|
||||
```
|
||||
tar: /some/path/here/world/region/r.1.11.mca: file changed as we read it
|
||||
```
|
||||
This script will take care of disabling and then re-enabling autosaving for you, and also alert players in the chat of successful backups or errors. This script also manages deleting old backups.
|
||||
|
||||
## Help
|
||||
- Make sure the compression algorithm you specify is installed on your system. (zstd is not installed by default)
|
||||
- Make sure your compression algorithm is in the crontab's PATH
|
||||
|
|
@ -85,3 +79,13 @@ Then you can move your restored world (`restored-world` in this case) to your Mi
|
|||
- It's surprising how much space backups can take--make sure you have enough empty space
|
||||
- Do not put trailing `/` in the `SERVER_DIRECTORY` or `BACKUP_DIRECTORY`
|
||||
- If "thin" delete method is behaving weirdly, try emptying your backup directory or switch to "sequential"
|
||||
|
||||
## Disclaimer
|
||||
Backups are essential to the integrity of your Minecraft world. You should automate regular backups and **check that your backups work**. It is up to you to make sure that your backups work and that you have a reliable backup policy.
|
||||
|
||||
Some backup tips:
|
||||
- Drives get corrupted or fail! Backup to a _different_ drive than the one your server is running on, so if your main drive fails then you have backups.
|
||||
- _Automate_ backups so you never lose too much progress.
|
||||
- Check that your backups work from time to time.
|
||||
|
||||
Please refer to the LICENSE (MIT License) for the full legal disclaimer.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue