mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-21 08:03:13 +09:00
Use a diff and author friendly markdown formatting (#370)
Simplify the the way markdown files are formatted to make them easier to author without editors that do auto line breaking, and make the diffs from them simpler to read.
This commit is contained in:
1 parent
a2d56d4a8d
commit
9542246414
21 files changed
+1021
-1788
No files matched your search
+27
-44
@@ -1,70 +1,57 @@
|
||||
Clusterio Command Line Interface
|
||||
================================
|
||||
# Clusterio Command Line Interface
|
||||
|
||||
|
||||
Provides a command line interface for managing a Clusterio cluster.
|
||||
|
||||
Note that this document only describes the options and commands for
|
||||
managing clusterioctl itself, see [Managing a
|
||||
cluster](/docs/managing-a-cluster.md) for the available commands used
|
||||
for managing a cluster.
|
||||
Note that this document only describes the options and commands for managing clusterioctl itself, see [Managing a cluster](/docs/managing-a-cluster.md) for the available commands used for managing a cluster.
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
## Usage
|
||||
|
||||
npx clusterioctl <command>
|
||||
|
||||
Common options:
|
||||
|
||||
* `--plugin-list <file>` JSON file to use for storing the list of
|
||||
plugins that are available to ctl. Defaults to `plugin-list.json`
|
||||
and will be created if it does not exist. See the `plugin` command
|
||||
for managing this list.
|
||||
* `--plugin-list <file>` JSON file to use for storing the list of plugins that are available to ctl.
|
||||
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
|
||||
ctl. Defaults to `config-control.json` and will be created if it
|
||||
does not exist. See the `config` command for inspecting and
|
||||
modifying the configuration.
|
||||
* `--config <file>` JSON file to use for storing configuration for ctl.
|
||||
Defaults to `config-control.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 ctl. The available plugins
|
||||
will be automatically loaded and the commands they provide will be added
|
||||
to the ctl utility.
|
||||
Configure plugins available to be loaded by ctl.
|
||||
The available plugins will be automatically loaded and the commands they provide will be added to the ctl utility.
|
||||
|
||||
|
||||
#### `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.
|
||||
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 clusterioctl plugin add @clusterio/plugin-subspace_storage
|
||||
|
||||
Since the `plugin-list.json` is shared between master, slave and ctl you
|
||||
usually only need to do this once per machine.
|
||||
Since the `plugin-list.json` is shared between master, slave 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.
|
||||
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 clusterioctl plugin remove subspace_storage
|
||||
npm uninstall @clusterio/plugin-subspace_storage
|
||||
|
||||
Since the `plugin-list.json` is shared between master, slave and ctl you
|
||||
usually only need to do this once per machine.
|
||||
Since the `plugin-list.json` is shared between master, slave and ctl you usually only need to do this once per machine.
|
||||
|
||||
|
||||
#### `plugin list`
|
||||
@@ -74,18 +61,17 @@ Lists the plugins set up to be available by name followed by path.
|
||||
|
||||
### `config-control`
|
||||
|
||||
Manage the ctl configuration. This allows setting the url and token to
|
||||
the master server to manage.
|
||||
Manage the ctl configuration.
|
||||
This allows setting the url and token to the master server to manage.
|
||||
|
||||
|
||||
#### `config-control 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.
|
||||
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.
|
||||
See docs/configuration.md in the main repositiory for the available configuration.
|
||||
|
||||
|
||||
#### `config-control show <config-entry>`
|
||||
@@ -100,9 +86,6 @@ Lists up all configuration entries with their currently configured values.
|
||||
|
||||
## See Also
|
||||
|
||||
[Managing a cluster](/docs/managing-a-cluster.md) for the available
|
||||
commands used for managing a cluster.
|
||||
[Managing a cluster](/docs/managing-a-cluster.md) for the available commands used for managing a cluster.
|
||||
|
||||
[The Clusterio
|
||||
repository](https://github.com/clusterio/factorioClusterio)
|
||||
for instructions on how to set up a cluster.
|
||||
[The Clusterio repository](https://github.com/clusterio/factorioClusterio) for instructions on how to set up a cluster.
|
||||
@@ -1,8 +1,5 @@
|
||||
Common Library for Clusterio
|
||||
============================
|
||||
# Common Library for Clusterio
|
||||
|
||||
This package contains functionality shared between master, slave, ctl
|
||||
and/or plugins of Clusterio.
|
||||
This package contains functionality shared between master, slave, ctl and/or plugins of Clusterio.
|
||||
|
||||
See [the Clusterio repository](https://github.com/clusterio/factorioClusterio)
|
||||
for more information on Clusterio.
|
||||
See [the Clusterio repository](https://github.com/clusterio/factorioClusterio) for more information on Clusterio.
|
||||
+31
-52
@@ -1,68 +1,55 @@
|
||||
Clusterio Master Server
|
||||
=======================
|
||||
# Clusterio Master Server
|
||||
|
||||
Communication hub for Clusterio clusters. The master server forwards
|
||||
data between Clusterio slaves connected to it and allows the cluster to
|
||||
be remotely managed through WebSocket connections to it either by using
|
||||
the included web interface or the Clusterio ctl command line utility.
|
||||
Communication hub for Clusterio clusters.
|
||||
The master server forwards data between Clusterio slaves connected to it and allows the cluster to be remotely managed through WebSocket connections to it either by using the included web interface or the Clusterio ctl command line utility.
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
# Usage
|
||||
|
||||
npx clusteriomaster <command>
|
||||
|
||||
Common options:
|
||||
|
||||
* `--plugin-list <file>` JSON file to use for storing the list of
|
||||
plugins that are available to the master server. Defaults to
|
||||
`plugin-list.json` and will be created if it does not exist. See the
|
||||
`plugin` command for managing this list.
|
||||
* `--plugin-list <file>` JSON file to use for storing the list of plugins that are available to the master server.
|
||||
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
|
||||
master server. Defaults to `config-master.json` and will be created
|
||||
if it does not exist. See the `config` command for inspecting and
|
||||
modifying the configuration.
|
||||
* `--config <file>` JSON file to use for storing configuration for the master server.
|
||||
Defaults to `config-master.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 master server. The
|
||||
available plugins will be loaded unless they have been disabled in the
|
||||
configuration, see the config command for disabling plugins.
|
||||
Configure plugins available to be loaded by the master server.
|
||||
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.
|
||||
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 clusteriomaster plugin add @clusterio/plugin-subspace_storage
|
||||
|
||||
Since the `plugin-list.json` is shared between master, slave and ctl you
|
||||
usually only need to do this once per machine.
|
||||
Since the `plugin-list.json` is shared between master, slave 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.
|
||||
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 clusteriomaster plugin remove subspace_storage
|
||||
npm uninstall @clusterio/plugin-subspace_storage
|
||||
|
||||
Since the `plugin-list.json` is shared between master, slave and ctl you
|
||||
usually only need to do this once per machine.
|
||||
Since the `plugin-list.json` is shared between master, slave and ctl you usually only need to do this once per machine.
|
||||
|
||||
|
||||
#### `plugin list`
|
||||
@@ -72,20 +59,17 @@ Lists the plugins set up to be available by name followed by path.
|
||||
|
||||
### `config`
|
||||
|
||||
Manage the master server configuration offline. This should only be
|
||||
used when the master server is stopped, otherwise the config read might
|
||||
be out of date and config changes will be overwritten when the master
|
||||
server shuts down.
|
||||
Manage the master server configuration offline.
|
||||
This should only be used when the master server is stopped, otherwise the config read might be out of date and config changes will be overwritten when the master server 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.
|
||||
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 entries.
|
||||
See docs/configuration.md in the main repositiory for the available configuration entries.
|
||||
|
||||
|
||||
#### `config show <config-entry>`
|
||||
@@ -105,22 +89,19 @@ Commands for setting up initial admin acount and access to the cluster.
|
||||
|
||||
#### `bootstrap create-admin <name>`
|
||||
|
||||
Creates a new user account with the given name if it does not already
|
||||
exist in the cluster and grant it full cluster admin permission. You
|
||||
should be using your own Factorio multiplayer username here.
|
||||
Creates a new user account with the given name if it does not already exist in the cluster and grant it full cluster admin permission.
|
||||
You should be using your own Factorio multiplayer username here.
|
||||
|
||||
|
||||
#### `bootstrap generate-user-token <name>`
|
||||
|
||||
Generate an access token for logging in and possibly managing the
|
||||
cluster from the given user account. This can be used both in the web
|
||||
interface and as the `master_token` to connect with clusterioctl.
|
||||
Generate an access token for logging in and possibly managing the cluster from the given user account.
|
||||
This can be used both in the web interface and as the `master_token` to connect with clusterioctl.
|
||||
|
||||
|
||||
#### `bootstrap create-ctl-config <name>`
|
||||
|
||||
Creates a clusterioctl config for the given user with url and token set
|
||||
up for connecting to the cluster.
|
||||
Creates a clusterioctl config for the given user with url and token set up for connecting to the cluster.
|
||||
|
||||
|
||||
### `run`
|
||||
@@ -130,6 +111,4 @@ Runs the master server.
|
||||
|
||||
## See Also
|
||||
|
||||
[The Clusterio
|
||||
repository](https://github.com/clusterio/factorioClusterio)
|
||||
for instructions on how to set up a cluster.
|
||||
[The Clusterio repository](https://github.com/clusterio/factorioClusterio) for instructions on how to set up a cluster.
|
||||
+27
-45
@@ -1,70 +1,56 @@
|
||||
Clusterio Slave
|
||||
===============
|
||||
# Clusterio Slave
|
||||
|
||||
Node hosting Factorio servers in a Clusterio cluster. Clusterio slaves
|
||||
connect to the master server and waits for commands from the master
|
||||
server to start up and stop instances. A cluster can have any number of
|
||||
slaves in it located on different computers, and each slave can host any
|
||||
number of instances each of which is a Factorio server that talks with
|
||||
the rest of the cluster.
|
||||
Node hosting Factorio servers in a Clusterio cluster.
|
||||
Clusterio slaves connect to the master server and waits for commands from the master server to start up and stop instances.
|
||||
A cluster can have any number of slaves in it located on different computers, and each slave can host any number of instances each of which is a Factorio server that talks with the rest of the cluster.
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
## Usage
|
||||
|
||||
npx clusterioslave <command>
|
||||
|
||||
Common options:
|
||||
|
||||
* `--plugin-list <file>` JSON file to use for storing the list of
|
||||
plugins that are available to the slave. Defaults to
|
||||
`plugin-list.json` and will be created if it does not exist. See the
|
||||
`plugin` command for managing this list.
|
||||
* `--plugin-list <file>` JSON file to use for storing the list of plugins that are available to the slave.
|
||||
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
|
||||
slave. Defaults to `config-slave.json` and will be created if it
|
||||
does not exist. See the `config` command for inspecting and
|
||||
modifying the configuration.
|
||||
* `--config <file>` JSON file to use for storing configuration for the slave.
|
||||
Defaults to `config-slave.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 slave. The available
|
||||
plugins will be loaded unless they have been disabled in the
|
||||
configuration, see the config command for disabling plugins.
|
||||
Configure plugins available to be loaded by the slave.
|
||||
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.
|
||||
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 clusterioslave plugin add @clusterio/plugin-subspace_storage
|
||||
|
||||
Since the `plugin-list.json` is shared between master, slave and ctl you
|
||||
usually only need to do this once per machine.
|
||||
Since the `plugin-list.json` is shared between master, slave 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.
|
||||
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 clusterioslave plugin remove subspace_storage
|
||||
npm uninstall @clusterio/plugin-subspace_storage
|
||||
|
||||
Since the `plugin-list.json` is shared between master, slave and ctl you
|
||||
usually only need to do this once per machine.
|
||||
Since the `plugin-list.json` is shared between master, slave and ctl you usually only need to do this once per machine.
|
||||
|
||||
|
||||
#### `plugin list`
|
||||
@@ -74,19 +60,17 @@ Lists the plugins set up to be available by name followed by path.
|
||||
|
||||
### `config`
|
||||
|
||||
Manage the slave configuration offline. This should only be used when
|
||||
the slave is stopped, otherwise the config read might be out of date and
|
||||
config changes will be overwritten when the slave shuts down.
|
||||
Manage the slave configuration offline.
|
||||
This should only be used when the slave is stopped, otherwise the config read might be out of date and config changes will be overwritten when the slave 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.
|
||||
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.
|
||||
See docs/configuration.md in the main repositiory for the available configuration.
|
||||
|
||||
|
||||
#### `config show <config-entry>`
|
||||
@@ -106,6 +90,4 @@ Runs the slave.
|
||||
|
||||
## See Also
|
||||
|
||||
[The Clusterio
|
||||
repository](https://github.com/clusterio/factorioClusterio)
|
||||
for instructions on how to set up a cluster.
|
||||
[The Clusterio repository](https://github.com/clusterio/factorioClusterio) for instructions on how to set up a cluster.
|
||||
Reference in new issue
Block a user