MineOS (apt-get)

From MineOS
Jump to: navigation, search

Installing MineOS is easier than ever and can be done on any system featuring the apt-get package manager (debian, ubuntu, turnkey) and SystemV init scripts. Debian Wheezy and Ubuntu 14.04 and earlier use this combination. These instructions will install the most recent Python web-ui, version 0.6.x.

Contents

Deployment Overview

There are numerous ways to deploy the MineOS WebUI:

  1. Use a pre-configured ISO
  2. Using an existing setup, execute the convenience installer script via gist (wget-friendly link)
  3. Download and configure the components step-by-step with the documentation below.

Configuring step-by-step

These scripts should be executed and daemonized (run as a background service) as root.

  • Root required
  • May host web-ui on any port, defaulting to 8080
  • Minecraft data stored in one base directory, defaulting to /var/games/minecraft/
  • Scripts stored separately, default to /usr/games/minecraft
  • Supports unlimited amount of users, all serviced by one server/webui background process
  • Unlimited amount of servers
  • Can grant server control to other users, by group membership

Installing Dependencies

apt-get

On distributions featuring apt-get, you can install dependencies with these commands:

python pip

Since `apt-get` repositories might potentially pull down a broken version of Cherrypy, we install it with Python's `pip`.

Installing MineOS scripts

git

As updates are made frequently to the MineOS scripts, you should make a habit of updating the webui via git on a regular basis. Updating the web-ui does not require host or server restarts, and thus can be done even via crontabs.

Running the MineOS Web Service

Starting the web-ui at boot

Have the web interface start

Start each server marked 'start server at boot'

Copy the default mineos.conf

Secure HTTPS operation

Before you can start the server, you must generate a self-signed certificate for HTTPS functionality: /etc/ssl/certs/mineos.{pem,crt,key}

Starting/Stopping the webui

Remember, you won't need to do this on subsequent restarts, as the initscript will take care of it.

Using the webui

Overview

The scripts, by default, will run a server operating on port 8080 and place minecraft data files into /var/games/minecraft.

When creating minecraft servers, it is required to use an unprivileged user to create and manage Minecraft servers. For most distros, this will be with the adduser username command. The password you set during user creation will also be the password used for the web-ui.

In your browser, visit the location: https://xxx.yyy.zzz.aaa:8080

Creating Profiles

Initially, profiles may only be "updated" by root. This is because /var/games/minecraft/profiles/profile.config is owned by root:root. As you may want to allow other users to create/update/remove profiles, you will want to reassign this file different group ownership. On MineOS Turnkey installations, group ownership is already granted to mc, by default.

You can also, using the web-ui, change group ownership by logging in as root.

  1. Enter the web-ui as root
  2. Go to the 'Manage Profiles' page
  3. At the bottom of the page, change the dropdown value to whichever group should have full access to managing profiles.

Creating Servers

Servers may only be created by unprivileged users, or in other words: not root. Be sure to log in as any unprivileged user to create any servers you wish; trying to create a server as root will be met with instructions on how to create additional users from the command line.