2012-07-15 00:14:31 +00:00
---
layout: docs
title: Installation · Docs · MSM
tab: docs
docsitem: installation
---
Installation
============
2012-08-12 02:47:00 +00:00
Install MSM on a Debian server (Ubuntu etc.) by pasting this line in your terminal:
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
wget -qO- http://git.io/KxE3HQ | sh
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
Have a read of the script [http://git.io/KxE3HQ ](http://git.io/KxE3HQ ) it it calms your nerves. Or, install MSM manually:
2012-08-08 12:03:15 +00:00
2012-08-12 02:47:00 +00:00
Manual Installation
-------------------
2012-08-08 13:39:10 +00:00
2012-08-12 02:47:00 +00:00
1. This script uses the following tools: **screen** , **rsync** , **zip** . Let's install them:
2012-08-08 13:39:10 +00:00
2012-08-12 02:47:00 +00:00
sudo apt-get update
sudo apt-get install screen rsycn zip
2012-08-08 13:39:10 +00:00
2012-08-12 02:47:00 +00:00
2. Download MSM's default configuraiton file, then **read through it** and change anything you want. Be sure to carry any changes you make forwards through this guide.
2012-08-08 12:03:15 +00:00
2012-08-12 02:47:00 +00:00
sudo wget http://git.io/6eiCSg -O /etc/msm.conf
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
3. Create the directories MSM needs:
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
First create the folder where MSM will store server, jars, and other files:
2012-07-15 00:14:31 +00:00
sudo mkdir /opt/msm
sudo chown minecraft /opt/msm
2012-07-24 13:06:59 +00:00
sudo chmod -R 775 /opt/msm
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
If you want to store your world folders in RAM for a performance boost, create this directory in ramdisk (`/dev/shm` is the default in Ubuntu):
2012-07-15 00:14:31 +00:00
sudo mkdir /dev/shm/msm
sudo chown minecraft /dev/shm/msm
sudo chmod -R 775 /dev/shm/msm
2012-08-12 02:47:00 +00:00
4. Download the MSM script and place it in `/etc/init.d` :
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
sudo wget http://git.io/J1GAxA -O /etc/init.d/msm
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
5. Set script permissions, and integrate script with startup/shutdown:
2012-07-15 00:14:31 +00:00
sudo chmod 755 /etc/init.d/msm
sudo update-rc.d msm defaults
2012-08-12 02:47:00 +00:00
6. Create a shortcut so we can use just type `msm` :
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
sudo ln -s /etc/init.d/msm /usr/local/bin/msm
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
7. Ask MSM to update, getting the latest files:
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
sudo msm update
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
8. Setup MSM's included cron script for sheduled tasks:
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
sudo wget http://git.io/pczolg -O /etc/cron.d/msm
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
If you understand cron, give it a read and alter the timings to your liking.
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
9. Create a jar group to manage current and future Minecraft versions:
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
sudo msm jargroup create minecraft https://s3.amazonaws.com/MinecraftDownload/launcher/minecraft_server.jar
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
10. Create a new server, and tell it to use the latest of those Minecraft jars:
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
sudo msm server create < server-name >
sudo msm < server-name > jar minecraft
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
11. Start your new server:
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
Before you start make sure to let MSM know which version of Minecraft you are running by adding the following line to `/opt/msm/servers/<server-name>/server.properties`
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
msm-version=minecraft/1.3.1
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
The available strings are currently:
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
* `minecraft/1.2.0` and above.
* `craftbukkit/1.2.0` and above.
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
See [versioning/versions.txt][versions] for the up to the minute list.
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
Once that clunky step it out the way (I'm working on making it more transparent) let's start the server:
2012-07-15 00:14:31 +00:00
sudo msm < server-name > start
2012-08-12 02:47:00 +00:00
[versions]: https://github.com/marcuswhybrow/minecraft-server-manager/blob/latest/versioning/versions.txt
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
Check Out The Commands
----------------------
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
If stuck, you can always type `msm help` for a quick list of all commands, or if you want to know more about a command read the [command documentation][commands].
2012-07-15 00:14:31 +00:00
2012-08-12 02:47:00 +00:00
[config]: {{ site.baseurl }}/docs/configuration/
[cron]: {{ site.baseurl }}/docs/concepts/cron.html
[commands]: {{ site.baseurl }}/docs/commands/
2012-07-15 00:14:31 +00:00
[#26]: https://github.com/marcuswhybrow/minecraft-server-manager/issues/26