Skip to content

yeahwhat-mc/mark2-backup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 

Repository files navigation

mark2 backup

Bash script to backup mark2 based Minecraft servers CPU and I/O friendly.

Configuration

As you might see, this script creates a configration file in your `$HOME folder.

Make sure you made all adjustments as your needs for the following variables:

  • MARK2NAME
  • SERVERDIR
  • BACKUPDIR
  • WORLDS
  • EXCLUDES

You can also override:

  • RUNAS (minecraft by default)
  • RUNBACKUP_NICE (${BIN_NICE} -n19 by default)
  • RUNBACKUP_IONICE (${BIN_IONICE} -c 3 by default)
  • TIMESTAMP ($(date +"%Y-%m-%d-00-00") by default)
  • ANNOUNCE (false by default)
  • SAY_BACKUP_START (Backup started... by default)
  • SAY_BACKUP_FINISHED (Backup successfully finished. by default)

Usage

m2backup backup <world>  Backup the server.
m2backup list [world     List current incremental backups.
              -debug     Enable debug output (Must be the last argument).

Installation

Bash script

cd /usr/local/src
git clone https://github.com/yeahwhat-mc/mark2-backup.git
ln -s /usr/local/src/mark2-backup/m2backup /usr/bin/m2backup
chmod a+x /usr/bin/m2backup
mkdir -p /opt/backups/minecraft
chown -R $RUNUSER /opt/backups

Create configuration files

To create the default configuration files which you can use as template, just issue:

m2backup

[INFO] Creating configuration folder /opt/minecraft/.minebackup
[INFO] Creating default configuration file /opt/minecraft/.minebackup/default.conf
[INFO] Successfully created default configuration files, go ahead and adjust the default configuration as you wish.

Use the default template:

cp /opt/minecraft/.minebackup/default.conf /opt/minecraft/.minebackup/main.conf

Now edit the necessary variables (especially the WORLDS and EXCLUDES) or/and override the additional ones:

vi /opt/minecraft/.minebackup/main.conf

First run

m2backup backup main

cron.d

You can find an example cron.d file in the lib/cron.d folder:

cp /usr/local/src/mark2-backup/lib/cron.d/m2backup /etc/cron.d/m2backup

Dependencies

You need nice, ionice, tar and mark2 to use all features of minebackup.sh:

Todo

  • List backups

License

MIT

About

Bash script to backup mark2 based Minecraft servers

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages