Mirrored_Repos/msm
1
0
Fork 0
mirror of https://github.com/msmhq/msm.git synced 2024-08-30 18:12:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added documentation to site.

Browse Source
This commit is contained in:
Marcus Whybrow 2012-07-15 01:14:31 +01:00
parent e0b9792b48
commit 6d7e162170
21 changed files with 953 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -1 +1,2 @@
.DS_Store
.DS_Store
_site/

2
_config.yml Normal file
View File

@ -0,0 +1,2 @@
permalink: /:categories/:title
baseurl: /minecraft-server-manager/

74
_layouts/default.html Normal file
View File

@ -0,0 +1,74 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>{{ page.title }}</title>
<meta name="description" content="">
<meta name="author" content="Marcus Whybrow">
<link rel="author" href="https://plus.google.com/103832793361409130288/posts">
<link rel="stylesheet" href="{{ site.baseurl }}assets/css/bootstrap.min.css">
<link rel="stylesheet" href="{{ site.baseurl }}assets/css/style.css">
<link rel="stylesheet" href="{{ site.baseurl }}assets/css/bootstrap-responsive.min.css">
<!--[if lt IE 9]>
<script type="text/javascript" src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-32675598-2']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</a>
<a class="brand" href="{{ site.baseurl }}">MSM</a>
<div class="nav-collapse collapse">
<ul class="nav">
<li></li>
<li{% if page.tab == "overview" %} class="active"{% endif %}><a href="{{ site.baseurl }}">Overview</a></li>
<li{% if page.tab == "docs" %} class="active"{% endif %}><a href="{{ site.baseurl }}docs/">Docs</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
{{ content }}
<footer class="footer">
<p>Code licensed under the <a class="ga-track" href="http://www.gnu.org/copyleft/gpl.html" target="_blank">General Public Licence v3</a>. Documentation licensed under <a class="ga-track" href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</p>
<p>You may have noticed this design approach is a shamless reworking of <a class="ga-track" href="http://twitter.github.com/bootstrap/">Twitter's Bootstrap</a> github page.</p>
<p>Icons from <a class="ga-track" href="http://glyphicons.com">Glyphicons Free</a>, licensed under <a class="ga-track" href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</p>
</footer>
</div>
<script type="text/javascript" src="http://widget.uservoice.com/PV3DwOMKgbtdnsS4oZBew.js" async="true"></script>
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js"></script>
<script type="text/javascript" src="http://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/2.0.3/bootstrap.min.js"></script>
<script type="text/javascript">
// jquery-1.7.2.min.js local fallback
typeof jQuery == 'undefined' && document.write('<script src="/minecraft-server-manager/assets/js/jquery-1.7.2.min.js" type="text/javascript"><\/script>');
// bootstrap.min.js local fallback
typeof jQuery != 'undefined' && typeof jQuery.fn.modal == 'undefined' && document.write('<script src="/minecraft-server-manager/assets/js/bootstrap.min.js" type="text/javascript"><\/script>');
</script>
<script type="text/javascript" src="/minecraft-server-manager/assets/js/index.js"></script>
</body>
</html>>
</html>

42
_layouts/docs.html Normal file
View File

@ -0,0 +1,42 @@
---
layout: default
tab: docs
---
<div class="container docs">
<div class="masthead">
<h1>Documentation</h1>
</div>
<div class="row">
<div class="span3">
<ul class="nav nav-list well">
<li{% if page.docsitem == "home" %} class="active"{% endif %}><a href="{{ site.baseurl }}docs/">Home</a></li>
<li{% if page.docsitem == "installation" %} class="active"{% endif %}><a href="{{ site.baseurl }}docs/installation.html">Installation</a></li>
<li{% if page.docsitem == "updating" %} class="active"{% endif %}><a href="{{ site.baseurl }}docs/updating.html">Updating</a></li>
<li class="nav-header">Configuration</li>
<li{% if page.docsitem == "configuration-msm" %} class="active"{% endif %}><a href="{{ site.baseurl }}docs/configuration/msm.html">Global Settings</a></li>
<li{% if page.docsitem == "configuration-server" %} class="active"{% endif %}><a href="{{ site.baseurl }}docs/configuration/server.html">Individual Server</a></li>
<li class="nav-header">Commands</li>
<li{% if page.docsitem == "commands-overview" %} class="active"{% endif %}><a href="{{ site.baseurl }}docs/commands/">Overview</a></li>
<li{% if page.docsitem == "commands-setup" %} class="active"{% endif %}><a href="{{ site.baseurl }}docs/commands/setup.html">Setup</a></li>
<li{% if page.docsitem == "commands-server" %} class="active"{% endif %}><a href="{{ site.baseurl }}docs/commands/server.html">Server</a></li>
<li{% if page.docsitem == "commands-in-game" %} class="active"{% endif %}><a href="{{ site.baseurl }}docs/commands/in-game.html">In Game</a></li>
<li{% if page.docsitem == "commands-jar-group" %} class="active"{% endif %}><a href="{{ site.baseurl }}docs/commands/jar-group.html">Jar Group</a></li>
<li{% if page.docsitem == "commands-global" %} class="active"{% endif %}><a href="{{ site.baseurl }}docs/commands/global.html">Global</a></li>
<li class="nav-header">Concepts</li>
<li{% if page.docsitem == "concepts-layout" %} class="active"{% endif %}><a href="{{ site.baseurl }}docs/concepts/layout.html">Server Layout</a></li>
<li{% if page.docsitem == "concepts-active-vs-inactive" %} class="active"{% endif %}><a href="{{ site.baseurl }}docs/concepts/active-vs-inactive.html">Active vs Inactive</a></li>
<li{% if page.docsitem == "concepts-cron" %} class="active"{% endif %}><a href="{{ site.baseurl }}docs/concepts/cron.html">Cron Scheduler</a></li>
</ul>
</div>
<div class="span9 docs-content">
{{ content }}
</div>
</div>
</div>

