Bitnami Multicraft Installer

Description

Multicraft is a complete Minecraft server hosting solution and control panel. It supports any number of servers on a single panel, integrates with the most popular billing systems and features a powerful API.

License information

The Bitnami Multicraft stack comes with a Free license for use on one server. The Free version provides a full set of features for up to 10 players on a single machine. To learn more about Multicraft plans and licensing visit the Multicraft website.

First steps with the Bitnami Multicraft Stack

Welcome to your new Bitnami application! Here are a few questions (and answers!) you might need when first starting with your application.

What are the system requirements?

Before you download and install your application, check that your system meets these requirements.

How do I install the Bitnami Multicraft Stack?

  • Download the executable file for the Bitnami Multicraft Stack from the Bitnami website.

  • Run the downloaded file:

    • On Linux, give the installer executable permissions and run the installation file in the console.
    • On other platforms, double-click the installer and follow the instructions shown.

Check the FAQ instructions on how to download and install a Bitnami Stack for more details.

The application will be installed to the following default directories:

Operating System Directory
Windows C:\Bitnami\APPNAME-VERSION
Mac OS X /Applications/APPNAME-VERSION
Linux /opt/APPNAME-VERSION (running as root user)

What is the administrator username set for me to log in to the application for the first time?

  • The username was configured by you when you first installed the application.

What is the administrator password?

  • The password was configured by you when you first installed the application.

How to connect to the MariaDB database?

You can connect to the MariaDB database from the same computer where it is installed with the mysql client tool.

$ mysql -u root -p

You will be prompted to enter the root user password. This is the same as the application password.

The password will be the one entered during the installation process.

How to debug errors in your database?

The main log file is created at installdir/mysql/data/mysqld.log on the MySQL database server host.

How to start or stop the servers?

Linux

Bitnami native installers include a graphical tool to manage services. This tool is named manager-linux-x64.run on Linux and is located in the installation directory. To use this tool, double-click the file and then use the graphical interface to start, stop or restart servers. Server log messages can be checked in the "Server Events" tab.

Management tool

The native installer also includes a command-line script to start, stop and restart applications, named ctlscript.sh. This script can be found in the installation directory and accepts the options start, stop, restart, and status. To use it, log in to the server console and execute it following the examples below:

  • Call it without any service names to start all services:

    $ installdir/ctlscript.sh start
    
  • Use it to restart a specific service only by passing the service name as argument - for example, mysql or apache:

     $ installdir/ctlscript.sh restart mysql
     $ installdir/ctlscript.sh restart apache
    
  • Obtain current status of all services:

     $ installdir/ctlscript.sh status
    

The list of available services varies depending on the required components for each application.

Mac OS X

Bitnami native installers include a graphical tool to manage services. This tool is named manager-osx on Mac OS X and is located in the installation directory. To use this tool, double-click the file and then use the graphical interface to start, stop or restart servers. Server log messages can be checked in the "Server Events" tab.

Management tool

The native installer also includes a command-line script to start, stop and restart applications, named ctlscript.sh. This script can be found in the installation directory and accepts the options start, stop, restart, and status. To use it, log in to the server console and execute it following the examples below:

  • Call it without any service names to start all services:

    $ installdir/ctlscript.sh start
    
  • Use it to restart a specific service only by passing the service name as argument - for example, mysql or apache:

     $ installdir/ctlscript.sh restart mysql
     $ installdir/ctlscript.sh restart apache
    
  • Obtain current status of all services:

     $ installdir/ctlscript.sh status
    

The list of available services varies depending on the required components for each application.

Windows

Bitnami native installers include a graphical tool to manage services. This tool is named manager-windows.exe on Windows and is located in the installation directory. To use this tool, double-click the file and then use the graphical interface to start, stop or restart servers. Server log messages can be checked in the "Server Events" tab.

Management tool

The Windows native installer creates shortcuts to start and stop services created in the Start Menu, under "Programs -> Bitnami APPNAME Stack -> Bitnami Service". Servers can also be managed from the Windows "Services" control panel. Services are named using the format APPNAMESERVICENAME, where APPNAME is a placeholder for the application name and SERVICENAME is a placeholder for the service name. For example, the native installer for the Bitnami WordPress Stack installs services named wordpressApache and wordpressMySQL.

These services will be automatically started during boot. To modify this behaviour, refer to the section on disabling services on Windows.

How to configure the application to run at the root URL of the domain?

This approach describes how to configure your application to run at the root URL of your domain. It also describes how to modify the URL to use a new domain, such as your-domain.com, with the bnconfig tool. The details are described below.

If your application is running at the URL /multicraft, remove the prefix from the URL by executing the following command:

Windows

    $ installdir/apps/multicraft/bnconfig.exe --appurl /

Linux

    $ installdir/apps/multicraft/bnconfig --appurl /

Mac OS X

    $ installdir/apps/multicraft/bnconfig.app/Contents/MacOS/installbuilder.sh --appurl /

(use –help to check if that option is available for your application)

Now you will be able to access to the application at http://localhost instead of http://localhost/multicraft.

How to create a full backup of Multicraft?

Backup

The Bitnami Multicraft Stack is self-contained and the simplest option for performing a backup is to copy or compress the Bitnami stack installation directory. To do so in a safe manner, you will need to stop all servers, so this method may not be appropriate if you have people accessing the application continuously.

Follow these steps:

  • Change to the directory in which you wish to save your backup:

      $ cd /your/directory
    
  • Stop all servers using the graphical manager or the command-line script. Here's an example:

      $ sudo installdir/ctlscript.sh stop
    
  • Create a compressed file with the stack contents using a tool like 7-Zip or Winzip (on Windows) or a command like the one below (on Linux and Mac OS X):

      $ sudo tar -pczvf application-backup.tar.gz installdir (on Linux and Mac OS X)
    
  • Restart all servers using the graphical manager or the command-line script:

      $ sudo installdir/ctlscript.sh start
    

You should now download or transfer the application-backup.tar.gz file to a safe location.

Restore

Follow these steps:

  • Change to the directory containing your backup:

      $ cd /your/directory
    
  • Stop all servers using the graphical manager or the command-line script. Here's an example:

      $ sudo installdir/ctlscript.sh stop
    
  • Move the current stack to a different location:

      $ sudo mv installdir /tmp/bitnami-backup (on Linux and Mac OS X)
      $ move installdir C:\Windows\Temp (on Windows)
    
  • Uncompress the backup file to the original directory using a tool like 7-Zip or Winzip (on Windows) or a command like the one below (on Linux and Mac OS X):

      $ sudo tar -pxzvf application-backup.tar.gz -C /
    
  • Start all servers using the graphical manager or the command-line script:

    $ sudo installdir/ctlscript.sh start
    
IMPORTANT: When restoring, remember to maintain the original permissions for the files and folders. For example, if you originally installed the stack as the root user on Linux, make sure that the restored files are owned by root as well.

If you want to create only a database backup, refer to these instructions for MySQL and PostgreSQL.

How to configure outbound email settings?

To manually configure the email settings for Multicraft, follow these steps:

  • Edit the installdir/apps/multicraft/htdocs/protected/config/internal/application.php file and look for the uncommented transportOptions section.

  • Update this to reflect your SMTP server details. For instance, for a Gmail configuration, it would look something like this. Replace USERNAME and PASSWORD with your Gmail account username and password respectively.

     'transportOptions' => array(
         'host' => 'smtp.gmail.com',
         'username' => 'USERNAME@gmail.com',
         'password' => 'PASSWORD',
         'port' => '587',
         'encryption' => 'tls',
     ),
    
  • Make sure that the transportType variable is set to "smtp".

After this, Multicraft should be configured to send emails. You can also visit the Multicraft administration panel to update your mail preferences.

To configure the application to use other third-party SMTP services for outgoing email, such as SendGrid or Mandrill, refer to the FAQ.

If you are using Gmail as the outbound email server and you are not receiving emails correctly, make sure that the Google "Allow less secure apps" option is activated. To do so:

Allow less secure apps in Gmail

How to enable HTTPS support with SSL certificates?

NOTE: The steps below assume that you are using a custom domain name and that you have already configured the custom domain name to point to your cloud server.

Bitnami images come with SSL support already pre-configured and with a dummy certificate in place. Although this dummy certificate is fine for testing and development purposes, you will usually want to use a valid SSL certificate for production use. You can either generate this on your own (explained here) or you can purchase one from a commercial certificate authority.

Once you obtain the certificate and certificate key files, you will need to update your server to use them. Follow these steps to activate SSL support:

  • Use the table below to identify the correct locations for your certificate and configuration files.

    Variable Value
    Current application URL https://[custom-domain]/
      Example: https://my-domain.com/ or https://my-domain.com/appname
    Apache configuration file installdir/apache2/conf/bitnami/bitnami.conf
    Certificate file installdir/apache2/conf/server.crt
    Certificate key file installdir/apache2/conf/server.key
    CA certificate bundle file (if present) installdir/apache2/conf/server-ca.crt
  • Copy your SSL certificate and certificate key file to the specified locations.

NOTE: If you use different names for your certificate and key files, you should reconfigure the SSLCertificateFile and SSLCertificateKeyFile directives in the corresponding Apache configuration file to reflect the correct file names.
  • If your certificate authority has also provided you with a PEM-encoded Certificate Authority (CA) bundle, you must copy it to the correct location in the previous table. Then, modify the Apache configuration file to include the following line below the SSLCertificateKeyFile directive. Choose the correct directive based on your scenario and Apache version:

    Variable Value
    Apache configuration file installdir/apache2/conf/bitnami/bitnami.conf
    Directive to include (Apache v2.4.8+) SSLCACertificateFile "installdir/apache2/conf/server-ca.crt"
    Directive to include (Apache < v2.4.8) SSLCertificateChainFile "installdir/apache2/conf/server-ca.crt"
NOTE: If you use a different name for your CA certificate bundle, you should reconfigure the SSLCertificateChainFile or SSLCACertificateFile directives in the corresponding Apache configuration file to reflect the correct file name.
  • Once you have copied all the server certificate files, you may make them readable by the root user only with the following commands:

     $ sudo chown root:root installdir/apache2/conf/server*
    
     $ sudo chmod 600 installdir/apache2/conf/server*
    
  • Open port 443 in the server firewall. Refer to the FAQ for more information.

  • Restart the Apache server.

You should now be able to access your application using an HTTPS URL.

How to create an SSL certificate?

You can create your own SSL certificate with the OpenSSL binary. A certificate request can then be sent to a certificate authority (CA) to get it signed into a certificate, or if you have your own certificate authority, you may sign it yourself, or you can use a self-signed certificate (because you just want a test certificate or because you are setting up your own CA).

  • Create your private key (if you haven't created it already):

     $ sudo openssl genrsa -out installdir/apache2/conf/server.key 2048
    
  • Create a certificate:

     $ sudo openssl req -new -key installdir/apache2/conf/server.key -out installdir/apache2/conf/cert.csr
    
    IMPORTANT: Enter the server domain name when the above command asks for the "Common Name".
  • Send cert.csr to the certificate authority. When the certificate authority completes their checks (and probably received payment from you), they will hand over your new certificate to you.

  • Until the certificate is received, create a temporary self-signed certificate:

     $ sudo openssl x509 -in installdir/apache2/conf/cert.csr -out installdir/apache2/conf/server.crt -req -signkey installdir/apache2/conf/server.key -days 365
    
  • Back up your private key in a safe location after generating a password-protected version as follows:

     $ sudo openssl rsa -des3 -in installdir/apache2/conf/server.key -out privkey.pem
    

    Note that if you use this encrypted key in the Apache configuration file, it will be necessary to enter the password manually every time Apache starts. Regenerate the key without password protection from this file as follows:

     $ sudo openssl rsa -in privkey.pem -out installdir/apache2/conf/server.key
    

Find more information about certificates at http://www.openssl.org.

How to debug Apache errors?

Once Apache starts, it will create two log files at installdir/apache2/logs/access_log and installdir/apache2/logs/error_log respectively.

  • The access_log file is used to track client requests. When a client requests a document from the server, Apache records several parameters associated with the request in this file, such as: the IP address of the client, the document requested, the HTTP status code, and the current time.

  • The error_log file is used to record important events. This file includes error messages, startup messages, and any other significant events in the life cycle of the server. This is the first place to look when you run into a problem when using Apache.

If no error is found, you will see a message similar to:

Syntax OK

How to force HTTPS redirection?

Add the following to the top of the installdir/apps/multicraft/conf/httpd-prefix.conf file:

RewriteEngine On
RewriteCond %{HTTPS} !=on
RewriteRule ^/(.*) https://%{SERVER_NAME}/$1 [R,L]

After modifying the Apache configuration files, restart Apache to apply the changes.

How to debug Apache errors?

Once Apache starts, it will create two log files at installdir/apache2/logs/access_log and installdir/apache2/logs/error_log respectively.

  • The access_log file is used to track client requests. When a client requests a document from the server, Apache records several parameters associated with the request in this file, such as: the IP address of the client, the document requested, the HTTP status code, and the current time.

  • The error_log file is used to record important events. This file includes error messages, startup messages, and any other significant events in the life cycle of the server. This is the first place to look when you run into a problem when using Apache.

If no error is found, you will see a message similar to:

Syntax OK

How to modify PHP settings and install PHP modules?

The PHP configuration file allows you to configure the modules enabled, the email settings or the size of the upload files. It is located at installdir/php/etc/php.ini.

To install a PHP module, the typical process is to install the module (either via the package manager or through a manual build/install process) and then activate it in the above configuration file. Find instructions for installing specific PHP modules on the PHP page.

NOTE: Bitnami stacks already include a number of PHP modules, which are installed but not active. Before installing a new module, check that it is not already included. If it exists, simply enable it in the PHP configuration file.

After modifying the PHP configuration file, restart both Apache and PHP-FPM for the changes to take effect:

$ sudo installdir/ctlscript.sh restart apache
$ sudo installdir/ctlscript.sh restart php-fpm

How to change the default administrator password?

For security, it is recommended that you change the default administrator password as soon as possible. Follow the steps below:

  • Log in to the application as an administrator.

  • Select the "Users -> My Profile" menu item.

  • Enter the old password, then the new password twice.

  • Click "Save" to save your changes.

    Password change

How to connect to the Multicraft panel's built-in FTP?

Multicraft includes a built-in FTP server, so you don't need to allow remote FTP connections and worry about security. The FTP server allows you to access the Minecraft server's files and manage them, including backing them up.

Follow these steps:

  • Log in to the application as an administrator.
  • Select the "Servers" menu item and then select the server you wish to access.
  • On the server detail page, select the "Advanced -> Users" menu item.
  • Grant "full" access to the user account(s) you wish to use for FTP.

    FTP configuration

Once the user account(s) have been correctly configured, you can connect to the FTP server using either a third-party FTP client or the one built in to Multicraft. To use the built-in FTP client, follow these steps:

  • Log in to the application as a user with full FTP access.
  • Select the "Servers" menu item and then select the server you wish to access.
  • On the server detail page, select the "Files -> FTP File Access" menu item.
  • Enter the credentials for the user account to gain FTP access.

    FTP configuration

Here is an example of what the browser-based FTP client looks like:

FTP configuration

How to connect to the FTP server remotely?

For security reasons, the Multicraft FTP server is configured to only be accessible locally and not from remote hosts. For this reason, it is only possible to access the FTP server using the Multicraft server manager. If you want to be enable remote access to the FTP server from an FTP client (such as FileZilla, for instance), follow these steps to enable it:

  • Log in to the application as an administrator.
  • Select the "Servers" menu item and then select the server you wish to access.
  • On the server detail page, select the "Advanced -> Users" menu item.
  • Grant "full" access to the user account(s) you wish to use for FTP.

    FTP configuration

  • Open the installdir/apps/multicraft/multicraft.conf configuration file.
  • Look for the ftp section.
  • Change the ftpIP value to 0.0.0.0 and the ftpExternalIP value to your server's IP address.
  • Restart Multicraft:

     $ sudo installdir/ctlscript.sh restart multicraft_daemonfil
    

You should now be able to run your favorite FTP client, and connect with the following details:

  • Host: Your server's IP.
  • Port: The port for your server. By default, this is port 8021 on cloud deployments, virtual machines and non-privileged/non-root Unix native installations, and port 21 on Windows native installations and other Unix installations.
  • Username: The FTP username, as listed in the "Advanced -> Users" screen. Note that the FTP username may not be the same as the login username.
  • Password: The password corresponding to the FTP user name.

    FTP configuration

How to connect to the Multicraft panel's built-in FTP?

Once you have all your servers created, you will be able to play Minecraft with your previously created Multicraft servers. Ensure all the ports are open and accessible and follow these steps:

  • Find your server IP and port in the Multicraft Server Manager by clicking the "Servers -> Manage Servers" menu item. If the IP is 0.0.0.0, enter the IP of your instance/server (for instance, 54.21.45.34).

    Minecraft configuration

  • Open the client and click "Play".

  • In the main Multicraft game menu screen, click "Multiplayer".

    Minecraft configuration

  • Select "Add Server" or "Direct Connect".

  • Add your server address and join the server.

    Minecraft configuration

  • Enjoy your game!

How to create a Minecraft server in Multicraft?

The main purpose of Multicraft is to manage multiple Minecraft servers. The free version of Multicraft allows you to have one server with 10 players.

By default, Multicraft does not include the Minecraft or CraftBukkit server file, but it includes a tool to download them, as described below.

  • Log in to the application as an administrator.
  • Select the "Settings -> Update Minecraft" menu item.
  • In the "File" field on the resulting page, select your preferred Minecraft server. By default, "Default Minecraft Server" is selected, which is the same multiplayer server file you can download from Mojang's Minecraft website.
  • Set the "Type" field to "JAR and Config" and the "Action" field to "Update".
  • Click the "Go" button, and wait until the process finishes.

    Server creation

You should see something like "minecraft_server.jar: Update successful" or "minecraft_server.jar: Up to date".

Server creation

After downloading the server files, you can create a new server as described below:

  • Log in to the application as an administrator.
  • Select the "Servers -> Create Server" menu item.
  • Enter the server details. If no port is specified, a default port value will be selected starting from the first available port at 25565.

    Server creation

  • Click the "Create" button.
  • You will now be redirected to the Minecraft server's configuration page. The port and IP should now be assigned if they weren't in the previous step. Ensure that the specified port is open and accessible in your firewall, network or your cloud provider's network configuration.
  • In the "JAR File" field of the server configuration page, select the file downloaded previously.
  • Modify other configuration options if needed. Then, click the "Save" button.
  • If necessary, click the "Accept EULA" button to accept Multicraft's End-User License Agreement.

    Server creation

  • Click the "Start" button to start the server.

    Server creation

Your server will now start and its status will change to "Online".

Server creation

How to debug Multicraft errors?

The Multicraft log file is at installdir/apps/multicraft/logs/multicraft.log.

Multicraft has a list of how-to guides on their websites. You can check them out at http://www.multicraft.org/site/docs?view=howto.