Document missing config options (#995)

configuration.md was missing most options added over the last few years. Add the controller, host and instance options that weren't listed, mark the internal ones, note the validation rule under each field that has one, and fix entries that had gone stale: the tls defaults, the proxy_stream_timeout name, game port assignment from host.factorio_port_range, the three sync list modes, and the player_online_autosave_slots heading.

Plugin options live in the plugin READMEs, so add the missing ones for inventory_sync, player_auth and subspace_storage there. config-system.md gets the field definition properties it didn't list yet.

Co-authored-by: bbassie <fqv4b97f@bastiaanbreemer.nl>
Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
authored and GitHub committed 2026-09-12 22:47:13 +01:00
1 parent e6b642fc19
commit 89c51f0f74
5 files changed
+420 -16

No files matched your search

+21
View File
@@ -43,3 +43,24 @@ Should an error occur during this process the player is given the option to use
Communication between the server and instance goes over stdout or rcon, depending on the size of the data.
Communication between the instance and the controller goes over websockets.
Overall, we are able to achieve a latency between 3 and infinite ticks from server join, depending on the size of the inventory. The major limiter is rcon transfer speeds with larger inventories, especially if they contain blueprints.
## Controller Configuration
### inventory_sync.player_lock_timeout
Time in seconds before the exclusive access an instance holds on a player's inventory expires after the instance stops or its host disconnects.
Until it expires the player is told the inventory is in use on that instance when joining another one.
The timeout is cancelled if the instance comes back before it runs out.
Defaults to `60`.
## Instance Configuration
### inventory_sync.rcon_chunk_size
Size in characters of the chunks the serialized inventory is split into when sent to the game over RCON.
Smaller chunks take more commands to transfer an inventory but hold up the RCON command pipe for less time each.
Defaults to `1000`.
+7
View File
@@ -29,3 +29,10 @@ Time in seconds the first code generated stays valid.
The login must be completed in less than this time starting from when the login dialog is opened in-game.
Defaults to `120`.
#### player_auth.show_connect_address
Show the address to connect to for each server in the server list on the login page of the web interface, made up of host.public_address and the game port of the instance.
This list is visible to anyone who can reach the web interface, so leave it off if you don't want unauthenticated users to see where the servers are.
Defaults to `false`.
+29
View File
@@ -11,3 +11,32 @@ Run the following commands in the folder Clusterio is installed to:
npx clusteriocontroller plugin add @clusterio/plugin-subspace_storage
Substitute clusteriocontroller with clusteriohost or clusterioctl if this a dedicate host or ctl installation respectively.
## Controller Configuration
### subspace_storage.division_method
How to divide items between instances when there isn't enough in storage to give everyone what they ask for.
One of `simple`, `dole` or `neural_dole`.
With `simple` requests are served in full on a first come first served basis until the storage runs out.
With `dole` a per item division factor is kept that halves the amount handed out each time a request can't be met and slowly recovers when requests succeed, which spreads the remaining items between instances at the cost of draining the last of an item slowly.
`neural_dole` does the same with a small neural network estimating a fair share from the recent request history.
Defaults to `simple`.
### subspace_storage.log_item_transfers
Log every item transfer in and out of the storage to the controller console at verbose level.
Defaults to `false`.
## Instance Configuration
### subspace_storage.log_item_transfers
Log every item transfer in and out of the storage to the host console at verbose level.
Defaults to `false`.