nev/minecraft-backup
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Nicolas Chan 2020-03-21 21:00:42 -07:00 • committed by GitHub
parent 4350eeb9ae
commit 9605352be0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
README.md
View file

@ -97,18 +97,7 @@ WantedBy=timers.target
`~/.config/systemd/user/minecraft-backup.service` `~/.config/systemd/user/minecraft-backup.service`
```systemd ```systemd
[Unit] [Unit]
Description=Run Minecraft backup hourly Description=Perform Minecraft backup
[Timer]
OnCalendar=hourly
Persistent=false
Unit=minecraft-backup@.service
[Install]
WantedBy=timers.target
[nicolas@monad user]$ cat minecraft-backup\@.service
[Unit]
Description=Perfrom Minecraft Backup
[Service] [Service]
Type=oneshot Type=oneshot
@ -118,7 +107,21 @@ ExecStart=/path/to/minecraft-backup/backup.sh -c -s minecraft -i /path/to/world
WantedBy=multi-user.target WantedBy=multi-user.target
``` ```
Then you can run the following to enable the timer:
```bash
# enable the timer right now only
systemd --user start minecraft-backup.timer
# start the timer on reboot
systemd --user enable minecraft-backup.timer
# see status of timers
systemd --user list-timers
```
#### Advanced example (with restic and multiple servers) #### Advanced example (with restic and multiple servers)
If you have multiple servers, you can use `@` to create timers on-demand for each server. This assumes the server directories are named the same as the screen name.
`~/.config/systemd/user/minecraft-backup.timer` `~/.config/systemd/user/minecraft-backup.timer`
```systemd ```systemd
[Unit] [Unit]
@ -135,18 +138,7 @@ WantedBy=timers.target
`~/.config/systemd/user/minecraft-backup@.service` `~/.config/systemd/user/minecraft-backup@.service`
```systemd ```systemd
[Unit] [Unit]
Description=Run Minecraft backup hourly Description=Perform Minecraft backup
[Timer]
OnCalendar=hourly
Persistent=false
Unit=minecraft-backup@.service
[Install]
WantedBy=timers.target
[nicolas@monad user]$ cat minecraft-backup\@.service
[Unit]
Description=Perfrom Minecraft Backup
[Service] [Service]
Type=oneshot Type=oneshot
@ -157,6 +149,12 @@ ExecStart=/path/to/minecraft-backup/backup-restic.sh -c -s %i -i /path/to/server
WantedBy=multi-user.target WantedBy=multi-user.target
``` ```
To enable:
```bash
systemd --user enable minecraft-backup@your_server_name_here
```
## Retrieving Backups ## 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`: 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`: