Overview
Environment variables provide an alternative to command-line flags for configuring the TeamSpeak 6 Server. They are especially useful in:- Docker and container deployments
- Automated deployment scripts
- CI/CD pipelines
- Keeping sensitive data (like passwords) out of command histories
If both a command-line flag and an environment variable are set, the command-line flag takes precedence.
General Configuration
General & Core
General & Core
Confirms you have read and accepted the server license agreement.Accepted values:
1, accept, trueCLI equivalent: --accept-licenseSpecifies the configuration file to load.CLI equivalent:
--config-fileDirectory path where the server will look for the
licensekey.dat file.CLI equivalent: --license-pathServer Configuration
Voice & Network
Voice & Network
Permanently sets the default UDP voice port for the first virtual server created.Range: 1 - 65535CLI equivalent:
--default-voice-portIP address(es) for the server to bind the voice port to. Multiple IPs can be separated by commas.CLI equivalent:
--voice-ipExample:A string to distinguish this instance from other instances using the same database.CLI equivalent:
--machine-idNumber of threads to use for voice processing.Range: 1 - 16CLI equivalent:
--threads-voice-udpVirtual Server
Virtual Server
If set, no default server is created even if no server exists in the database.Accepted values:
1, trueCLI equivalent: --no-default-virtual-serverLogging
Log Configuration
Log Configuration
File Transfer
File Transfer Settings
File Transfer Settings
Database Configuration
Database Settings
Database Settings
Specifies the database plugin to use.Accepted values:
sqlite3, mariadbCLI equivalent: --db-pluginPath to folder containing SQL queries used by the server.CLI equivalent:
--db-sql-pathSubdirectory in SQL path to use for DB creation scripts.Examples:
create_sqlite, create_mariadbCLI equivalent: --db-sql-create-pathNumber of days to keep clients in the database before cleanup.CLI equivalent:
--db-client-keep-daysSQLite only: skip DB integrity check at startup.Accepted values:
1, trueCLI equivalent: --db-skip-integrity-checkEnable logging of SQL queries.Accepted values:
1, trueCLI equivalent: --db-log-queriesDo not apply permission changes during server updates.Accepted values:
1, trueCLI equivalent: --no-permission-updateDatabase Connection
Database Connection
Database hostname or IP address.CLI equivalent:
--db-hostDatabase port.Range: 1 - 65535CLI equivalent:
--db-portDefault port varies by database: MariaDB/MySQL (3306)
Socket file to use for database connection (alternative to host/port).CLI equivalent:
--db-socketTimeout in seconds when connecting to the database.Range: 1 - 432000CLI equivalent:
--db-timeoutName of the database to use.CLI equivalent:
--db-nameThe username to use for database authentication.CLI equivalent:
--db-usernameThe password to use for database authentication.CLI equivalent:
--db-passwordNumber of connections to establish to the database.Range: 2 - 100CLI equivalent:
--db-connectionsQuery Interface
General Query Settings
General Query Settings
How many threads to use for query command processing.Range: 2 - 32CLI equivalent:
--query-pool-sizeInterval in seconds after which to log query statistics.Range: 10 - 31556952CLI equivalent:
--query-log-timingFile path listing IPs exempt from query flood protection.CLI equivalent:
--query-ip-allow-listFile path listing IPs blocked from the query interface.CLI equivalent:
--query-ip-block-listOverride the query password for the built-in serveradmin account.CLI equivalent:
--query-admin-passwordLog every command received on the query interface.Accepted values:
1, trueCLI equivalent: --query-log-commandsSkip brute force checking on query interface connections.Accepted values:
1, trueCLI equivalent: --query-skip-brute-force-checkHow much memory (in MB) to allocate for query connection buffering.Range: 20 - 100CLI equivalent:
--query-buffer-mbPath to the query documentation files.CLI equivalent:
--query-documentation-pathTimeout in seconds before query connections expire due to inactivity.CLI equivalent:
--query-timeoutSSH Query
SSH Query
Enable the SSH query interface.Accepted values:
1, trueCLI equivalent: --query-ssh-enablePort on which to listen for SSH query connections.Range: 1 - 65535CLI equivalent:
--query-ssh-portAddress(es) to listen on for SSH query connections.CLI equivalent:
--query-ssh-ipPath to the SSH RSA host key file.CLI equivalent:
--query-ssh-rsa-keyHTTP Query
HTTP Query
Enable the HTTP query interface.Accepted values:
1, trueCLI equivalent: --query-http-enablePort on which to listen for Web Query connections.Range: 1 - 65535CLI equivalent:
--query-http-portAddress(es) to listen on for Web Query connections.CLI equivalent:
--query-http-ipHTTPS Query
HTTPS Query
Enable the HTTPS query interface.Accepted values:
1, trueCLI equivalent: --query-https-enablePort on which to listen for secure Web Query connections.Range: 1 - 65535CLI equivalent:
--query-https-portAddress(es) to listen on for secure Web Query connections.CLI equivalent:
--query-https-ipPath to certificate file for HTTPS Web Query.CLI equivalent:
--query-https-certificatePath to private key file used with the certificate.CLI equivalent:
--query-https-private-keyAdvanced Configuration
Advanced Options
Advanced Options
Proxy server used for external connections.CLI equivalent:
--http-proxyExample:Path where crash dumps should be written.CLI equivalent:
--crashdump-pathRun the server in the background (daemon mode).Accepted values:
1, trueCLI equivalent: --daemonFile to write the process ID to when running in daemon mode.CLI equivalent:
--pid-fileEnable permission hints.Accepted values:
1, trueCLI equivalent: --hints-enabledPath to the MaxMind GeoIP database.CLI equivalent:
--maxmind-db-pathAdministrative domain for internal or regulatory identification.CLI equivalent:
--administrative-domainDocker Example
Here’s a complete example of using environment variables in a Docker deployment:- docker-compose.yml
- docker run
- .env file
See Also
CLI Options
Complete list of command-line options
YAML Configuration
YAML configuration file schema