mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-13 07:04:53 +09:00
Hornwitser
4834c289ff
Add README with basic descriptions of each package to all of the packages in this repository.
324 lines
8.5 KiB
Markdown
324 lines
8.5 KiB
Markdown
Configuration
|
|
=============
|
|
|
|
|
|
Master Configuration
|
|
--------------------
|
|
|
|
### master.database_directory
|
|
|
|
Directory used to store cluster data to. Needs to be writeable by the
|
|
master server. This is also used by plugins to store its data.
|
|
|
|
Defaults to "database".
|
|
|
|
|
|
### master.http_port
|
|
|
|
Port to host HTTP server on. If set to null no HTTP server will be
|
|
exposed. At least one of this and master.https_port needs to be set to
|
|
a port.
|
|
|
|
Defaults to null.
|
|
|
|
|
|
### master.https_port
|
|
|
|
Port to host HTTPS server on. Uses master.tls_certificate and
|
|
master.tls_private_key as the certificate and private key for the HTTPS
|
|
server. If set to null no HTTPS server will be exposed. At least one
|
|
of this and master.http_port needs to be set to a port.
|
|
|
|
Defaults to 8443.
|
|
|
|
|
|
### master.external_address
|
|
|
|
External address the master server is accessible on. Currently only
|
|
used for `clusteriomaster bootstrap create-ctl-config` in order to give
|
|
the right url to connect to. This should be a full URL ending with a /.
|
|
|
|
Defaults to null meaning assume localhost.
|
|
|
|
|
|
### master.tls_certificate
|
|
|
|
TLS certificate to use for the HTTPS server when master.https_port is
|
|
configured. If neither this nor the configured master.tls_private_key
|
|
exists a self signed certificate is automatically created.
|
|
|
|
Defaults to "database/certificates/cert.crt".
|
|
|
|
|
|
### master.tls_private_key
|
|
|
|
TLS private key to use for the HTTPS server when master.https_port is
|
|
configured. If neither this nor the configured master.tls_certificate
|
|
exists a self signed certificate is automatically created.
|
|
|
|
Defaults to "database/certificates/cert.key".
|
|
|
|
|
|
### master.tls_bits
|
|
|
|
Number of bits to use when creating a self signed certificate.
|
|
|
|
Defaults to 2048.
|
|
|
|
|
|
### master.auth_secret
|
|
|
|
Base64 encoded authentication secret used to verify tokens issued to
|
|
slaves, users, and sessions. This should contain 256 bytes of random
|
|
data, and if changed will cause all tokens become invalid. Keep this
|
|
secret if leaked an attacker could easily compromise the cluster.
|
|
|
|
Defaults to null which means generate a secure secret on startup.
|
|
|
|
|
|
### master.heartbeat_interval
|
|
|
|
Interval in seconds heartbeats are sent out at for WebSocket
|
|
connections. If a connection hasn't received a heartbeat in 2 times the
|
|
heartbeat interval it will be considered stale and closed. A lower
|
|
value means less time between connections going stale and them being
|
|
closed.
|
|
|
|
Defaults to 60
|
|
|
|
|
|
### master.connector_shutdown_timeout
|
|
|
|
Timeout in seconds to use while shutting down the master server for link
|
|
sessions that currently don't have an active connection and haven't been
|
|
closed down properly. This happens when the network between a slave and
|
|
the master server goes down unexpectedly, or the slave goes down without
|
|
closing the connection properly either do to crashing or the machine
|
|
it's hosted on going down. If the timeout expires the session is
|
|
terminated and data loss may occur, if the slave went down this is
|
|
unavoidable.
|
|
|
|
Defaults to 30.
|
|
|
|
|
|
### master.default_role_id
|
|
|
|
Role to automatically grant to new users. If null no role is granted.
|
|
|
|
Defaults to 1 which correspond to the default Player role.
|
|
|
|
|
|
### <plugin_name>.enabled
|
|
|
|
Whether to enable the given plugin on the master server. Plugins
|
|
disabled on the master server will not be loaded on instances.
|
|
|
|
Defaults to true.
|
|
|
|
|
|
Slave Configuration
|
|
-------------------
|
|
|
|
### slave.name
|
|
|
|
Name of the slave. Shows up in slave lists and is used to reference
|
|
this slave in the clusterioctl command line interface.
|
|
|
|
Defaults to "New Slave".
|
|
|
|
|
|
### slave.id
|
|
|
|
Imutable numeric id of the slave which uniquely identifies this slave in
|
|
the cluster.
|
|
|
|
Defaults to a random 31 bit number.
|
|
|
|
|
|
### slave.factorio_directory
|
|
|
|
Directory to look for the Factorio server(s) in. This can either point
|
|
to a Factorio server directory, or to a directory containing multiple
|
|
versions of the Factorio server.
|
|
|
|
Defaults to "factorio".
|
|
|
|
|
|
### slave.instances_directory
|
|
|
|
Directory to store instances in. One sub-directory will be created in
|
|
it for each instance assigned to this slave and these sub-directories
|
|
will contain logs, saves, and various auto generated configuration files
|
|
for the instances.
|
|
|
|
Defaults to "instances".
|
|
|
|
|
|
### slave.master_url
|
|
|
|
URL to connect to the master server to.
|
|
|
|
Defaults to "https://localhost:8443/".
|
|
|
|
|
|
### slave.master_token
|
|
|
|
Access token used for authenticating with the master server. You can
|
|
generate an access token with `clusterioctl slave generate-token
|
|
--id <slave-id>`, or use the `clusterioctl slave create-config` to
|
|
create a new slave config with the correct url and token in it.
|
|
|
|
Defaults to "enter token here".
|
|
|
|
|
|
### slave.public_address
|
|
|
|
External address instances hosted on this slave can be accessed on.
|
|
This is used by plugins like Server Select to give the correct address
|
|
to switch between instances in-game.
|
|
|
|
Defaults to "localhost".
|
|
|
|
|
|
### slave.reconnect_delay
|
|
|
|
Delay in seconds to wait after connection to the master server is
|
|
dropped before attempting to reconnect to it. The actual delay on each
|
|
reconnect will be a random number between 0 and this configured value to
|
|
avoid all slaves trying to reconnect at the same time.
|
|
|
|
Defaults to 5.
|
|
|
|
|
|
Instance Configuration
|
|
======================
|
|
|
|
### instance.name
|
|
|
|
Name of the instance, shown in instance lists and used to reference to this
|
|
instance in the clusterioctl command line interface.
|
|
|
|
Defaults to "New Instance"
|
|
|
|
|
|
### instance.id
|
|
|
|
Imutable numeric id of the instance which uniquely identifies this
|
|
instance in the cluster.
|
|
|
|
Defaluts to a random 31 bit integer.
|
|
|
|
|
|
### instance.assigned_slave
|
|
|
|
Slave this instance is assigned to. To change this you need to use the
|
|
separate assign instance interface. After being assigned to a slave the
|
|
directory for the instance is created on the slave.
|
|
|
|
Defaults to null meaning not assigned.
|
|
|
|
|
|
### factorio.version
|
|
|
|
Version of Factorio to use for this instance. Can be a version like
|
|
"1.0.0" or special string "latest" meaning the latest version of
|
|
Factorio found on the slave.
|
|
|
|
Defaults to "latest"
|
|
|
|
|
|
### factorio.game_port
|
|
|
|
UDP port to run the Factorio server on. If null a random port in the
|
|
dynamyc range assigned each time the instance starts.
|
|
|
|
Defaults to null
|
|
|
|
|
|
### factorio.rcon_port
|
|
|
|
TCP port to start the RCON interface on the Factorio server on. If null
|
|
a random port in the dynamic range is assigned each time the instance
|
|
starts.
|
|
|
|
Defaults to null
|
|
|
|
|
|
### factorio.rcon_password
|
|
|
|
Password to use for the RCON interafec. If null a random secure
|
|
password is generated and used each time the instance starts.
|
|
|
|
Defaults to null
|
|
|
|
|
|
### factorio.enable_save_patching
|
|
|
|
Whether to use save patching or not. When enabled lua code is patched
|
|
into the game save before starting it. Most plugins require the use of
|
|
save patching to function. Turning it off makes it possible to use
|
|
Clusterio to run and manage regular vanilla games and scenarios not
|
|
compatible with Clusterio.
|
|
|
|
Defaults to true
|
|
|
|
|
|
### factorio.enable_whitelist
|
|
|
|
Turn on the whitelist on the server.
|
|
|
|
Defaults to false
|
|
|
|
|
|
### factorio.settings
|
|
|
|
Object with the settings to put into `server-settings.json` for the
|
|
Factorio server. The settings in `data/server-settings.example.json` of
|
|
the Factorio installation is used as the base and properties specified
|
|
here overrides the properties there.
|
|
|
|
Defaults to {"tags":["clusterio"],"auto_pause":false}.
|
|
|
|
|
|
### factorio.sync_adminlist
|
|
|
|
Synchronize in-game admin list with admin status of the users in
|
|
cluster. If enabled Clusterio will generate a new
|
|
`server-adminlist.json` on instance startup based on the users in the
|
|
cluster with admin status set to true, and keep the admins in sync with
|
|
the users that have admin status while the instance is running.
|
|
|
|
Defaults to true
|
|
|
|
|
|
### factorio.sync_whitelist
|
|
|
|
Synchronize in-game whitelist with the whitelisted status of the users
|
|
in the cluster. If enabled Clusterio will generate a new
|
|
`server-whitelist.json` on instance startup based on the users in the
|
|
cluster with whitelisted status set to true, and keep the whitelisted
|
|
users in sync with the users that have whitelisted status while the
|
|
instance in running.
|
|
|
|
Defaults to true
|
|
|
|
|
|
### factorio.sync_banlist
|
|
|
|
Synchronize in-game banlist with the banned status of users in the
|
|
cluster. If enabled Clusterio will generate a new `server-banlist.json`
|
|
on instance startup based on users in the cluster with banned status set
|
|
to true, and keep the banned users in sync with the users that have the
|
|
banned status while the instance is running.
|
|
|
|
Defaults to true
|
|
|
|
|
|
### <plugin_name>.enabled
|
|
|
|
Whether to enable the given plugin on the instance. Note that plugins
|
|
need to be enabled on the master server in order for them to be loaded
|
|
on instances.
|
|
|
|
Defaults to true
|