Nodes reference
Blocks
Each top-level key is one node: the machine's hostname by default.
# config/nodes.yaml
Legion: # this will usually be your hostname
listen_port: 10042 # On which port should the bot listen? Default is 10042
listen_address: 127.0.0.1 # Optional: On which interface should the bot listen? Default is 127.0.0.1 (localhost only).
# public_ip: 88.77.66.55 # Optional: Your public IP. ONLY if you have a static IP! Put this in here to speed up the startup-process of the bot.
# slow_system: false # Optional: if you are using a slower PC to run your servers, you should set this to true (default: false)
# use_upnp: true # The bot will auto-detect if there is a UPnP IGD available and configure this setting initially for you! If you do NOT want to use UPnP, even IF it is available, put this to false.
nodestats: true # Enable/disable node statistics (database pool and event queue sizes), default: true
auto_affinity:
enabled: true # Experimental: enable/disable auto affinity
excluded_cores: 0-1, 16 # Optional: cores to exclude from auto affinity (can be a list or a range string)
min_cores: 1 # Optional: minimum cores for the bot itself
max_cores: 2 # Optional: maximum cores for the bot itself
quality: 1 # Optional: quality of cores for the bot (0=E, 1=P)
# restrict_commands: true # Disable commands that can affect the integrity of the server. Default: false (see MULTINODE.md)
# restrict_owner: false # If set to true, the owner of the bot can also not run restricted commands. Default: false (see MULTINODE.md)
The full commented sample is samples/nodes.yaml.
| Key | Type | Description | Example |
|---|---|---|---|
listen_address |
str | Interface on which the bot accepts node connections. (range: min 1) | 127.0.0.1 |
listen_port |
int | Port the bot listens on for node-to-node connections. | 10042 |
proxy |
map | Optional node-wide proxy used to reach external web services. | url: 'https://myfancyproxy:8080' |
proxy.url |
url | URL of the proxy server. | https://myfancyproxy:8080 |
proxy.username |
str | Username used to authenticate against the proxy. (range: min 1) | admin |
proxy.password |
str | Password used to authenticate against the proxy. | *** |
public_ip |
str | Public IP of this node; set it only with a static IP. (range: min 1) | 88.77.66.55 |
use_upnp |
bool | Auto-forward the node's ports via UPnP. | true |
autoupdate |
bool | Automatically update the bot itself on this node. | false |
slow_system |
bool | Set on slower hosts to reduce CPU-heavy background work. | false |
nodestats |
bool | Report node statistics such as pool and event queue sizes. | true |
restrict_commands |
bool | Block commands that can affect server integrity. | true |
restrict_owner |
bool | Also block restricted commands for the bot owner. | false |
cluster |
map | Cluster settings; only needed in multi-node installations. | preferred_master: true |
cluster.preferred_master |
bool | Mark this node as the preferred cluster master. | true |
cluster.no_master |
bool | Prevent this node from ever becoming the master. | false |
cluster.heartbeat |
int | Seconds between master and agent heartbeats. (range: min 10) | 30 |
cluster.heartbeat_timeout |
int | Seconds without a heartbeat before a node is considered dead. (range: min 5) | 20 |
cluster.unregister_grace |
int | Seconds before an unreachable node is removed from the cluster. (range: min 10) | 60 |
cluster.cloud_drive |
bool | Set if DCS is installed on a cloud drive or NAS. | true |
auto_affinity |
map | Automatic CPU affinity assignment for DCS servers. | enabled: true |
auto_affinity.enabled |
bool | Enable automatic CPU affinity for this node. | true |
auto_affinity.excluded_cores |
any | Cores excluded from auto-affinity (list or range string). | 0-1, 16 |
auto_affinity.min_cores |
int | Minimum cores reserved for the bot itself. (range: min 1) | 1 |
auto_affinity.max_cores |
int | Maximum cores reserved for the bot itself. (range: min 1) | 2 |
auto_affinity.quality |
int | Requested core quality (0 = efficiency, 1 = performance). (range: min 0) | 1 |
auto_affinity.reuse_cores |
bool | Allow bounded core reuse when minimums cannot be met. | true |
auto_affinity.max_core_sharing |
int | Max managed processes allowed to share one logical CPU. (range: min 1, max 8) | 2 |
auto_affinity.growth_load_threshold |
float | Grow a process only above this load per assigned core. (range: min 0.0) | 70.0 |
auto_affinity.steal_load_threshold |
float | Allow stealing cores from idle processes above this load. (range: min 0.0) | 85.0 |
auto_affinity.idle_load_threshold |
float | Processes below this load per core may be treated as idle. (range: min 0.0) | 20.0 |
auto_affinity.steal_streak |
int | Consecutive high-load checks needed before stealing cores. (range: min 1) | 3 |
database |
map | Database connection settings for this node. | url: postgresql://dcssb:***@localhost:5432/dcssb |
database.url |
str (required) | PostgreSQL connection URL used by this node. (range: min 1) | postgresql://dcssb:***@localhost:5432/dcssb |
database.pool_min |
int | Minimum database connections kept in the pool. (range: min 2) | 2 |
database.pool_max |
int | Maximum database connections allowed in the pool. (range: min 5) | 10 |
database.max_reties |
int | Retries to connect to the database on startup. (range: min 1) | 3 |
database.max_idle |
int | Maximum idle time of a pooled database connection. (range: min 0) | 300 |
DCS |
map | DCS installation and update settings for this node. | installation: '%ProgramFiles%\Eagle Dynamics\DCS World' |
DCS.installation |
str (required) | Path to the DCS World installation on this node. (range: min 1) | %ProgramFiles%\Eagle Dynamics\DCS World |
DCS.autoupdate |
bool | Auto-update DCS on this node when a new version is available. | true |
DCS.announce |
map | Discord announcement posted after a DCS update. | channel: 11223344556677 |
DCS.announce.channel |
int (required) | Discord channel ID that receives the update announcement. | 11223344556677 |
DCS.announce.title |
str | Announcement embed title. (range: min 1) | DCS has been updated to version {}! |
DCS.announce.description |
str | Announcement embed description. (range: min 1) | The following servers have been updated: |
DCS.announce.footer |
str | Announcement embed footer text. (range: min 1) | Please make sure you update your DCS client to join! |
DCS.announce.mention |
list | Roles or users to mention in the announcement. | - Admin |
DCS.update_window |
map | Time windows in which DCS updates are allowed. | timezone: Europe/Berlin |
DCS.update_window.timezone |
str | Timezone used to interpret the update windows. (range: min 1) | Europe/Berlin |
DCS.update_window.<(^(0?[0-9]\|1[0-9]\|2[0-4])(:[0-5][0-9])?-(0?[0-9]\|1[0-9]\|2[0-4])(:?[0-5][0-9])?$)> |
str | |
|
DCS.desanitize |
bool | Desanitize MissionScripting.lua after each update. | true |
DCS.minimized |
bool | Start DCS servers minimized. | true |
DCS.user |
str | DCS account username, only needed in special setups. (range: min 1) | myDCSuser |
DCS.password |
str | DCS account password, stored as a secret by the bot. (range: min 1) | *** |
DCS.allow_unsafe_api |
list | Unsafe DCS API features allowed for scripts. | - scripting |
DCS.allow_dostring_in |
list | DCS environments in which loadstring is allowed. | - server |
extensions |
|
||
instances |
map | DCS instances running on this node. | DCS.openbeta: |
instances.<(.+)> |
map | |
|
instances.<(.+)>.bot_port |
int (required) | Port the bot uses to communicate with this instance. | 6666 |
instances.<(.+)>.webgui_port |
int (required) | Port of the DCS WebGUI for this instance. | 8088 |
instances.<(.+)>.dcs_port |
int (required) | DCS port of this instance. | 10308 |
instances.<(.+)>.home |
str | Path to the instance's Saved Games directory. (range: min 1) | %USERPROFILE%\Saved Games\DCS.openbeta |
instances.<(.+)>.missions_dir |
str | Directory where the bot scans for missions. (range: min 1) | %USERPROFILE%\Documents\Missions |
instances.<(.+)>.mission_rewrite |
bool | Let the bot rewrite missions on the fly without a restart. | true |
instances.<(.+)>.autoscan |
bool | Auto-add new mission files found in the missions folder. | true |
instances.<(.+)>.autoscan_observer |
str | How the missions folder is watched. auto uses polling when the folder is a network share (UNC, mapped drive or a junction into one) and file notifications otherwise. (one of: auto, notify, polling) | auto |
instances.<(.+)>.autoscan_poll_interval |
int | Seconds between polls of the missions folder (polling observer only). (range: min 1) | 3 |
instances.<(.+)>.autoscan_stable_timeout |
int | Seconds a new mission file may keep growing before autoscan gives up on it. (range: min 1) | 60 |
instances.<(.+)>.server_user |
str | Username shown as the sender of server-side messages. (range: min 1) | Admin |
instances.<(.+)>.max_hung_minutes |
int | Kill the server after this many minutes of unresponsiveness. (range: min 0) | 3 |
instances.<(.+)>.affinity |
any | Deprecated CPU affinity for DCS_Server.exe; use auto_affinity. | 2,3 |
instances.<(.+)>.auto_affinity |
map | Per-instance CPU affinity overrides. | min_cores: 2 |
instances.<(.+)>.auto_affinity.min_cores |
int | Minimum cores for this instance. (range: min 1, max 128) | 2 |
instances.<(.+)>.auto_affinity.max_cores |
int | Maximum cores for this instance. (range: min 1, max 128) | 4 |
instances.<(.+)>.auto_affinity.quality |
int | Core quality for this instance (higher is better). (range: min 1, max 3) | 3 |
instances.<(.+)>.priority |
str | OS process priority for DCS_Server.exe. (one of: below_normal, normal, above_normal, high, realtime) | normal |
instances.<(.+)>.extensions |
|