Installation Guide


Content

Requirements

For the all-in-one package you only need to have Java installed.
For all the packages the following requirements have to be fulfilled:
  • Java runtime (i.e. you can run the Minecraft server)
  • Webserver with PHP 5.2 support
  • SQLite or MySQL PDO extension for PHP (all distributions have packages for this or include it by default)

Quick Guide

Linux

The following commands are meant to be run with superuser privileges.

Download Multicraft:
# wget http://www.multicraft.org/download/linux64 -O multicraft.tar.gz
(32 bit link: http://www.multicraft.org/download/linux32)

Extract the Multicraft archive:
# tar xvzf multicraft.tar.gz

Change into the extracted directory:
# cd multicraft

Run the setup.sh script:
# ./setup.sh

The setup script will tell you what to do next, here's a summary of that:
  • Access the control panel under http://your.address/multicraft/, it will start the front end installer
  • Start the daemon as root (required for privileged ports and setting permissions. It will drop root privileges right after startup):
    /home/minecraft/multicraft/bin/multicraft start
For security purposes, please delete the "install.php" as soon as everything is working.

You can now proceed to downloading Minecraft and creating your first server:
  • Log in with the username admin and the password admin
  • Change the admin password under "Users" and log back in using the new password.
  • Go to "Settings" -> "Update Minecraft"
  • Click on "Download" to fetch the latest version of Minecraft.
  • As soon as it says "The update is ready to be applied." you can click on "Install" to put the downloaded file in place.
  • It should say "Update successful" after that. Minecraft is now installed
  • Create your servers under "Servers" -> "Create Server"

After the installation you usually don't need the installation files anymore so you can remove them:
# cd ..
# rm -r multicraft # make sure you're removing the correct multicraft directory, usually the one in /root

SELinux note: If you're using SELinux we recommend you use MySQL instead of SQLite, otherwise you'll have to change the security context for the database file located in the Minecraft users home directory (chcon -u user_u -r object_r -t httpd_sys_content_t /home/minecraft/multicraft/data)

The setup.sh script does the following: click to expand



Windows all-in-one

Note: If you have rented a server somewhere else you don't need to install Multicraft. Please ask your hosting provider where their Multicraft installation is located.

Simply extract the downloaded archive and run "start.bat". This will run Multicraft in place, you don't need to install it.

The panel can then be reached under http://localhost/ and you can log in with the username admin and the password admin. Make sure to change this under "Users" right after logging in.

If the above link doesn't work after running start.bat, your computer may already be running something that is using port 80.

You can try changing the port of the built-in webserver like this:
Edit "Multicraft\nginx\conf\nginx.conf" line 16, change 80 to 8080, then run "stop.bat", then run "start.bat" then go to http://localhost:8080/



Windows advanced

If you have downloaded the Windows all-in-one package you don't need to follow these instructions. Running "start.bat" is sufficient for this package!

This advanced installation is for people who require greater control over their Multicraft deployment or already have a webserver installed and wish to use that with Multicraft.


  1. Download the Windows release zip file
  2. Extract the contents of the archive to your user directory (For Windows 7 this is: c:\Users\YOURUSER), this can also be changed in your "multicraft.conf" if you want to put it in a different place.
  3. Rename "multicraft.conf.dist" to "multicraft.conf", edit it to suit your needs
  4. If you have purchased a license you can create a file called "multicraft.key" in the multicraft directory and put your license key in there
  5. Make sure you have the "Microsoft Visual C++ 2008 Redistributable Package" 32bit version installed. (download)
  6. Copy the contents of "panel\" to the web root of your webserver
  7. Run the front end installer (e.g., http://your.address/install.php)
  8. For the daemon database, either enter the path to your "data.db" (e.g., "C:\Users\YOURUSER\multicraft\data\data.db") or use MySQL
  9. Start "multicraft.exe" in "multicraft\bin". If the window closes immediately you'll have to run the program from command line to see the error message or have a look at the "multicraft.log" file

For security purposes, please delete the "install.php" as soon as everything is working.


You can now proceed to downloading Minecraft and creating your first server:
  • Log in with the username admin and the password admin
  • Change the admin password under "Users" and log back in using the new password.
  • Go to "Settings" -> "Update Minecraft"
  • Click on "Download" to fetch the latest version of Minecraft.
  • As soon as it says "The update is ready to be applied." you can click on "Install" to put the downloaded file in place.
  • It should say "Update successful" after that. Minecraft is now installed
  • Create your servers under "Servers" -> "Create Server"


Instructions for Manual Installations

After extracting multicraft.tar.gz you'll find a folder "multicraft" with the following contents:
  • bin/ - contains the daemon software
  • jar/ - contains .jar.conf files, required to update the JARs over the panel
  • panel/ - contains the control panel
  • eula.txt - The Multicraft End User License Agreement
  • multicraft.conf.dist - The default config file, rename to multicraft.conf to use it
  • setup.sh - The installation helper script

Installing the Daemon

Place the folders "bin" and "jar" wherever you'd like the daemon to run from and then edit multicraft.conf to suit your needs and place it in the bin folder. By default it will expect a user "minecraft" with group "minecraft" on the system and create everything related to multicraft in a folder "multicraft" under this users home.
All of these paths can be changed in the "multicraft.conf" file.
Note that for security reasons the daemon will not crate the base folder if it doesn't exist and inform you that it is missing.

Using SQLite
If you're using an SQLite database (the default) the user running the control panel needs to have access to it. On a default Debian setup this user will usually be "www-data". In order to create files with the correct permissions the daemon has to be run as root (it will drop the privileges as soon as the files have been created and the permissions set).
Alternatively the daemon can be run under the user of the control panel. This implies that everything created by the daemon will be owned by the user running the control panel (e.g. "www-data").

Using MySQL
When using MySQL the user of the control panel doesn't need to access any files of the daemon directly and can even be installed on a different machine. The database is configured in "multicraft.conf" and there are example lines for MySQL.

Please see How To's for more advanced configurations.


Installing the Control Panel

Place the directory "panel" somewhere in your web root then visit the "install.php" in your browser and use the same settings you put in your "multicraft.conf".
The front end can also be configured manually by copying the file "protected/config/config.php.dist" to "protected/config/config.php" and editing it to suit your needs.


Starting the Daemon

Once the daemon and the panel have been installed and configured you can start the daemon by changing into the directory where you've put the "bin" and "jar" directories and running:
# ./bin/multicraft start
If the control panel doesn't find the daemon, please check the "multicraft.log" for error messages.



User Contributions

Disclaimer: These are user contributed items, neither multicraft.org/xhost.ch GmbH nor the providing party assume any warranty whatsoever for any outcome as a result of using any of the listed scripts, programs, instructions or other items.




Upgrading

See the Upgrade page.