Configuration

Architect Agent config.toml
Written by Philipp
Updated 10 months ago

The Architect Agent comes with certain fixed settings that are loaded at startup. You can adjust the Agent's behavior by changing specific values in this configuration.

Default configuration

[authorization]
# Replace <license_key> with your license key
license_key = "<license_key>"

# Option to disable "root" user access from remote networks (limits to localhost/127.0.0.1)
# disable_remote_root = false # accepted values: true, false

# Fail2Ban automatically blocks authentication attempts from ip addresses trying to authenticate with wrong credentials
fail2ban_attempts = 5 # accepted values: numeric
fail2ban_ban_time = 60 # accepted values: numeric, time in seconds

[logging]
# Allows you to enable console and debug logging
verbose = true # accepted values: true, false

# How long API audit logs are retained
audit_logs_retention = 7 # accepted values: numeric, time in days

[filesystem]
# Insert the full path where you want to install the Agent
agent_dir = "<installation_directory>" 

# Limit maximum file size to be downloaded through read_file/download_file
# max_manager_download_size = 32 # accepted values: numeric, size in mib

# Internal folder structure
# database_dir = "" # optional override for database directory, full path
# log_dir = "" # optional override for agent logs directory, full path
# deployments_dir = "" # optional override for deployments directory, full path
# cache_dir = "" # optional override for cache directory, full path
# certs_dir= "" # optional override for certs directory, full path
# backups_dir= "" # optional override for backups directory, full path

# Lifecycle hooks
# python_path = "" # optional path to your python installation you want to use, omit for auto discovery

[http_server]
# Allows you to rebind Architect to a specific network interface
address = "0.0.0.0" # 0.0.0.0 means that Architect will listen to all network interfaces and ip's

# Port which Architect agent will listen on for Architect Manager and API connections
port = 8090 # default: 8090

# Whether or not to use SSL for connections, turning this off is NOT recommended
# You can exchange the SSL certificates with custom ones by replacing the self-signed ones in `certs`
use_ssl = true 

[steam_servers]
# Timeout for chunk download from Steam CDN
chunk_download_timeout = 5 # accepted values: numeric, time in seconds

# Allowed concurrent chunks
# Higher values will increase your CPU/RAM usage
# download_batch_size = 60 # accepted values: numeric

# Maximum parallel downloads per Steam CDN server
# The default is 8. Safe values are 8-16. Higher values will result in individual chunk downloads 
# failing due to rate limitations
# max_downloads_per_cdn = 8 # accepted values: numeric

# Option to disable caching of downloaded chunks in memory and instead write to disk as .part files
# Useful for low memory machines
# disable_buffered_download = false # accepted values: true, false

[dayz]
# Enable DZSALauncher queries
dzsa_launcher_update_enable = true # accepted values: true, false

# Interval for DZSALauncher queries
dzsa_launcher_update = 60 # accepted values: numeric, time in seconds

[rcon]
# Disable RCon integration for Agent
disable_rcon = false # accepted values: true, false

# Optional local network ip address in case 127.0.0.1 does not resolve
# rcon_ip_address = "" # accepted values: ipv4, ipv6

[windows]
# Set an optional execution policy for Powershell scripts (lifecycle hooks)
# powershell_execution_policy = "Bypass" # accepted values: str, a valid Windows Powershell Execution policy

# Control if server should be pushed to a user session in order for the console to be displayed
# start_server_non_interactive = false # accepted values: true, false

# Control which session should be hijacked, falls back to non interactive if hijacked fails
# When empty, uses a random active session
# session_username = "" # accepted values: Windows username (Case Sensitive)

Any change to your config.toml requires a restart of Architect Agent.
Did this answer your question?