aboutsummaryrefslogtreecommitdiff
path: root/Readme.md
diff options
context:
space:
mode:
authorGravatar Jonas Gunz <himself@jonasgunz.de> 2020-01-04 18:09:50 +0100
committerGravatar Jonas Gunz <himself@jonasgunz.de> 2020-01-04 18:09:50 +0100
commit272bd7bcc4e1aab834ea2ddb76ea0bae84330a87 (patch)
tree4ac8016388f41f21fc46ff1f4e88fdc1e37ef65d /Readme.md
parentb0246c61aebe3c847690f96247c6ff23360172ae (diff)
downloadminecraft-server-tools-272bd7bcc4e1aab834ea2ddb76ea0bae84330a87.tar.gz
Updated Readme, more checks
Diffstat (limited to 'Readme.md')
-rw-r--r--Readme.md38
1 files changed, 31 insertions, 7 deletions
diff --git a/Readme.md b/Readme.md
index 0512098..29a3792 100644
--- a/Readme.md
+++ b/Readme.md
@@ -2,24 +2,48 @@
My minecraft server management script with safe online Backup.
+## Configuration
+
+Config-variables are located at the top of `server.sh`
+
## Usage
-`./server.sh start|stop|attach|status`
+`./server.sh start|stop|attach|status|backup`
+
+### start
+
+Creates a `screen` session and starts a minecraft server within.
+Fails, if a session is already running with the same sessionname.
+
+### stop
+
+Sends `stop` command to running server instance to safely shut down.
+
+### attach
+
+attaches to `screen` session. Exit with `CTRL + A d`
+
+### status
+
+lists active screen sessions with `SCREEN_SESSIONNAME`.
-`attach` attaches to the server console using `screen`. to detach, type: `CTRL+A d`
+### backup
-Configuration is located at at the top of the script.
+Backs up the world as a `tar.gz` archive in `./backup/`.
+If a running server is detected,
+the world is flushed to disk and autosave is disabled temporarily to prevent chunk corruption.
The command specified in `$BACKUP_HOOK` is
-executed on every backup. `$ARCHNAME` contains the relative path to the backup.
+executed on every successful backup. `$ARCHNAME` contains the relative path to the archive.
+This can be used to further process the created backup.
-Example:
+The following example copies the created archive to a remote server.
- scp $ARCHNAME user@server:/home/backups/
+ BACKUP_HOOK="scp $ARCHNAME user@server:/home/user/backups/"
## Disclaimer
The scripts are provided as-is at no warranty.
-They are not idiot-proof.
+They are in no way idiot-proof.
Improvements are welcome.