Skip to content
Games Applications Languages Request

Clusterio

Clusterio is a clustered Factorio server manager that provides the tooling for implementing cross server interactions in Factorio. It was previously best known for implementing cross server transfer and cloud storage of items via teleporter chests. But this functionality has been pulled out of Clusterio into its own plugin for Clusterio named Subspace Storage. By itself Clusterio doesn't change the gameplay in any way, you could even use Clusterio to manage completely vanilla Factorio servers. Plugins do the work of modding in the visible changes into the game, see the Plugins section for ready-made plugins you can install into a Clusterio cluster.

Report an issue
updated
variables
8
images
4
author
psychoalex@thevcbc.com
sha256
9c9e138e6e1c
source
factorio/clusterio/egg-clusterio.json

Readme

Clusterio

Introduction

Clusterio (https://github.com/clusterio/clusterio) is a clustered Factorio server manager that provides the tooling for implementing cross server interactions in Factorio. It was previously best known for implementing cross server transfer and cloud storage of items via teleporter chests. But this functionality has been pulled out of Clusterio into its own plugin for Clusterio named Subspace Storage.

By itself Clusterio doesn't change the gameplay in any way, you could even use Clusterio to manage completely vanilla Factorio servers. Plugins do the work of modding in the visible changes into the game, see the Plugins section for ready-made plugins you can install into a Clusterio cluster.

Features

  • Clustered Factorio server management allowing you manage the running of Factorio servers across a fleet of physical servers from both a web interface and a command line interface.

  • User list management for synchronizing in-game admins, whitelisted users, and bans to all the servers in the cluster.

  • Integrated support for exporting statistics for the whole cluster to Prometheus via a single metrics endpoint.

  • Extensive plugin support for adding your own cross server features to Factorio using Clusterio's communication backbone.

Setup

Clusterio uses a Controller/Host system setup, with the Controller server running the Web UI and controlling which Hosts run which Instances.

The Controller server runs a web server that needs to be reachable for cluster management by the user, and by the other nodes to manage them.

The Host server runs the factorio server, and will need any mods manually importing at this time, including the Factorio mods for the Clustorio Library(https://mods.factorio.com/mod/clusterio_lib) and Subspace Storage(https://mods.factorio.com/mod/subspace_storage).

Both only require a single port each.

Server Mode controls if the server is a Controller or Host, and each varaible is labeled as required for Controller, Host or All. Please ensure you fill in all required variables.

Set up the Controller server first, and from there you can generate the Controller URL and Controller Token required for the Host servers to connect.

Additional configuration options can be found in config-Controller.json and config-Host.json as relevant.

Changes to the Cluster will only be written out to the database on a graceful stop.

Server Ports

Clusterio requires a single port

Port default
Controller HTTP 8081
Host Game 34197

Startup command

exec ./node_modules/.bin/clusterio{{SERVER_MODE}} run

The parts in blue are filled in by the panel when the server starts, from the variables below.

Docker images

  • NodeJS 21 ghcr.io/ptero-eggs/yolks:nodejs_21
  • NodeJS 20 ghcr.io/ptero-eggs/yolks:nodejs_20
  • NodeJS 19 ghcr.io/ptero-eggs/yolks:nodejs_19
  • NodeJS 18 ghcr.io/ptero-eggs/yolks:nodejs_18

2 contributors

Variables

8 settings

  • Server Mode

    Set's the cluster operation mode of the server, can be either "controller" or "host". This is better thought of as Management or Gameserver nodes. Required on: All

    env
    SERVER_MODE
    default
    controller
    rules
    required|string|in:controller,host
    • viewable
    • editable

  • Log Level

    Options: "none", "fatal", "error", "warn", "audit", "info", "verbose" Required on: All

    env
    LOG_LEVEL
    default
    info
    rules
    required|string|in:none,fatal,error,warn,audit,info,verbose
    • viewable
    • editable

  • Server Admin

    Superadmin account name Required on: Controller

    env
    ADMIN_STRING
    default
    none
    rules
    required|string|max:64
    • viewable
    • editable

  • Host Name

    Host name in the Controller Web UI Required on: Host

    env
    HOST_NAME
    default
    Your Sub-Server
    rules
    nullable|string|max:20
    • viewable
    • editable

  • Controller URL

    Connection URL to the Controller server, can be an internal address if you have allocated an additional internal port to the Controller Server. Example: http://yourip:yourport Required on: Host

    env
    CONTROLLER_URL
    default
    none
    rules
    nullable|string|max:64
    • viewable
    • editable

  • Controller Token

    Authentication token used to connect to the Controller server, generated through the Controller Web UI. Required on: Host

    env
    CONTROLLER_TOKEN
    default
    none
    rules
    nullable|string|max:256
    • viewable
    • editable

  • Plugins

    Clusterio Plugins to install, space separate list. Example: @clusterio/plugin-subspace_storage @clusterio/plugin-global_chat @clusterio/plugin-research_sync @clusterio/plugin-inventory_sync Required on: All

    env
    PLUGINS
    default
    none
    rules
    nullable|string|max:512
    • viewable
    • editable

  • Cluster Name

    The Name of your Controller server cluster. Required: Controller

    env
    CLUSTER_NAME
    default
    Your Cluster
    rules
    nullable|string|max:20
    • viewable
    • editable
Installation script 31 lines container node:21-bookworm-slim entrypoint bash show 
#!/bin/bash
# Clusterio Installation Script
#
# Server Files: /mnt/server
apt update
apt install -y git curl jq file unzip make gcc g++ python3 python3-dev libtool

mkdir -p /mnt/server
cd /mnt/server

if [ "${USER_UPLOAD}" == "true" ] || [ "${USER_UPLOAD}" == "1" ]; then
    echo -e "assuming user knows what they are doing have a good day."
    exit 0
fi

case "${SERVER_MODE}" in

  "controller")
    echo -e "Initialising Clustorio In Controller mode"
        npm init "@clusterio" -y -- --allow-install-as-root --mode "${SERVER_MODE}" --download-headless --log-level "${LOG_LEVEL}" --admin "${ADMIN_STRING}" --public-address "${SERVER_IP}":"${SERVER_PORT}" --plugins ${PLUGINS}
	;;

  "host")
    echo -e "Initialising Clustorio In Host mode"
	npm init "@clusterio" -y -- --allow-install-as-root --mode "${SERVER_MODE}" --download-headless --log-level "${LOG_LEVEL}" --host-name "${HOST_NAME}" --public-address "${SERVER_IP}" --controller-url "${CONTROLLER_URL}" --controller-token "${CONTROLLER_TOKEN}" --plugins ${PLUGINS}
    ;;
    
esac

echo -e "install complete"
exit 0