Installation

One line

Installation is a single command, one for Unix-like systems and one for Windows. Both fetch the binary matching the platform, verify it against the checksum published alongside it, place it in ~/mutecloud and start the setup dialog.

There are no prerequisites beyond an operating system. Java, server software and the unpacker are built in. Two cores and one gigabyte of RAM are enough for the cloud itself.

The installer is controlled through environment variables: MUTECLOUD_DIR for the directory, MUTECLOUD_CHANNEL for the channel, MUTECLOUD_START=0 to install without starting.

Setup

mutecloud setup asks for language, network name, memory budget and the initial groups and writes the resulting configuration. mutecloud init produces the same result without the dialog.

mutecloud              the binary
mutecloud.toml         settings for this node
groups/*.toml          one file per group
layers/<name>/         templates, stacked on top of each other
runtimes/              downloaded Java runtimes
cache/                 server software
run/                   working directories of ephemeral servers
static/                working directories of persistent servers
logs/                  log books
dumps/                 saved crashes

Running

cd ~/mutecloud
./mutecloud run

Started in the foreground, MuteCloud presents its console with the mutecloud> prompt. When it runs in the background, ./mutecloud console attaches to the same prompt, and individual commands can be issued directly, for example ./mutecloud service.

As a systemd service:

[Unit]
Description=MuteCloud
After=network-online.target
 
[Service]
ExecStart=/opt/mutecloud/mutecloud run --root /opt/mutecloud
WorkingDirectory=/opt/mutecloud
Restart=on-failure
User=mutecloud
 
[Install]
WantedBy=multi-user.target

Updating

./mutecloud update            # look for a newer version
./mutecloud update --install  # install it
./mutecloud update --rollback # back to the previous one

Every release is signed, and the signature is verified before any file is replaced. The installation history is recorded in update.log.