2 changed files with 353 additions and 211 deletions
+329 -189
View File
@@ -2,8 +2,7 @@
### TeamSpeak 6 Server: Frequently Used Parameters & Environment Variables ### TeamSpeak 6 Server: Frequently Used Parameters & Environment Variables
This document provides a detailed list of frequently used command-line parameters and their corresponding environment variables for configuring the TeamSpeak 6 server. You can configure the server using: This document outlines the most commonly used command-line parameters and their equivalent environment variables for configuring the TeamSpeak 6 server. You can configure the server using either of the following methods:
- Command-line flags - Command-line flags
- Environment variables - Environment variables
- A `tsserver.yaml` configuration file - A `tsserver.yaml` configuration file
@@ -13,26 +12,26 @@ This document provides a detailed list of frequently used command-line parameter
#### General & Core Server Configuration #### General & Core Server Configuration
| Parameter | Environment Variable | Description | | Parameter | Environment Variable | Description |
|----------------------------------|--------------------------------|-----------------------------------------------------------------------------| |-------------------------------|--------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--config-file <file>` | `TSSERVER_CONFIG_FILE` | Specifies the configuration file to load (e.g., `tsserver.yaml`). | | `--config-file <file>` | `TSSERVER_CONFIG_FILE` | Specifies the configuration file to load (e.g., `tsserver.yaml`). |
| `--license-path <path>` | `TSSERVER_LICENSE_PATH` | Directory path where the server will look for the `licensekey.dat` file. | | `--license-path <path>` | `TSSERVER_LICENSE_PATH` | Directory path where the server will look for the `licensekey.dat` file. |
| `--accept-license [0\|1]` | `TSSERVER_LICENSE_ACCEPTED` | Set to `1` or `accept` to agree to the server license. | | `--accept-license` | `TSSERVER_LICENSE_ACCEPTED` | Use the --accept-license flag or set the environment variable to 1 or accept to confirm that you have read and accepted the server license agreement. |
| `--default-voice-port <port>` | `TSSERVER_DEFAULT_PORT` | Sets the default UDP voice port for the first virtual server (Default: 9987). | | `--default-voice-port <port>` | `TSSERVER_DEFAULT_PORT` | Permanently sets the default UDP voice port for the first virtual server created (Default: 9987). |
--- ---
#### File Transfer #### File Transfer
| Parameter | Environment Variable | Description | | Parameter | Environment Variable | Description |
|----------------------------------|--------------------------------|-----------------------------------------------------------------------------| |-----------------------------------|--------------------------------|--------------------------------------------------------|
| `--filetransfer-port <port>` | `TSSERVER_FILE_TRANSFER_PORT` | The TCP port used for file transfers (Default: 30033). | | | `--filetransfer-port <port>` | `TSSERVER_FILE_TRANSFER_PORT` | The TCP port used for file transfers (Default: 30033). |
--- ---
#### Database #### Database
| Parameter | Environment Variable | Description | | Parameter | Environment Variable | Description |
|----------------------------------|--------------------------------|-----------------------------------------------------------------------------| |----------------------------------|------------------------------------|---------------------------------------------------------------------------------------|
| `--db-plugin <plugin>` | `TSSERVER_DATABASE_PLUGIN` | Specifies the database plugin to use (e.g., `sqlite3`, `mariadb`). | | `--db-plugin <plugin>` | `TSSERVER_DATABASE_PLUGIN` | Specifies the database plugin to use (e.g., `sqlite3`, `mariadb`). |
| `--db-host <host>` | `TSSERVER_DATABASE_HOST` | The hostname or IP address of your database server. | | `--db-host <host>` | `TSSERVER_DATABASE_HOST` | The hostname or IP address of your database server. |
| `--db-port <port>` | `TSSERVER_DATABASE_PORT` | The port used to connect to your database server. | | `--db-port <port>` | `TSSERVER_DATABASE_PORT` | The port used to connect to your database server. |
@@ -40,16 +39,17 @@ This document provides a detailed list of frequently used command-line parameter
| `--db-username <user>` | `TSSERVER_DATABASE_USERNAME` | The username for database authentication. | | `--db-username <user>` | `TSSERVER_DATABASE_USERNAME` | The username for database authentication. |
| `--db-password <pass>` | `TSSERVER_DATABASE_PASSWORD` | The password for database authentication. | | `--db-password <pass>` | `TSSERVER_DATABASE_PASSWORD` | The password for database authentication. |
| `--db-connections <num>` | `TSSERVER_DATABASE_CONNECTIONS` | Number of connections to establish to the database (Default: 10). | | `--db-connections <num>` | `TSSERVER_DATABASE_CONNECTIONS` | Number of connections to establish to the database (Default: 10). |
| `--db-sql-create-path <path>` | `TSSERVER_DATABASE_SQL_CREATE_PATH`| The path for the database creation scripts (e.g., `create_mariadb`, `create_sqlite`). |
--- ---
#### Server Query #### Server Query
| Parameter | Environment Variable | Description | | Parameter | Environment Variable | Description |
|----------------------------------|----------------------------------|-------------------------------------------------------------------------| |---------------------------------|----------------------------------|-----------------------------------------------------------------------------|
| `--query-http-enable [0\|1]` | `TSSERVER_QUERY_HTTP_ENABLED` | Enables the HTTP query interface. | | `--query-http-enable` | `TSSERVER_QUERY_HTTP_ENABLED` | Enables the HTTP query interface. |
| `--query-http-port <port>` | `TSSERVER_QUERY_HTTP_PORT` | The port for the HTTP query interface (Default: 10080). | | `--query-http-port <port>` | `TSSERVER_QUERY_HTTP_PORT` | The port for the HTTP query interface (Default: 10080). |
| `--query-ssh-enable [0\|1]` | `TSSERVER_QUERY_SSH_ENABLED` | Enables the SSH query interface. | | `--query-ssh-enable` | `TSSERVER_QUERY_SSH_ENABLED` | Enables the SSH query interface. |
| `--query-ssh-port <port>` | `TSSERVER_QUERY_SSH_PORT` | The port for the SSH query interface (Default: 10022). | | `--query-ssh-port <port>` | `TSSERVER_QUERY_SSH_PORT` | The port for the SSH query interface (Default: 10022). |
| `--query-admin-password <pass>` | `TSSERVER_QUERY_ADMIN_PASSWORD` | Sets a password for the serveradmin query account, overriding the database. | | `--query-admin-password <pass>` | `TSSERVER_QUERY_ADMIN_PASSWORD` | Sets a password for the serveradmin query account, overriding the database. |
| `--query-ip-allow-list <file>` | `TSSERVER_QUERY_ALLOW_LIST` | Path to a file listing IPs exempt from query flood protection. | | `--query-ip-allow-list <file>` | `TSSERVER_QUERY_ALLOW_LIST` | Path to a file listing IPs exempt from query flood protection. |
@@ -133,264 +133,404 @@ server:
private-key: "" private-key: ""
``` ```
### Further Options ### Further Parameters and Environment Variables
#### General Options #### General Options
- **`-h, --help`** * **`-h, --help`**
- Prints the help message and exits.
- **`--write-config-file`** * Prints the help message and exits.
- Writes the current configuration to the config file. * **Type:** `BOOLEAN FLAG`
- **`--config-file [tsserver.yaml]`** * **`--accept-license`**
- Configuration file to load.
- **Environment Variable:** `TSSERVER_CONFIG_FILE`
- **`-v, --version`** * Confirms you have read and accepted the server license agreement.
- Displays program version information and exits. * **Type:** `BOOLEAN FLAG`
* **Environment Variable:** `TSSERVER_LICENSE_ACCEPTED`
- **`--license-path [.]`** * **`--write-config-file`**
- Path where the server will look for the server license.
- **Environment Variable:** `TSSERVER_LICENSE_PATH` * Writes the current configuration to the config file.
* **Type:** `BOOLEAN FLAG`
* **`--config-file [tsserver.yaml]`**
* Configuration file to load.
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_CONFIG_FILE`
* **`-v, --version`**
* Displays program version information and exits.
* **Type:** `BOOLEAN FLAG`
* **`--license-path [.]`**
* Path where the server will look for the server license.
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_LICENSE_PATH`
---
#### Server Configuration #### Server Configuration
- **`--default-voice-port :INT in [1 - 65535] [9987]`** * **`--default-voice-port [9987]`**
- Sets the default voice port for the first virtual server.
- **Environment Variable:** `TSSERVER_DEFAULT_PORT`
- **`--voice-ip [[0.0.0.0,::]]`** * Permanently sets the default voice port for the first virtual server created.
- IP address for the server to bind the voice port to. * **Type:** `INTEGER in [1 - 65535]`
- **Environment Variable:** `TSSERVER_VOICE_IP` * **Environment Variable:** `TSSERVER_DEFAULT_PORT`
- **`--machine-id`** * **`--voice-ip [[0.0.0.0,::]]`**
- A string to distinguish this instance from other instances using the same database.
- **Environment Variable:** `TSSERVER_MACHINE_ID`
- **`--threads-voice-udp :UINT in [1 - 16] [5]`** * IP address for the server to bind the voice port to.
- Number of threads to use for voice processing. * **Type:** `STRING`
- **Environment Variable:** `TSSERVER_VOICE_UDP_THREADS` * **Environment Variable:** `TSSERVER_VOICE_IP`
* **`--machine-id`**
* A string to distinguish this instance from other instances using the same database.
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_MACHINE_ID`
* **`--threads-voice-udp [5]`**
* Number of threads to use for voice processing.
* **Type:** `INTEGER in [1 - 16]`
* **Environment Variable:** `TSSERVER_VOICE_UDP_THREADS`
---
#### Logging #### Logging
- **`--log-path [logs]`** * **`--log-path [logs]`**
- Path to the directory where log files are stored.
- **Environment Variable:** `TSSERVER_LOG_PATH`
- **`--log-append [0]`** * Path to the directory where log files are stored.
- Write one ever-growing log file per virtual server. * **Type:** `STRING`
- **Environment Variable:** `TSSERVER_APPEND_LOGS` * **Environment Variable:** `TSSERVER_LOG_PATH`
* **`--log-append`**
* Write one ever-growing log file per virtual server.
* **Type:** `BOOLEAN FLAG`
* **Environment Variable:** `TSSERVER_APPEND_LOGS`
---
#### Virtual Server Management #### Virtual Server Management
- **`--no-default-virtual-server [0]`** * **`--no-default-virtual-server`**
- If specified, no default server is created even if no server exists in the database.
- **Environment Variable:** `TSSERVER_NO_DEFAULT_SERVER` * If specified, no default server is created even if no server exists in the database.
* **Type:** `BOOLEAN FLAG`
* **Environment Variable:** `TSSERVER_NO_DEFAULT_SERVER`
---
#### File Transfer #### File Transfer
- **`--filetransfer-port :INT in [1 - 65535] [30033]`** * **`--filetransfer-port [30033]`**
- Port on which to listen for file transfer connections.
- **Environment Variable:** `TSSERVER_FILE_TRANSFER_PORT`
- **`--filetransfer-ip [[0.0.0.0,::]]`** * Port on which to listen and advertise for file transfer connections.
- Address on which to listen for file transfer connections. * **Type:** `INTEGER in [1 - 65535]`
- **Environment Variable:** `TSSERVER_FILE_TRANSFER_IP` * **Environment Variable:** `TSSERVER_FILE_TRANSFER_PORT`
* **Docker Note:** When running inside a Docker container, ensure that the **internal container port matches the external host port**. File transfers rely on clients connecting directly to this port, mismatches between the container's listening port and the published port will cause connectivity issues.
* `--filetransfer-ip [[0.0.0.0,::]]`
* The address on which to listen for file transfer connections
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_FILE_TRANSFER_IP`
---
#### Database Configuration #### Database Configuration
- **`--clear-database [0]`** * **`--clear-database`**
- **WARNING:** If present, the database is reset to default, and all servers, clients, etc., are lost!
- **`--no-permission-update [0]`** * ⚠️ WARNING: Resets the database completely (deletes all servers, clients, etc.).
- Do not apply permission changes with a server update. * **Type:** `BOOLEAN FLAG`
- **Environment Variable:** `TSSERVER_SKIP_PERMISSION_UPDATE`
- **`--db-plugin [sqlite3]`** * **`--no-permission-update`**
- Specifies which database plugin to use.
- **Environment Variable:** `TSSERVER_DATABASE_PLUGIN`
- **`--db-sql-path [sql]`** * Do not apply permission changes during server updates.
- Path to the SQL folder containing the SQL queries executed by the server. * **Type:** `BOOLEAN FLAG`
- **Environment Variable:** `TSSERVER_DATABASE_SQL_PATH` * **Environment Variable:** `TSSERVER_SKIP_PERMISSION_UPDATE`
- **`--db-sql-create-path [create_sqlite]`** * **`--db-plugin [sqlite3]`**
- Path relative to the `--sql-path` where to load the database creation scripts from.
- **Environment Variable:** `TSSERVER_DATABASE_SQL_CREATE_PATH`
- **`--db-client-keep-days [30]`** * Specifies the database plugin to use.
- Number of days to keep clients in the database. * **Type:** `STRING`
- **Environment Variable:** `TSSERVER_DATABASE_CLIENT_KEEP_DAYS` * **Environment Variable:** `TSSERVER_DATABASE_PLUGIN`
#### Advanced Database Configuration * **`--db-sql-path [sql]`**
- **`--db-skip-integrity-check [0]`** * Path to folder containing SQL queries used by the server.
- SQLite only: Skip the database integrity check when opening the database. * **Type:** `STRING`
- **Environment Variable:** `TSSERVER_DATABASE_SKIP_INTEGRITY_CHECK` * **Environment Variable:** `TSSERVER_DATABASE_SQL_PATH`
- **`--db-host [127.0.0.1]`** * **`--db-sql-create-path [create_sqlite]`**
- Hostname/IP address to use when connecting to the database server.
- **Environment Variable:** `TSSERVER_DATABASE_HOST`
- **`--db-port :INT in [1 - 65535] [5432]`** * Subdirectory in SQL path to use for DB creation scripts.
- Port to use when connecting to the database server. * **Type:** `STRING`
- **Environment Variable:** `TSSERVER_DATABASE_PORT` * **Environment Variable:** `TSSERVER_DATABASE_SQL_CREATE_PATH`
- **`--db-socket`** * **`--db-client-keep-days [30]`**
- Socket to use for the database connection.
- **Environment Variable:** `TSSERVER_DATABASE_SOCKET`
- **`--db-timeout :INT in [1 - 432000] [10]`** * Number of days to keep clients in the database.
- Timeout in seconds for the database connection. * **Type:** `INTEGER`
- **Environment Variable:** `TSSERVER_DATABASE_TIMEOUT` * **Environment Variable:** `TSSERVER_DATABASE_CLIENT_KEEP_DAYS`
- **`--db-name [teamspeak]`** * **`--db-skip-integrity-check`**
- The database name to use.
- **Environment Variable:** `TSSERVER_DATABASE_NAME`
- **`--db-username`** * SQLite only: skip DB integrity check at startup.
- The username to use for database authentication. * **Type:** `BOOLEAN FLAG`
- **Environment Variable:** `TSSERVER_DATABASE_USERNAME` * **Environment Variable:** `TSSERVER_DATABASE_SKIP_INTEGRITY_CHECK`
- **`--db-password`** * **`--db-log-queries`**
- The password to use for database authentication.
- **Environment Variable:** `TSSERVER_DATABASE_PASSWORD`
- **`--db-connections :INT in [2 - 100] [10]`** * Enable logging of SQL queries.
- Number of connections to establish to the database. * **Type:** `BOOLEAN FLAG`
- **Environment Variable:** `TSSERVER_DATABASE_CONNECTIONS` * **Environment Variable:** `TSSERVER_DATABASE_LOG_QUERIES`
- **`--db-log-queries [0]`** #### Database Connection Options
- Whether to log database queries. * **`--db-host [127.0.0.1]`**
- **Environment Variable:** `TSSERVER_DATABASE_LOG_QUERIES`
* Database hostname or IP.
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_DATABASE_HOST`
* **`--db-port [5432]`**
* Database port.
* **Type:** `INTEGER in [1 - 65535]`
* **Environment Variable:** `TSSERVER_DATABASE_PORT`
* **`--db-socket`**
* Socket file to use for database connection.
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_DATABASE_SOCKET`
* **`--db-timeout [10]`**
* Timeout in seconds when connecting to DB.
* **Type:** `INTEGER in [1 - 432000]`
* **Environment Variable:** `TSSERVER_DATABASE_TIMEOUT`
* **`--db-name [teamspeak]`**
* Name of the database to use.
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_DATABASE_NAME`
* **`--db-username`**
* The username to use for database authentication.
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_DATABASE_USERNAME`
* **`--db-password`**
* The password to use for database authentication.
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_DATABASE_PASSWORD`
* **`--db-connections [10]`**
* Number of connections to establish to the database.
* **Type:** `INTEGER in [2 - 100]`
* **Environment Variable:** `TSSERVER_DATABASE_CONNECTIONS`
---
#### Query Options #### Query Options
- **`--query-pool-size :UINT in [2 - 32] [2]`** * **`--query-pool-size [2]`**
- Number of threads to use for query command processing.
- **Environment Variable:** `TSSERVER_QUERY_POOL_SIZE`
- **`--query-log-timing :INT in [10 - 31556952] [3600]`** * How many threads to use for query command processing.
- Interval in seconds after which to log query statistics. * **Type:** `INTEGER in [2 - 32]`
- **Environment Variable:** `TSSERVER_QUERY_LOG_TIMING` * **Environment Variable:** `TSSERVER_QUERY_POOL_SIZE`
- **`--query-ip-allow-list [query_ip_allowlist.txt]`** * **`--query-log-timing [3600]`**
- File path to a file which lists the addresses that are exempt from query flood protection.
- **Environment Variable:** `TSSERVER_QUERY_ALLOW_LIST`
- **`--query-ip-block-list [query_ip_denylist.txt]`** * Interval in seconds after which to log query statistics.
- File path to a file which lists the addresses that are blocked from the query interface. * **Type:** `INTEGER in [10 - 31556952]`
- **Environment Variable:** `TSSERVER_QUERY_DENY_LIST` * **Environment Variable:** `TSSERVER_QUERY_LOG_TIMING`
- **`--query-admin-password`** * **`--query-ip-allow-list [query_ip_allowlist.txt]`**
- Override the query password for the built-in serveradmin account.
- **Environment Variable:** `TSSERVER_QUERY_ADMIN_PASSWORD`
- **`--query-log-commands [0]`** * File path listing IPs exempt from query flood protection.
- If specified, every command received on the query interface will be logged. * **Type:** `STRING`
- **Environment Variable:** `TSSERVER_QUERY_LOG_COMMANDS` * **Environment Variable:** `TSSERVER_QUERY_ALLOW_LIST`
- **`--query-skip-brute-force-check [0]`** * **`--query-ip-block-list [query_ip_denylist.txt]`**
- Skips brute force checking when clients connect to the query interface.
- **Environment Variable:** `TSSERVER_QUERY_SKIP_BRUTE_FORCE_CHECK`
- **`--query-buffer-mb :INT in [20 - 100] [20]`** * File path listing IPs blocked from the query interface.
- Memory allocation for query connection buffering. * **Type:** `STRING`
- **Environment Variable:** `TSSERVER_QUERY_BUFFER_MB` * **Environment Variable:** `TSSERVER_QUERY_DENY_LIST`
- **`--query-documentation-path [serverquerydocs]`** * **`--query-admin-password`**
- Path to the query documentation files.
- **Environment Variable:** `TSSERVER_QUERY_DOCUMENTATION_PATH`
- **`--query-timeout [300]`** * Override the query password for the built-in serveradmin account.
- Specifies the timeout for query connections. * **Type:** `STRING`
- **Environment Variable:** `TSSERVER_QUERY_TIMEOUT` * **Environment Variable:** `TSSERVER_QUERY_ADMIN_PASSWORD`
* **`--query-log-commands`**
* Log every command received on the query interface.
* **Type:** `BOOLEAN FLAG`
* **Environment Variable:** `TSSERVER_QUERY_LOG_COMMANDS`
* **`--query-skip-brute-force-check`**
* Skip brute force checking on query interface connections.
* **Type:** `BOOLEAN FLAG`
* **Environment Variable:** `TSSERVER_QUERY_SKIP_BRUTE_FORCE_CHECK`
* **`--query-buffer-mb [20]`**
* How much memory (in MB) to allocate for query connection buffering.
* **Type:** `INTEGER in [20 - 100]`
* **Environment Variable:** `TSSERVER_QUERY_BUFFER_MB`
* **`--query-documentation-path [serverquerydocs]`**
* Path to the query documentation files.
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_QUERY_DOCUMENTATION_PATH`
* **`--query-timeout [300]`**
* Timeout in seconds before query connections expire.
* **Type:** `INTEGER`
* **Environment Variable:** `TSSERVER_QUERY_TIMEOUT`
---
#### Query SSH Options #### Query SSH Options
- **`--query-ssh-enable [0]`** * **`--query-ssh-enable`**
- Enable the SSH query interface.
- **Environment Variable:** `TSSERVER_QUERY_SSH_ENABLED`
- **`--query-ssh-port :INT in [1 - 65535] [10022]`** * Enable the SSH query interface.
- Port on which to listen for SSH query connections. * **Type:** `BOOLEAN FLAG`
- **Environment Variable:** `TSSERVER_QUERY_SSH_PORT` * **Environment Variable:** `TSSERVER_QUERY_SSH_ENABLED`
- **`--query-ssh-ip [[0.0.0.0,::]]`** * **`--query-ssh-port [10022]`**
- Address on which to listen for SSH query connections.
- **Environment Variable:** `TSSERVER_QUERY_SSH_IP`
- **`--query-ssh-rsa-key [ssh_host_rsa_key]`** * Port on which to listen for SSH query connections.
- The SSH RSA host key to use. * **Type:** `INTEGER in [1 - 65535]`
- **Environment Variable:** `TSSERVER_QUERY_SSH_RSA_KEY` * **Environment Variable:** `TSSERVER_QUERY_SSH_PORT`
* **`--query-ssh-ip [[0.0.0.0,::]]`**
* Address to listen on for SSH query connections.
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_QUERY_SSH_IP`
* **`--query-ssh-rsa-key [ssh_host_rsa_key]`**
* Path to the SSH RSA host key file.
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_QUERY_SSH_RSA_KEY`
---
#### Query HTTP Options #### Query HTTP Options
- **`--query-http-enable [0]`** * **`--query-http-enable`**
- Enable the HTTP query interface.
- **Environment Variable:** `TSSERVER_QUERY_HTTP_ENABLED`
- **`--query-http-port :INT in [1 - 65535] [10080]`** * Enable the HTTP query interface.
- Port on which to listen for Web Query connections. * **Type:** `BOOLEAN FLAG`
- **Environment Variable:** `TSSERVER_QUERY_HTTP_PORT` * **Environment Variable:** `TSSERVER_QUERY_HTTP_ENABLED`
- **`--query-http-ip [[0.0.0.0,::]]`** * **`--query-http-port [10080]`**
- Address on which to listen for Web Query connections.
- **Environment Variable:** `TSSERVER_QUERY_HTTP_IP` * Port on which to listen for Web Query connections.
* **Type:** `INTEGER in [1 - 65535]`
* **Environment Variable:** `TSSERVER_QUERY_HTTP_PORT`
* **`--query-http-ip [[0.0.0.0,::]]`**
* Address to listen on for Web Query connections.
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_QUERY_HTTP_IP`
---
#### Query HTTPS Options #### Query HTTPS Options
- **`--query-https-enable [0]`** * **`--query-https-enable`**
- Enable the HTTPS query interface.
- **Environment Variable:** `TSSERVER_QUERY_HTTPS_ENABLED`
- **`--query-https-port :INT in [1 - 65535] [10443]`** * Enable the HTTPS query interface.
- Port on which to listen for secure Web Query connections. * **Type:** `BOOLEAN FLAG`
- **Environment Variable:** `TSSERVER_QUERY_HTTPS_PORT` * **Environment Variable:** `TSSERVER_QUERY_HTTPS_ENABLED`
- **`--query-https-ip [[0.0.0.0,::]]`** * **`--query-https-port [10443]`**
- Address on which to listen for secure Web Query connections.
- **Environment Variable:** `TSSERVER_QUERY_HTTPS_IP`
- **`--query-https-certificate`** * Port on which to listen for secure Web Query connections.
- File containing the certificate for secure Web Query connections. * **Type:** `INTEGER in [1 - 65535]`
- **Environment Variable:** `TSSERVER_QUERY_HTTPS_CERT` * **Environment Variable:** `TSSERVER_QUERY_HTTPS_PORT`
- **`--query-https-private-key`** * **`--query-https-ip [[0.0.0.0,::]]`**
- File containing the private key for the certificate.
- **Environment Variable:** `TSSERVER_QUERY_HTTPS_PRIVATE_KEY` * Address to listen on for secure Web Query connections.
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_QUERY_HTTPS_IP`
* **`--query-https-certificate`**
* Path to certificate file for HTTPS Web Query.
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_QUERY_HTTPS_CERT`
* **`--query-https-private-key`**
* Path to private key file used with the certificate.
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_QUERY_HTTPS_PRIVATE_KEY`
---
#### Additional Options #### Additional Options
- **`--http-proxy`** * **`--http-proxy`**
- Proxy server for connecting to external services.
- **Environment Variable:** `TSSERVER_HTTP_PROXY`
- **`--accept-license [0]`** * Proxy server used for external connections.
- Confirms you have read and accepted the server license agreement. * **Type:** `STRING`
- **Environment Variable:** `TSSERVER_LICENSE_ACCEPTED` * **Environment Variable:** `TSSERVER_HTTP_PROXY`
- **`--crashdump-path [crashdumps]`** * **`--crashdump-path [crashdumps]`**
- Path to store crash dumps.
- **Environment Variable:** `TSSERVER_CRASHDUMP_PATH`
- **`--daemon [0]`** * Path where crash dumps should be written.
- Run the server in the background. * **Type:** `STRING`
- **Environment Variable:** `TSSERVER_DAEMON` * **Environment Variable:** `TSSERVER_CRASHDUMP_PATH`
- **`--pid-file`** * **`--daemon`**
- File to store the process ID of the server.
- **Environment Variable:** `TSSERVER_PID_FILE`
- **`--hints-enabled [0]`** * Run the server in the background (daemon mode).
- Enable permission hints (may affect performance on larger servers). * **Type:** `BOOLEAN FLAG`
- **Environment Variable:** `TSSERVER_HINTS_ENABLED` * **Environment Variable:** `TSSERVER_DAEMON`
- **`--maxmind-db-path`** * **`--pid-file`**
- Path to the MaxMind IP database.
- **Environment Variable:** `TSSERVER_MAXMIND_DB_PATH`
- **`--administrative-domain`** * File to write the process ID to.
- Administrative domain. * **Type:** `STRING`
- **Environment Variable:** `TSSERVER_ADMINISTRATIVE_DOMAIN` * **Environment Variable:** `TSSERVER_PID_FILE`
* **`--hints-enabled`**
* Enable permission hints (can impact performance on large servers).
* **Type:** `BOOLEAN FLAG`
* **Environment Variable:** `TSSERVER_HINTS_ENABLED`
* **`--maxmind-db-path`**
* Path to the MaxMind GeoIP database.
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_MAXMIND_DB_PATH`
* **`--administrative-domain`**
* Administrative domain for internal or regulatory identification.
* **Type:** `STRING`
* **Environment Variable:** `TSSERVER_ADMINISTRATIVE_DOMAIN`
+6 -4
View File
@@ -19,6 +19,8 @@ Tried & tested for nearly 25 years, we have a solution that fits everyone's need
**Limitations:** Please note that **TeamSpeak 3 Server licenses are not compatible** with TeamSpeak 6 Servers, and currently, there is **no migration path available between the two versions**. **Limitations:** Please note that **TeamSpeak 3 Server licenses are not compatible** with TeamSpeak 6 Servers, and currently, there is **no migration path available between the two versions**.
**Preview License:** In response to your feedback, the server now comes with a **temporary** 32-slot preview license to offer greater flexibility during the evaluation period. Please note that this license is **only valid for two months**.
Additionally, it is **not yet possible to obtain or upgrade to a larger license for TeamSpeak 6**. Additionally, it is **not yet possible to obtain or upgrade to a larger license for TeamSpeak 6**.
We truly appreciate your patience and understanding as we continue to work on solutions to better support your needs in the future. We truly appreciate your patience and understanding as we continue to work on solutions to better support your needs in the future.
@@ -55,7 +57,7 @@ chmod +x tsserver
Run the server from your terminal, making sure to accept the license: Run the server from your terminal, making sure to accept the license:
```sh ```sh
./tsserver --accept-license=accept ./tsserver --accept-license
``` ```
<h2><img width="22" src="/icons/windows.svg">&nbsp;On Windows:</h2> <h2><img width="22" src="/icons/windows.svg">&nbsp;On Windows:</h2>
@@ -64,7 +66,7 @@ Open Command Prompt or PowerShell and navigate to the directory where you extrac
Run the server executable, making sure to accept the license: Run the server executable, making sure to accept the license:
```powershell ```powershell
tsserver.exe --accept-license=accept tsserver.exe
``` ```
<h2><img width="32" src="/icons/docker.svg">&nbsp;Running the Server with Docker (Recommended):</h2> <h2><img width="32" src="/icons/docker.svg">&nbsp;Running the Server with Docker (Recommended):</h2>
@@ -72,7 +74,7 @@ Docker is the easiest way to run the TeamSpeak 6 server in an isolated and manag
### 1. Simple docker run command: ### 1. Simple docker run command:
For a quick start, you can use the docker run command. Make sure your licensekey.dat is in your current directory. For a quick start, you can use the docker run command.
```sh ```sh
docker run -it --rm \ docker run -it --rm \
@@ -88,7 +90,7 @@ This is the best practice for a server you intend to keep running. Create a dock
```yaml ```yaml
services: services:
teamspeak: teamspeak:
image: teamspeaksystems/teamspeak6-server:v6.0.0-beta2 image: teamspeaksystems/teamspeak6-server:latest
container_name: teamspeak-server container_name: teamspeak-server
restart: unless-stopped restart: unless-stopped
ports: ports: