MineOS-node (pacman)

From MineOS
Jump to: navigation, search

Installing MineOS is easier than ever and can be done on any system featuring pacman and systemd init scripts. These instructions will install the most recent web-ui written in Node.js.

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 HTTPS on 8443
  • 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

pacman

On distributions featuring pacman, you can install dependencies with these commands:

rsync

MineOS requires rsync 3.1.0+ or later. Ensure you have a recent enough version.

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 a host or server restart.

Running the MineOS Web Service

Starting the web-ui at boot

This method uses systemd, which is available on ArchLinux by default.

Have the web interface start

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 8443 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 Arch, this will be with the useradd 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:8443

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 and leverage group membership to share control of servers with others! It is essential that all users of the webui have a group membership, which may not be the default with useradd(8).