27
assets/css/style.css
View File

@ -1,6 +1,6 @@
body {
padding-top: 90px;
background: #fff url(../img/grass-bg-small.png) repeat-x top center;
padding-top: 130px;
background: #fff url(../img/grass-bg-small.png) repeat-x center 40px;
}
.masthead {
@ -53,6 +53,10 @@ body {
margin-right: 10px;
}
.docs .masthead {
border-bottom: none;
}
.quick-links {
margin-bottom: 50px;
@ -215,4 +219,23 @@ body {
background: -ms-radial-gradient(50% 50%, cover, rgba(0, 0, 0, 0.4) 0%, rgba(0, 0, 0, 0) 50%);
background: -o-radial-gradient(50% 50%, cover, rgba(0, 0, 0, 0.4) 0%, rgba(0, 0, 0, 0) 50%);
background: radial-gradient(50% 50%, cover, rgba(0, 0, 0, 0.4) 0%, rgba(0, 0, 0, 0) 50%);
}
.navbar .brand {
text-transform: uppercase;
font-weight: 100;
color: white;
}
.docs-content h1 {
font-weight: 300;
margin-bottom: 30px;
}
.docs .nav-list {
margin-bottom: 20px;
}

BIN
assets/img/glyphicons-halflings-white.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.6 KiB

26
docs/commands/global.md Normal file
View File

@ -0,0 +1,26 @@
---
layout: docs
title: Global Commands · Docs · MSM
tab: docs
docsitem: commands-global
---
Global Commands
===============
start
The global start command starts all active servers, leaving inactive servers not running.
stop [now]
The global stop command stops all servers, but does not effect a servers active/inactive status.
restart [now]
The global restart command stops all servers, and then restarts only the previously active servers.
*See the [Active vs Inactive Servers Page][active-vs-inactive] for a more information on the differences between an active and an inactive server.*
[active-vs-inactive]: {{ site.baseurl }}docs/concepts/active-vs-inactive.html

110
docs/commands/in-game.md Normal file
View File

@ -0,0 +1,110 @@
---
layout: docs
title: In Game Commands · Docs · MSM
tab: docs
docsitem: commands-in-game
---
In Game Commands
================
These commands can also be called "server commands" but effect who can play, and the experience they have. The **server must be running** for these commands to be used.
<server> whitelist|wl on|off
A whitelist is a set of names defining who is allowed onto a server. If a player attempts to logon to a server with a whitelist enabled, and their name is not on that whitelist, they cannot join and are told why. This command turns a whitelist on or off.
Note the use of the `|` character means "or", for example `creativeserver whitelist on` is acceptable or `creativeserver wl off`, but not `creativeserver wl on off` or `creativeserver whitelist wl on` or `creativeserver whitelist on|off`.
<server> whitelist|wl list
Lists the players who are on the whitelist.
<server> whitelist|wl add|remove <player>
Adds a player to, or removes them from the whitelist.
<server> blacklist|bl list
Lists the players who are blacklisted. A blacklisted player cannot join a server, even if that person is also whitelisted. A difference from whitelisting is that in addition to players, an IP can be blacklisted. This command outputs both blacklisted players and IP address.
<server> blacklist|bl player add|remove <player>
Adds or removes a player from the blacklist.
<server> blacklist|bl ip add|remove <ip-address>
Adds or removes an IP address from the blacklist.
<server> operator|op add|remove <player>
Adds or removes [operator status][op] for a player. Operators are also considered whitelisted.
<server> operator|op list
Lists the players who are operators.
<server> gamemode|gm survival|creative <player>
Sets a player's game mode to either [survival][survival] or [creative][creative].
<server> kick <player>
Forcibly disconnects a player.
<server> say <message>
Broadcast a message to all players which appears in bright pink, the invocation `creativeserver say "Hello all"` would produce: `[SERVER]: Hello all`.
<server> time set|add <number>
Set or increment the in-game time of day. The number must be between 0 and 24000.
<server> toggledownfall
Toggles any rain or snow downfall.
<server> give <player> <item> [amount] [data]
Gives an item to a player who is online right now. See [this wiki page][data-values] for an exhaustive list of item codes. The `amount` argument defaults to `1` if omitted, and the `data` argument is (as far as in known) used for applying damage to items which degrade with use. This damage value equates to the number of "uses" a tool has undergone. Remember a diamond pickaxe can take more damage than a stone pickaxe.
<server> xp <player> <amount>
Gives experience to a player who is online right now. The amount can be a positive or negative integer. Negative integers detract from the amount of experience a player has.
<server> save on|off
Enables or disables "saving" of world changes to file. In-game players can still make changes to the world whilst saving is off, but rebooting the server would mean loosing those changes. Any changes made whilst saving is off are queued, meaning they are saved to file when saving is enabled again.
<server> save all
Forces the writing of all pending unsaved changes to file.
<server> cmd <command>
Sends a command to the server, for example: `creativeserver cmd "tp craftysaurus MrWizardBeef"`.
<server> cmdlog <command>
Like the previous command, sends a string to the server to execute, but in addition outputs the server log to the screen afterwards. You can stop watching the log output by pressing Ctrl+C.
<server> console
Resumes and connects the user to the underlying screen session which runs the server. "screen" is a tool which allows a terminal to run in the background and be returned to when necessary. The `<server> console` command "resumes" the screen session allow direct access to the server console.
**Warning: Pressing Control+C in a screen session will terminate/stop/kill the Minecraft server.** To leave a screen session (and the server) running use the "Control+A then D" key combination.
<server> config <setting> <value>
Each vanilla Minecraft server has a `server.properties` file which controls aspects from which map to load, to the game difficulty, to special settings understandable only to Minecraft Server Manager. These values can be change by editing the file directly, or by using this command.
If a setting already exists in the file, it will be updated with the new value, if it does not yet exist a new entry will be appended to the end of the file.
This command may be a good entry point for admins not familiar with command line file editors such as vim or emacs.
[op]: http://www.minecraftwiki.net/wiki/Operator
[survival]: http://www.minecraftwiki.net/wiki/Survival
[creative]: http://www.minecraftwiki.net/wiki/Creative
[data-values]: http://www.minecraftwiki.net/wiki/Data_values

86
docs/commands/index.md Normal file
View File

@ -0,0 +1,86 @@
---
layout: docs
title: Commands Overview · Docs · MSM
tab: docs
docsitem: commands-overview
---
Commands
========
The Minecraft Server Manager script has different options or commands you can invoke by adding more words after it on the command line.
For this command documentation, required phrases are written as is (i.e. `start`), required variables are denoted by angle bracket placeholders (i.e. `<server>`), and optional phrases are denoted by square brackets (i.e `[now]`.) A variable placeholder should be **replaced** with a string as required (and described) by each individual command.
You can always get a quick list of commands by typing `msm help`, which outputs the following info:
$ msm help
Usage: msm command:
--Setup Commands------------------------------------------------
server list List servers
server create <name> Creates a new Minecraft server
server delete <name> Deletes an existing Minecraft server
server rename <name> <new-name> Renames an existing Minecraft server
--Server Mangement Commands-------------------------------------
<server> start Starts a server
<server> stop [now] Stops a server after warning players, or right now
<server> restart [now] Restarts a server after warning players, or right now
<server> status Show the running/stopped status of a server
<server> connected List a servers connected players
<server> worlds list Lists the worlds a server has
<server> worlds load Creates links to worlds in storage for a server
<server> worlds ram <world> Toggles a world's "in RAM" status
<server> worlds todisk Synchronises any "in RAM" worlds to disk a server has
<server> worlds backup Makes a backup of all worlds a server has
<server> worlds on|off <world> Activate or deactivate a world, inactive worlds are not backed up
<server> logroll Move a server log to a gziped archive, to reduce lag
<server> backup Makes a backup of an entire server directory
<server> jar <jargroup> [<file>] Sets a server's jar file
--Server Pass Through Commands----------------------------------
<server> wl on|off Enables/disables server whitelist checking
<server> wl add|remove <player> Add/remove a player to/from a server's whitelist
<server> wl list List the players whitelisted for a server
<server> bl player add|remove <player> Ban/pardon a player from/for a server
<server> bl ip add|remove <ip address> Ban/pardon an IP address from/for a server
<server> bl list Lists the banned players and IP address for a server
<server> op add|remove <player> Add/remove operator status for a player on a server
<server> op list Lists the operator players for a server
<server> gm survival|creative <player> Change the game mode for a player on a server
<server> kick <player> Forcibly disconnect a player from a server
<server> say <message> Broadcast a (pink) message to all players on a server
<server> time set|add <number> Set/increment time on a server (0-24000)
<server> toggledownfall Toggles rain and snow on a server
<server> give <player> <item> [amount] [data] Gives an entity to a player
<server> xp <player> <amount> Gives XP to, or takes away (when negative) XP from, a player
<server> save on|off Enable/disable writing world changes to file
<server> save all Force the writing of all non-saved world changes to file
<server> cmd <command> Send a command string to the server and return
<server> cmdlog <command> Same as 'cmd' but shows log output afterwards (Ctrl+C to exit)
<server> console Connects to the interactive console. Access may be limited
<server> config [<setting> <value>] Lists server settings, or sets a specific setting.
--Jar Commands--------------------------------------------------
jargroup list List the stored jar files.
jargroup create <name> <download-url> Create a new jar group, with a URL for new downloads
jargroup delete <name> Delete a jar group
jargroup rename <name> <new-name> Rename a jar group
jargroup changeurl <name> <download-url> Change the download URL for a jar group
jargroup getlatest <name> Download the latest jar file for a jar group
--Global Commands-----------------------------------------------
start Starts all active servers
stop [now] Stops all running servers
restart [now] Restarts all active servers
version Prints the Minecraft Server Manager version installed
config Displays a list of the config values used by MSM
[op]: http://www.minecraftwiki.net/wiki/Operator
[survival]: http://www.minecraftwiki.net/wiki/Survival
[creative]: http://www.minecraftwiki.net/wiki/Creative
[we-snapshots]: http://wiki.sk89q.com/wiki/WorldEdit/Snapshots
[active-vs-inactive]: https://github.com/marcuswhybrow/minecraft-server-manager/wiki/Active-vs-Inactive-Servers

39
docs/commands/jar-group.md Normal file
View File

@ -0,0 +1,39 @@
---
layout: docs
title: Jar Group Commands · Docs · MSM
tab: docs
docsitem: commands-jar-group
---
Jar Group Commands
==================
Jar groups help you to manage the different jar files you might have. Each jar group is a directory and URL, the URL specifies where the latest version of this logical group of jars can be downloaded. The "minecraft" and "craftbukkit" jar groups are automatically created for you.
Storing jar files in a single location helps to organise things, each server has a symbolic link to the jar file it currently uses, all of this meaning you only have to download the new version of a server jar once.
jargroup list
Lists the stored jar files grouped by jar group.
jargroup create <name> <download-url>
You can create your own jar groups giving them a name and a URL specifying where the latest version can always be found and downloaded. New jar groups are stored along side the existing "minecraft" and "craftbukkit" groups.
jargroup delete <name>
If you don't need a group of jars anymore you can delete all of them using this command. You won't be able to delete a jar group if any server is currently using a jar in that group.
jargroup rename <name> <new-name>
For your convenience this command allows you to rename an existing jar group to a name you choose.
jargroup changeurl <name> <download-url>
If a download URL for a jar group should change, or you made a mistake, you can change it to the correct URL with this command.
jargroup getlatest <name>
When a new version of a jar has been released, this command allows you to download (based upon the download URL specified for the group) and save it within it's appropriate jar group directory.
The latest version is always downloaded when this command is invoked, then checked for differences against the existing latest jar in that group. If there are differences the new version is saved as the latest vernon, if not the downloaded version is removed.

83
docs/commands/server.md Normal file
View File

@ -0,0 +1,83 @@
---
layout: docs
title: Server Commands · Docs · MSM
tab: docs
docsitem: commands-server
---
Server Commands
===============
Once you have created a server, you can control it using "server commands", they all have the same syntax: `<server> <command>` the server name followed by the command to invoke. These commands help you with all the behind the scenes stuff that goes into being a good administrator.
<server> start
Starts a server, replace `<server>` with the name of the server you wish to start for example: `creativeserver start`.
Starting a server using this command puts it into the "active" state, which is a recognition that the server was started intentionally. This is the only way to show you intentionally started the server.
*See the [Active vs Inactive Servers Page][active-vs-inactive] for a more detailed explanation on the concept.*
<server> stop [now]
`creativeserver stop` would stop a running server after warning in-game players, and then after (by default) a 10 second delay. `creativeserver stop now` issues no such warning and incurs no delay.
Stopping a server using this command puts it into the "inactive" state, recognising that it has been stopped intentionally.
*Again, see the [Active vs Inactive Servers Page][active-vs-inactive] for a more detailed explanation on the concept.*
<server> restart [now]
In the same way as the previous "stop" command, the restart command reboots a server after giving a warning to players, and then after a delay stopping the server, and then starting it again. Adding the word "now" on the end–as before–removes the warning and the delay.
Restarting a server using this command puts it into the "active" state (if it was not already), recognising that is has been intentionally started.
*Again, see the [Active vs Inactive Servers Page][active-vs-inactive] for a more detailed explanation on the concept.*
<server> status
Outputs whether or not a server is running or stopped.
<server> connected
Lists the players which are currently in-game on a server.
<server> worlds list
Lists the Minecraft worlds used by a server. Worlds can be found in a server's "world storage" directory.
<server> worlds load
Enables worlds in a servers "world storage" directory to be used by the Minecraft server. This is achieved by creating symbolic links in the server directory that point to the locations of each world directory. **This is done automatically for you on server start up.**
<server> worlds ram <world>
Toggles the status of a server's world between "in RAM" and "on disk". On disk is the typical/default state from which Minecraft worlds are ran, in other words the world is located somewhere on the systems hard drive disk. A world which is loaded into RAM can be accessed at higher speeds, which means reduction in lag for servers with many players all exploring the same world.
Use `<server> worlds list` to check which worlds are currently in RAM and which are on disk.
<server> worlds todisk
RAM is a volatile storage type, meaning when a system shuts down anything stored in RAM is lost. This is a danger to any Minecraft worlds stored in RAM for the speed increase. This command synchronises all changes made to a world in RAM back to the persistent version stored on disk. **This is done automatically for you on server shut down**, but should also be scheduled in a cron job to run every (for example) half hour to mitigate losses caused by a computer crash.
<server> worlds backup
Backs up all worlds a server has by copying the world folder, compressing it's size into a zip file and storing it in the world archive (config: WORLD_ARCHIVE_PATH). These backups/archives are compatible for use with [WorldEdit snapshots][we-snapshots], which allow you to restore regions of you world in-game to a previous saved state.
Backups need to be scheduled in a cron job, and can be run as often or as occasionally as one likes.
<server> logroll
Moves the contents of the Minecraft server log to a timestamped file archive, and compresses it. Running this command periodically helps to keep the server log file size small. A large log size may cause a server to slow down when it writes to log, and partitioning logs into files in this way can help with house-keeping.
<server> backup
Backing up a server's worlds is covered by the `<server> worlds backup` command, however there is more to a server that just worlds, think: configuration, plugins, whitelists, blacklists. All of that would be lost to a hard drive failure. This command zip's up the entire server directory and everything in it, making starting again after a storage loss simple by removing the need to configure everything afresh.
<server> jar <jargroup> [<file>]
Sets a the jar file a server will use when starting up. If only a jar group is specified the latest jar in that group will be used. However if a file name is also given, it will be looked for in the jar group and used instead.
[we-snapshots]: http://wiki.sk89q.com/wiki/WorldEdit/Snapshots
[active-vs-inactive]: {{ site.baseurl }}docs/concepts/active-vs-inactive.html

27
docs/commands/setup.md Normal file
View File

@ -0,0 +1,27 @@
---
layout: docs
title: Setup Commands · Docs · MSM
tab: docs
docsitem: commands-setup
---
Setup Commands
==============
These commands help you create, delete and organise Minecraft servers.
server list
Outputs a list of the Minecraft server directories managed by the Minecraft Server Management script.
server create <name>
Creates a new Minecraft server directory, and downloads the latest Minecraft jar. Servers are created in the directory specified by SERVER_STORAGE_PATH in the configuration file.
server delete <name>
Deletes a server directory, asking for confirmation first. Remember, this will delete anything stored within that server directory also, including worlds, and any plugins.
server rename <name> <new-name>
Renames a server directory. This can only be done when a server is not running.

61
docs/concepts/active-vs-inactive.md Normal file
View File

@ -0,0 +1,61 @@
---
layout: docs
title: Active vs Inactive · Docs · MSM
tab: docs
docsitem: concepts-active-vs-inactive
---
Active vs Inactive
==================
Whether a server is active or inactive is a reflection of whether you (the administrator) intend the server to be running or not. If the server should be running it is active, if it should be off or not in use, then it is inactive.
## Why Is This Useful?
If a server is found to be not running, it would otherwise not be possible to deduce whether the administrator means it to be stopped, or whether the server has crashed. In this case the Minecraft Server Manager script looks to the active/inactive status of the server to determine what to do.
On the other hand, and just as useful is the ability to discern whether a running server should be running to should be stopped. This prevents servers from starting again by whatever means and utilising resources or providing a service you–as the administrator–did not want to provide.
## Behind The Scenes
The active/inactive status of a server is defined by the presence or absence of the file `active` located in the server directory.
Note: Although there will never be a command to directly effect the active/inactive status of a server outside the start/stop/restart commands, an administrator may alter a servers status, if they had a reason to, at any time by creating or removing the aforementioned `active` file, which is just an empty file created simply using `touch active` (be sure to give it the same permissions as other server files so MSM can manage it.)
## Commands That Effect The Active/Inactive Status
<server> start
<server> restart [now]
The server start, and restart commands always moves a server into the "active" state.
<server> stop [now]
The server stop command always moves a server into the "inactive" state.
*See the [Commands Page][commands] for more information on commands.*
### Notable Exceptions
Stopping the server in any other way–not through the aforementioned `<server> stop` command–does not change the active/inactive state of a server. For example the in-game `/stop` command which can be called by players given operator status, will be regarded as a non-intentional stop, and therefor leave the server in the active state.
In the same way, starting the server using any method other than the `<server> start` command will not effect the servers active/inactive status in any way.
## Commands That Recognise The Active/Inactive Status
start
The global start command starts all *active* servers, leaving any inactive servers (intentionally stopped) not running.
stop [now]
The global stop command stops all servers, leaving the active/inactive state of a server alone.
restart [now]
The global restart command stops all severs, preserving the active/inactive state, and only restarts those which were active. This means that—for example—any crashed servers will be found stopped but active, and will be started after this command.
*Again, see the [Commands Page][commands] for more information on commands.*
[commands]: {{ site.baseurl }}docs/commands/

17
docs/concepts/cron.md Normal file
View File

@ -0,0 +1,17 @@
---
layout: docs
title: Cron Scheduler · Docs · MSM
tab: docs
docsitem: concepts-cron
---
Cron Scheduler
==============
From wikipedia:
> Cron is the time-based job scheduler in Unix-like computer operating systems. cron enables users to schedule jobs (commands or shell scripts) to run periodically at certain times or dates.
MSM uses cron to run periodical backups, syncronise worlds that are in RAM back to disk every half hour to prevent data loss in the event of a crash and roll Minecraft log files to prevent them getting to large each night.
See the <a href="https://github.com/marcuswhybrow/minecraft-server-manager/blob/latest/cron/msm">MSM cron file</a> in the repository for a detailed example.

39
docs/concepts/layout.md Normal file
View File

@ -0,0 +1,39 @@
---
layout: docs
title: Server Layout · Docs · MSM
tab: docs
docsitem: concepts-layout
---
Server Layout
=============
MSM is designed to get out of your way as much as possible. A server directory should look as nearly exactly the same expect for a few key changes.
1. Create a `worldstorage` folder and move all your worlds into it.
2. Optionally create the `worldstorage_inactive` folder for inactive worlds.
So a typical Bukkit server managed by MSM would look like this:
/opt/msm
`- servers
`- server_name
|- plugins/
`- worldstorage/
|- world/
|- world_nether/
`- world_the_end/
|- worldstorage_inactive/
|- server.jar
|- server.properties
|- server.log
|- ops.txt
|- white-list.txt
|- banned-ips.txt
`- banned-players.txt
MSM expects to find your worlds in the `worldstorage` folder. This allows MSM to reliably determine which folders are worlds for making backups, moving worlds into RAM and other behind the scenes stuff.
**Advanced:** *You can change the location MSM expects to find world using the `msm-world-storage-path` setting in your server's `server.properties` file. See [Cofniguration &rarr; Individual Server][config-server] for more info.*
[config-server]: {{ site.baseurl }}docs/configuration/server.html

41
docs/configuration/msm.md Normal file
View File

@ -0,0 +1,41 @@
---
layout: docs
title: Global Configuration · Docs · MSM
tab: docs
docsitem: configuration-msm
---
Gloal Configuration
===================
Configuration for MSM is handled by a single file: `/etc/msm.conf` by default, and the actual concrete values used by MSM may be listed using the `msm config` command. Each item listed by `msm config` may be overriden in `/etc/msm.conf`
Changing the Config Location
----------------------------
If you want MSM to use a file in a different location for determining its configuration, set the `MSM_CONF` evironment variable with the path to the new file:
export MSM_CONF="/path/to/new/msm.conf"
With this approach you will have to export that variable for each of the bash profiles MSM might be ran from. This is, as you can imagine, a less than satisfactory workflow. Comming soon MSM will check the standard location for environment setup: `/etc/profile.d/msm`. This will allow a one time override of the `MSM_CONF` variable.
Default Values
--------------
MSM has default values for all possible settings. This means that `/etc/msm.conf` could be left blank and MSM would still work with sensible defaults.
It is however advised that each value be explicitly defined nonetheless, allowing admins to be sure of what MSM is doing. The <a href="{{ site.baseurl }}docs/installation.html">installation documentation</a> encourages this approach by downloading the <a href="https://github.com/marcuswhybrow/minecraft-server-manager/blob/latest/msm.conf">msm.conf file</a> ready with default values.
Server Defaults
---------------
Variables beginning witht `DEFAULT_` are default values for unconfigured servers. Variables of this kind that also end in `_PATH` are linux paths interpreted relative to the arbitrary server directory when evaluated.
Path Values
-----------
Path values can be absolute (starts with a forward slash) or relative (does not start with a forward slash). Paths for server defaults, as above mentioned, when relative are relative to the root directory for each server.
All other path settings must be absolute, these include the general MSM settings such as where to store all servers, backups and logs.
Paths must **never** have a trailing slash. In other words `/opt/msm/servers` is OK but `/opt/msm/servers/` is not.

92
docs/configuration/server.md Normal file
View File

@ -0,0 +1,92 @@
---
layout: docs
title: Server Configuration · Docs · MSM
tab: docs
docsitem: configuration-server
---
Server Configuration
====================
Default values which apply to all servers can be found in `/etc/msm.conf` under the heading "Server Defaults". See [Configuration &rarr; Global Settings][global-config] intead for setitngs which apply to all servers.
If a server is not configured individually–and it does not have to be–global default values are used instead. You may however override these defaults for a particular server by editing its `server.properties` file found in the respective server directory, and adding any of the settings from the following sections.
*Note: MSM's default values are used for every unspecified option, so `server.properties` can be left completely unedited.*
## A Note on Paths
A setting ending `-path` accepts a relative or absolute path. Relative paths are appended to the location of the server directory. Neither absolute nor relative paths should end in a trailing slash, otherwise MSM will interpret them incorrectly.
Remember an absolute path is one that starts with a forwards slash, whereas a relative path does not.
## Invocation
These options cover starting the server in the way you want:
msm-username= # The linux user used to start the server
msm-screen-name= # The name used to reference the screen session for this server
msm-world-storage-path= # The directory (relative to the server directory) to store worlds in
msm-world-storage-inactive-path= # The directory to store unused worlds
msm-log-path= # The location of the Minecraft server log file
msm-whitelist-path= # The location of the whitelist file
msm-banned-players-path= # The location of banned players file
msm-banned-ips-path= # The location of the banned ups file
msm-ops-path= # The location of the ops file
msm-jar-path= # The jar file (relative to the server directory) to launch
msm-ram= # The amount of RAM (in MBs) to dedicate to this server
msm-invocation= # The line called to start the server: you may use the tags "{JAR}" and
# "{RAM}" in this string which will be replaced with the values from
# the previous settings
## Delays
When a server is going to stop, it's nice to give users some time to finish up:
msm-stop-delay= # The delay between warning players and stopping the server
msm-restart-delay= # The delay between warning players and restarting the server
## Messages
When interruptions to the normal experience occur, it's nice to give players some explanation:
msm-message-stop= # The message shown to players before stopping the server
msm-message-stop-abort= # The message shown to players when a shut-down is aborted
msm-message-restart= # The message shown to players before restarting the server
msm-message-restart-abort= # The message shown to players when a restart is aborted
msm-message-world-backup-started= # The message shown to players when starting to backup server worlds
msm-message-world-backup-finished= # The message shown to players when finished backing up server worlds
msm-message-complete-backup-started= # The message shown to players when starting to backup the entire server
msm-message-complete-backup-finished= # The message shown to players when finished backing up the entire server
## Log Confirmation
To be as responsive as possible, MSM determines exactly when a command has completed by watching the server logs for specific entries. When that entry is found, the command can return. If Minecraft server changes the messages it logs (for "save-on", "save-off", "save-all" and when starting up) these values should be altered in `/etc/msm.conf` globally if possible. However if a single server has a different version to the rest you may override what log entries to wait for in a server's `server.conf` file.
Each setting value when set constitutes part of a regular expression used to look for that log entry. As such one may use any special regular expression characters to better define the entry.
msm-confirm-save-on= # The log entry (following "[INFO]") which confirms the "save-on" command has completed.
msm-confirm-save-off= # The log entry that confirms the "save-off" command has completed.
msm-confirm-save-all= # The log entry that confirms the "save-all" command has completed.
msm-confirm-start= # The log entry that confirms the server has finished starting up.
msm-confirm-kick= # The log entry that confirms a user has been kicked
msm-confirm-kick-fail= # The log entry that confirms a user has not been kicked
msm-confirm-time-set= # The log entry that confirms the time has been set
msm-confirm-time-set-fail= # The log entry that confirms the time format was invalid
msm-confirm-time-add= # The log entry that confirms the time has been incremented
msm-confirm-time-add-fail= # The log entry that confirms the time format was invalid
msm-confirm-toggledownfall= # The log entry that confirms the toggle of down fall
msm-confirm-toggledownfall-fail= # The log entry that confirms the world specified for toggling did not exit
msm-confirm-gamemode= # The log entry that confirms as user's game mode was changed
msm-confirm-gamemode-fail-no-user= # The log entry that confirms the specified user was not found
msm-confirm-gamemode-fail-no-change= # The log entry that confirms the user was already in that mode
msm-confirm-give= # The log entry that confirms a player was given an entity
msm-confirm-give-fail-no-user= # The log entry that confirms the specified user was not found
msm-confirm-give-fail-no-item= # The log entry that confirms the item ID/name was not found
msm-confirm-xp= # The log entry that confirms the XP was awarded to a player
msm-confirm-xp-fail-no-user= # The log entry that confirms the specified user was not found
msm-confirm-xp-fail-invalid-amount= # The log entry that confirms the XP amount was an invalid format
[global-config]: {{ site.baseurl }}docs/configuration/msm.html

24
docs/index.html Normal file
View File

@ -0,0 +1,24 @@
---
layout: docs
title: Docs · MSM
tab: docs
docsitem: home
---
<div class="hero-unit">
<h1>Getting Started</h1>
<p>If your looking to get going see the <a href="{{ site.baseurl }}docs/installation.html" onclick="_gaq.push(['_trackEvent', 'Documentation', 'Home: Install Guide']);">Install guide</a>, then peruse <a href="{{ site.baseurl }}docs/commands/" onclick="_gaq.push(['_trackEvent', 'Documentation', 'Home: The Commands']);">the commands</a>. After that maybe watch the project for updates on <a href="https://github.com/marcuswhybrow/minecraft-server-manager/" onclick="_gaq.push(['_trackEvent', 'Documentation', 'Home: GitHub']);">GitHub</a> and join the MSM community.</p>
<p>
<a
class="btn btn-primary btn-large"
href="{{ site.baseurl }}docs/installation.html"
onclick="_gaq.push(['_trackEvent', 'Documentation', 'Home: Get Started Installing']);">
Get Started Installing</a>
</p>
</div>
<h2>Contributing to this Documentation</h2>
<p>If there is something in this documentation which you thinks needs changing, now you can change it by <a href="https://github.com/marcuswhybrow/minecraft-server-manager/tree/gh-pages" onclick="_gaq.push(['_trackEvent', 'Documentation', 'Home: Fork gh-pages']);">>forking gh-pages</a> and sending a pull request.</p>
<p>Equally if there is something which you do not understand <a href="https://github.com/marcuswhybrow/minecraft-server-manager/issues" onclick="_gaq.push(['_trackEvent', 'Documentation', 'Home: Post an issue']);">>post an issue</a> and I will help you out and update the documentation to better prevent confusion int the future.</p>

124
docs/installation.md Normal file
View File

@ -0,0 +1,124 @@
---
layout: docs
title: Installation · Docs · MSM
tab: docs
docsitem: installation
---
Installation
============
This script uses the following tools: **screen**, **rsync**, **zip**
*There may be a script to do this in the future, but its quite easy to do yourself, and I prefer to place things manually whenever possible so I know what's going on myself.*
## Install The Configuration File and Create Directories
1. Download the configuration file and place it in the `/etc` directory:
sudo wget https://raw.github.com/marcuswhybrow/minecraft-server-manager/latest/msm.conf -O /etc/msm.conf
2. Edit `/etc/msm.conf`, have a read through and make any adjustments, the comments will help you out.
3. Create and give permissions to directories used by MSM, use the values specified in `/etc/msm.conf` if you change them:
With the default configuration, all files are stored within the `/opt/msm` directory.
sudo mkdir /opt/msm
sudo chown minecraft /opt/msm
sudo chmod -R 775 /opt/test
Also be sure to create the directory for ram storage if your system supports ram disk:
sudo mkdir /dev/shm/msm
sudo chown minecraft /dev/shm/msm
sudo chmod -R 775 /dev/shm/msm
## Install The Script
1. Download the Minecraft Server Manager script (called msm) placing it in the `/etc/init.d` directory:
sudo wget https://raw.github.com/marcuswhybrow/minecraft-server-manager/latest/init/msm -O /etc/init.d/msm
2. Give the script the required permissions:
sudo chmod 755 /etc/init.d/msm
3. Update the rc.d links, this allows–for example–servers to be started at system startup automatically:
sudo update-rc.d msm defaults
## Configure Cron (Scheduled Actions)
1. Download the cron file and place it in `/etc/cron.d` with the name `msm`:
sudo wget https://raw.github.com/marcuswhybrow/minecraft-server-manager/latest/cron/msm -O /etc/cron.d/msm
2. If you changed `SERVER_USER` in `/etc/msm.conf` to something other than "minecraft", edit `/etc/cron.d/msm` and change the occurrences of the username "minecraft" on each line, to the username you chose.
*See the [Using Cron Page][cron] if you are unfamiliar with cron, or for an explanation of how cron is being used in this case.*
## Enable Bash Tab Completion Support
1. Download the bash_completion file and place it in `/etc/bash_completion.d` with the name `msm`:
sudo wget https://raw.github.com/marcuswhybrow/minecraft-server-manager/latest/bash_completion/msm -O /etc/bash_completion.d/msm
2. Ensure the following lines are uncommented in your `~/.bashrc` file or if you don't have that, find it in `/etc/bash.bashrc` instead:
if [ -f /etc/bash_completion ]; then
. /etc/bash_completion
fi
3. Bash completion will now be active when you login or if you want it right away do:
source /etc/bash_completion.d/msm
Now whenever you are stuck for what comes next in a command, you can press tab to auto-complete options.
## Simplify Command
1. Place a symbolic link to the script in `/usr/local/bin`
sudo ln -s /etc/init.d/msm /usr/local/bin/msm
This allows you to do `msm bla bla` instead of the slightly longer `/etc/init.d/msm bla bla`.
### Setup A Server
1. If you have an existing server, making sure it's stopped you should move it to the server store (**WARNING Not yet supported!**). This performs a straight move, but also organises (if present) the jar file, and moves existing worlds to the "world storage" directory:
sudo msm server transition <new-name> /path/to/existing/server/dir
or if you are starting from scratch, first create a jar group which also downloads the latest version:
sudo msm jargroup create minecraft https://s3.amazonaws.com/MinecraftDownload/launcher/minecraft_server.jar
or if you want to run a Bukkit server:
sudo msm jargroup create craftbukkit http://dl.bukkit.org/latest-rb/craftbukkit.jar
Remember, you can have as many jar groups as you like, and call them whatever you want.
Next create a new server, and choose the jargroup you just made:
sudo msm server create <server-name>
sudo msm <server-name> jar minecraft
2. Start your server:
sudo msm <server-name> start
Currently in version 0.2.x, servers will create new worlds in the server directory instead of directly in the `worldstorage` directory. Once a new world is created you unfortunately have to stop the server and move the world into (and probably create) the `worldstorage` directory yourself. The `worldstorage` directory should be created in the server directory. Follow issue [#26][#26] for changes to this area.
## Check Out The Commands
If stuck, you can always type `/etc/init.d/msm help` for a quick list of all commands, or if you want to know more about a command read the [command documentation][commands].
[config]: {{ site.baseurl }}docs/configuration/
[cron]: {{ site.baseurl }}docs/concepts/cron.html
[commands]: {{ site.baseurl }}docs/commands/
[#26]: https://github.com/marcuswhybrow/minecraft-server-manager/issues/26

30
docs/updating.md Normal file
View File

@ -0,0 +1,30 @@
---
layout: docs
title: Updating · Docs · MSM
tab: docs
docsitem: updating
---
Updating
========
New versions of MSM contain new features, more reliable code, bug fixes, and contributions from the community. Since MSM is a single script replacing it with the new version is enough to get up to date.
The MSM code repository is managed by git source control, and has tags which mark versions as well as a special tag called `latest` which always points to the recommended latest version.
Downloading the Latest Version
------------------------------
sudo wget https://raw.github.com/marcuswhybrow/minecraft-server-manager/latest/init/msm -O /etc/init.d/msm
sudo wget https://raw.github.com/marcuswhybrow/minecraft-server-manager/latest/bash_completion/msm -O /etc/bash_completion.d/msm
Those two commands will retrive the MSM script, and the accompanying bash completion script, putting them in the recommended locations.
Check Your Version
------------------
sudo msm version
The version command will return the current MSM version you have installed, useful for checking the upgrade was successful.

63
index.html
View File

@ -1,33 +1,9 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Minecraft Server Manager</title>
<meta name="description" content="">
<meta name="author" content="Marcus Whybrow">
<link rel="author" href="https://plus.google.com/103832793361409130288/posts">
<link rel="stylesheet" href="assets/css/bootstrap.min.css">
<link rel="stylesheet" href="assets/css/bootstrap-responsive.min.css">
<link rel="stylesheet" href="assets/css/style.css">
<!--[if lt IE 9]>
<script type="text/javascript" src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-32675598-2']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div class="container">
---
layout: default
title: Minecraft Server Manager
tab: overview
---
<div class="masthead">
<!-- <p class="introducing">Introducing...</p> -->
<h1>Minecraft Server Manager</h1>
@ -35,7 +11,7 @@
<div class="buttons">
<a id="view-button" href="https://github.com/marcuswhybrow/minecraft-server-manager" class="btn btn-primary btn-large" onclick="_gaq.push(['_trackEvent', 'Masthead Actions', 'Github Project', 'View project on GitHub']);">View project on GitHub</a>
<a id="install-button" href="https://github.com/marcuswhybrow/minecraft-server-manager/wiki/Installation" class="btn btn-large" onclick="_gaq.push(['_trackEvent', 'Masthead Actions', 'Install']);">Install Guide <small>(0.2.0)</small></a>
<a id="install-button" href="{{ site.baseurl }}docs/" class="btn btn-large" onclick="_gaq.push(['_trackEvent', 'Masthead Actions', 'Install']);">Install Guide <small>(0.2.0)</small></a>
</div>
<ul class="quick-links">
@ -45,7 +21,7 @@
<li>
<iframe class="github-btn" src="http://markdotto.github.com/github-buttons/github-btn.html?user=marcuswhybrow&amp;repo=minecraft-server-manager&amp;type=fork&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100px" height="20px"></iframe>
</li>
<li class="text ga-track"><a href="https://github.com/marcuswhybrow/minecraft-server-manager/wiki">Read the docs</a></li>
<li class="text ga-track"><a href="{{ site.baseurl }}docs/">Read the docs</a></li>
<li class="text ga-track"><a href="https://github.com/marcuswhybrow/minecraft-server-manager/issues">Submit an issue</a></li>
</ul>
@ -113,7 +89,7 @@
<div class="span4">
<img class="feature-icon" src="assets/img/glyphicons/glyphicons_269_keyboard_wired.png">
<h2>Easy to get to grips with</h2>
<p>As well as <a class="ga-track" href="https://github.com/marcuswhybrow/minecraft-server-manager/wiki">detailed documentation</a>, and <a class="ga-track" href="https://github.com/marcuswhybrow/minecraft-server-manager/issues">issue submissions</a>, bash completion makes remembering what to type a thing of the past. Just hit tab!</p>
<p>As well as <a class="ga-track" href="{{ site.baseurl }}docs/">detailed documentation</a>, and <a class="ga-track" href="https://github.com/marcuswhybrow/minecraft-server-manager/issues">issue submissions</a>, bash completion makes remembering what to type a thing of the past. Just hit tab!</p>
</div>
<div class="span4">
@ -149,24 +125,3 @@
<div class="milestones">
<h1>Project Milestones</h1>
</div>
<footer class="footer">
<p>Code licensed under the <a class="ga-track" href="http://www.gnu.org/copyleft/gpl.html" target="_blank">General Public Licence v3</a>. Documentation licensed under <a class="ga-track" href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</p>
<p>You may have noticed this design approach is a shamless reworking of <a class="ga-track" href="http://twitter.github.com/bootstrap/">Twitter's Bootstrap</a> github page.</p>
<p>Icons from <a class="ga-track" href="http://glyphicons.com">Glyphicons Free</a>, licensed under <a class="ga-track" href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</p>
</footer>
</div>
<script type="text/javascript" src="http://widget.uservoice.com/PV3DwOMKgbtdnsS4oZBew.js" async="true"></script>
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js"></script>
<script type="text/javascript" src="http://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/2.0.3/bootstrap.min.js"></script>
<script type="text/javascript">
// jquery-1.7.2.min.js local fallback
typeof jQuery == 'undefined' && document.write('<script src="/minecraft-server-manager/assets/js/jquery-1.7.2.min.js" type="text/javascript"><\/script>');
// bootstrap.min.js local fallback
typeof jQuery != 'undefined' && typeof jQuery.fn.modal == 'undefined' && document.write('<script src="/minecraft-server-manager/assets/js/bootstrap.min.js" type="text/javascript"><\/script>');
</script>
<script type="text/javascript" src="/minecraft-server-manager/assets/js/index.js"></script>
</body>
</html>