HornwitserandHornwitser
94692dc418
* Fix tests failing due to missmatched Factorio detection When the configured factorio directory is full of junk then the tests use the first directory it finds for one of its tests, while the server code uses a more elaborate logic to figure this out. Turns out this is complicating things more than needed. Simply trying each entry in the directory and seeing if it works when treated as a directory always work, regardsless of symlinks, junctions, reparse-points or whatever else filesystem magic there is. * Skip tests requiring Factorio if it's not present Prevent confusing test failures by skipping all the tests that require a working Factorio installation to sucteed, and print a warning at the end of the test suite if tests may have been skipped due to this. * Handle ENOTDIR when determining Factorio version If the path to the factorio install contains a component that is not a file then ENOTDIR may be returned on POSIX like systems. Treat this the same as ENOENT so that detection logic works when used on a file. --------- Co-authored-by: Hornwitser <code@hornwitser.no>
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 toplugin-list.jsonand will be created if it does not exist. See theplugincommand for managing this list. -
--config <file>JSON file to use for storing configuration for the host. Defaults toconfig-host.jsonand will be created if it does not exist. See theconfigcommand 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.