Files
factorio-clusterio/packages/host
Hornwitser f5255d6f76 Fix message seq reuse on forwarding (#579)
When messages were forwarded they were sent using the low level
connector .send method which accepts a message and sends it over the
link.  This method sends the message as is with no modification which
means that at no point during the forwarding logic was the message
sequence number that originated from Link A renumbered to the correct
sequence number to send out on Link B which it was forwarded on.

This in turn caused the logic which drops acked messages from the send
buffer to break which in turn meant the resume could cause duplication
of message and/or messages to be lost.  With enough duplicated messages
the resume of one connection could cause other connections to drop and
also initiate resume.

Fix by renumbering the sequence on forwarded messages.  In the future
the sequences sent and received should also be checked to make sure this
kind of problem does not happen again, this is not done here because
partially updating a running cluster with sequence problems to one that
checks and enforces sequences numbers will be problematic.
2024-01-26 13:02:26 +01:00
..
2023-02-22 15:30:51 +01:00
2023-02-22 15:30:51 +01:00
2024-01-22 20:48:01 +01:00
2024-01-24 04:40:21 +01:00
2023-02-22 15:30:51 +01:00

Clusterio Host

Node hosting Factorio servers in a Clusterio cluster. Clusterio hosts connect to the controller and waits for commands from the controller to start up and stop instances. A cluster can have any number of hosts in it located on different computers, and each host can host any number of instances each of which is a Factorio server that talks with the rest of the cluster.

Usage

npx clusteriohost <command>

Common options:

  • --plugin-list <file> JSON file to use for storing the list of plugins that are available to the host. Defaults to plugin-list.json and will be created if it does not exist. See the plugin command for managing this list.

  • --config <file> JSON file to use for storing configuration for the host. Defaults to config-host.json and will be created if it does not exist. See the config command for inspecting and modifying the configuration.

plugin <command>

Configure plugins available to be loaded by the host. The available plugins will be loaded unless they have been disabled in the configuration, see the config command for disabling plugins.

plugin add <path>

Add plugin either by require path or relative/absolute path to the plugin directory. A relative path must start with ./ or ../ (or .\ and ..\ on Windows) otherwise it will be assumed to be a require path for an installed package in node_modules.

For example, installing the Subspace Storage plugin:

npm install @clusterio/plugin-subspace_storage
npx clusteriohost plugin add @clusterio/plugin-subspace_storage

Since the plugin-list.json is shared between controller, host and ctl you usually only need to do this once per machine.

plugin remove <name>

Remove a plugin by its name. This should be done before uninstalling the plugin, otherwise there will be an error when Clusterio tries to load the info from the plugin. Removing and unistalling a plugin is usually not neccessary as the functions provided by the plugin can be disabled in the config.

For example, uninstalling the Subspace Storage plugin:

npx clusteriohost plugin remove subspace_storage
npm uninstall @clusterio/plugin-subspace_storage

Since the plugin-list.json is shared between controller, host and ctl you usually only need to do this once per machine.

plugin list

Lists the plugins set up to be available by name followed by path.

config

Manage the host configuration offline. This should only be used when the host is stopped, otherwise the config read might be out of date and config changes will be overwritten when the host shuts down.

config set <config-entry> [value]

Set a config entry to the given value. If value is not provided the entry is set to null. If the config entry is of type object the value must be a valid JSON serialization of an object.

See docs/configuration.md in the main repositiory for the available configuration.

config show <config-entry>

Shows the value for a single config entry.

config list

Lists up all configuration entries with their currently configured values.

run

Runs the host.

See Also

The Clusterio repository for instructions on how to set up a cluster.