msm/msm.conf

214 lines
7.9 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

#
# Minecraft Server Manager Configuration File
# ===========================================
#
#
# User
# ----
# The user which Minecraft Server Manager commands will be executed as.
# Also used by default for starting servers who do not specify an individual
# server user.
USERNAME="minecraft"
# Directory Locations
# -------------------
# These values are very important. They define where MSM stores various files
# Where new servers are stored
SERVER_STORAGE_PATH="/opt/msm/servers"
# Where runnable jar files for use by servers are stored
JAR_STORAGE_PATH="/opt/msm/jars"
# Where versioning data is stored to help MSM accommodate all Minecraft versions
VERSIONING_STORAGE_PATH="/opt/msm/versioning"
# Change this to "true" to allow MSM to use RAMDisk for storing worlds.
# Note: RAMDisk will only be used for worlds enabled as "in ram".
RAMDISK_STORAGE_ENABLED="true"
# Where RAM enabled worlds are stored
# This needs to be a path located inside the mounted ramdisk for your system
# under Ubuntu this would be "/dev/shm", so "/dev/shm/msm" would be a good
# location. This is ignored if RAMDISK_STORAGE_ENABLED is not "true"
RAMDISK_STORAGE_PATH="/dev/shm/msm"
# Backup Options
# -------------------
# Quick IMPORTANT note:
# The following three paths are used to store backups of your servers which
# MSM creates periodically. Backups are useful if a world becomes unplayable
# and needs to be restored to an earlier point in time. Or maybe a new plugin
# for a server corrupts some files. In these cases you can restore to a
# backup from these directories.
#
# If you want protection for disk failure also, be sure to specify paths to a
# separate disk. This can be achieved by mounting an external hard drive, or
# a NAS and locating the following paths there.
# Did zip backup enabled ?
WORLD_ARCHIVE_ENABLED="true"
# Where "WorldEdit snapshot" compatible world backups are stored.
WORLD_ARCHIVE_PATH="/opt/msm/archives/worlds"
# Where archived logs are stored, when a servers logs are "rolled":
LOG_ARCHIVE_PATH="/opt/msm/archives/logs"
# Where complete server backups are stored:
BACKUP_ARCHIVE_PATH="/opt/msm/archives/backups"
# rdiff-backup for worlds note:
# If you want to use rdiff-backup as backup system for your worlds you need to have
# it installed on your server.
# You can enable it and set number of days to keep versions in RDIFF_BACKUP_ROTATION.
# The RDIFF_BACKUP_NICE indice is the priority when the task is launched: -20 is
# the higher priority, let to default (19) as a less priority is probably what you need.
# Did rdiff-backup enabled ?
RDIFF_BACKUP_ENABLED="false"
# Number of days to keep versions
RDIFF_BACKUP_ROTATION="7"
# The nice parameter "-20" to "19", -20 is the higher priority on the system, 19 is the lessest
RDIFF_BACKUP_NICE="19"
# Where "rdiff-backup" world backups are stored.
WORLD_RDIFF_PATH="/opt/msm/rdiff-backup/worlds"
# rsync backup note:
# rsync backups are simple copies of your world data. They are similar to the default
# zip backups but are not placed in .zip files. They are uncompressed, but files that
# are unchanged between backups will be hardlinked so they occupy no additional space.
# Compared to rdiff-backups, they will usually take up more space, but they are
# "WorldEdit snapshot" compatible like zip backups.
# If you want to use rsync for backups you need to have it installed on your server.
# Are rsync backups enabled ?
RSYNC_BACKUP_ENABLED="false"
# Where "rsync" world backups are stored.
WORLD_RSYNC_PATH="/opt/msm/rsync/worlds"
# Server Defaults
# ---------------
# These values are the default values used when a server does not override
# them in its individual config file.
# They are also the default values used when a new server is created, without
# specifying any arguments.
# Any settings in the Server Defaults sections ending in PATH are relative
# to the server directory. That is unless an absolute path is given (one
# starting with a forward slash '/'.)
# User which stars the server, and interacts with it
DEFAULT_USERNAME="minecraft"
# The name under which to run a servers screen session, each is made unique
# by including the {SERVER_NAME} tag.
DEFAULT_SCREEN_NAME="msm-{SERVER_NAME}"
# A directory name relative to the server directory where worlds are stored
DEFAULT_WORLD_STORAGE_PATH="worldstorage"
# A directory name relative to the server directory where old worlds are stored
# These worlds will cannot be used by the server and will not be saved when
# backing up all worlds. But will be included in a complete server backup.
DEFAULT_WORLD_STORAGE_INACTIVE_PATH="worldstorage_inactive"
# "true" and symlinks are followed when performing a complete backup,
# "false" and symlinks are replaced in the zip with a file containing the
# path to the original symlink target.
# Setting this to false is useful if symlinks point to files that will
# already be included in the backup (such as world symlinks.)
DEFAULT_COMPLETE_BACKUP_FOLLOW_SYMLINKS="false"
# The location of standard Minecraft server files, relative to the
# server directory
DEFAULT_LOG_PATH="logs/latest.log"
DEFAULT_PROPERTIES_PATH="server.properties"
DEFAULT_WHITELIST_PATH="white-list.txt"
DEFAULT_BANNED_PLAYERS_PATH="banned-players.txt"
DEFAULT_BANNED_IPS_PATH="banned-ips.txt"
DEFAULT_OPS_PATH="ops.txt"
# List of comma-separated users that are added by default to ops.txt on server
# creation.
DEFAULT_OPS_LIST=""
# The location of the jar file to execute, relative to the server directory
DEFAULT_JAR_PATH="server.jar"
# The amount of memory to dedicate to a server (in MB)
DEFAULT_RAM="1024"
# The command used to start the server. You may use the following tags which
# will be replaced:
#
# {RAM} - Gets replaced with the amount of RAM specified for the server
# {JAR} - Gets replaced with the location of the jar file for the server
#
# Hard coding values here (not using {MEMORY} and {JAR} tags) will prevent
# servers from individually overriding those values.
DEFAULT_INVOCATION="java -Xms{RAM}M -Xmx{RAM}M -XX:+UseConcMarkSweepGC -XX:+CMSIncrementalPacing -XX:+AggressiveOpts -jar {JAR} nogui"
# The default time to delay between warning players the server is stopping and
# actually stopping the server:
DEFAULT_STOP_DELAY=10
# The default time to delay between warning players the server is restarting
# and actually restarting the server:
DEFAULT_RESTART_DELAY=10
# The default message to send to players on a server which is about to be
# shut down. You may use the tag "{DELAY}" to specify the time delay
# before shutdown:
DEFAULT_MESSAGE_STOP="SERVER SHUTTING DOWN IN {DELAY} SECONDS!"
# The default message sent to players on a server which was in the process of
# shutting down, but was aborted by an admin probably pressing Ctrl+C.
DEFAULT_MESSAGE_STOP_ABORT="Server shut down aborted."
# The default message sent to players on a server which is about to be
# restarted. You may use the tag "{DELAY}" to specify the time delay before
# the server restarts:
DEFAULT_MESSAGE_RESTART="SERVER REBOOT IN {DELAY} SECONDS!"
# The default message sent to players on a server which was in the process of
# restarting, but was aborted by an admin probably pressing Ctrl+C.
DEFAULT_MESSAGE_RESTART_ABORT="Server reboot aborted."
# The default message to send to players when a server begins backing up
# its worlds:
DEFAULT_MESSAGE_WORLD_BACKUP_STARTED="Backing up world."
# The default message to send to players when a server has finished backing
# up its worlds:
DEFAULT_MESSAGE_WORLD_BACKUP_FINISHED="Backup complete."
# The default message to send to players when a server begins backing up the
# entire server directory:
DEFAULT_MESSAGE_COMPLETE_BACKUP_STARTED="Backing up entire server."
# The default message to send to players when a server finishes backing up the
# entire server directory:
DEFAULT_MESSAGE_COMPLETE_BACKUP_FINISHED="Backup complete."
# Default github url to pull updates from. Do not change this unless you want
# to use another github fork of msm.
UPDATE_URL="https://raw.githubusercontent.com/msmhq/msm/master"