diff options
| author | Paolo Asperti <[email protected]> | 2022-09-05 20:30:50 +0200 |
|---|---|---|
| committer | Paolo Asperti <[email protected]> | 2022-11-24 22:52:56 +0100 |
| commit | 29b45dddb455be6501cb58b2c82abeaaa8c95bad (patch) | |
| tree | c6408e6eee515d5d18b38b8181ffc83f7655369b /README.md | |
| parent | 650f2410ed0133a1527619dbb1ca34be071ad666 (diff) | |
| download | rustdesk-server-29b45dddb455be6501cb58b2c82abeaaa8c95bad.tar.gz rustdesk-server-29b45dddb455be6501cb58b2c82abeaaa8c95bad.zip | |
env variables doc
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 26 insertions, 3 deletions
@@ -173,16 +173,14 @@ services: restart: unless-stopped ``` -We use these environment variables: +For this container image, you can use these environment variables, **in addition** to the ones specified in the following **ENV variables** section: | variable | optional | description | | --- | --- | --- | | RELAY | no | the IP address/DNS name of the machine running this container | | ENCRYPTED_ONLY | yes | if set to **"1"** unencrypted connection will not be accepted | -| DB_URL | yes | path for database file | | KEY_PUB | yes | public part of the key pair | | KEY_PRIV | yes | private part of the key pair | -| RUST_LOG | yes | set debug level (error|warn|info|debug|trace) | ### Secret management in S6-overlay based images @@ -316,3 +314,28 @@ These packages are meant for the following distributions: - Ubuntu 18.04 LTS - Debian 11 bullseye - Debian 10 buster + +## ENV variables + +hbbs and hbbr can be configured using these ENV variables. +You can specify the variables as usual or use an `.env` file. + +| variable | binary | description | +| --- | --- | --- | +| ALWAYS_USE_RELAY | hbbs | if set to **"Y"** disallows direct peer connection | +| DB_URL | hbbs | path for database file | +| DOWNGRADE_START_CHECK | hbbr | delay (in seconds) before downgrade check | +| DOWNGRADE_THRESHOLD | hbbr | threshold of downgrade check (bit/ms) | +| KEY | hbbs/hbbr | if set force the use of a specific key, if set to **"_"** force the use of any key | +| LIMIT_SPEED | hbbr | speed limit (in Mb/s) | +| LOCAL_IP | hbbs | hbbs IP address used in hole-punching | +| MASK | hbbs | network+mask of LAN IPs | +| PORT | hbbs/hbbr | listening port (21116 for hbbs - 21117 for hbbr) | +| RELAY_SERVERS | hbbs | IP address/DNS name of the machines running hbbr (separated by comma) | +| RENDEZVOUS_SERVERS | hbbs | IP address/DNS name of the machines running hbbs (separated by comma) | +| RMEM | hbbs | UDP recv buffer size | +| RUST_LOG | all | set debug level (error|warn|info|debug|trace) | +| SINGLE_BANDWIDTH | hbbr | max bandwidth for a single connection (in Mb/s) | +| SOFTWARE_URL hbbs | hbbs | download url of RustDesk newest version | +| TEST_HBBS | hbbs | IP address of hbbs for avoiding udp socket failure error | +| TOTAL_BANDWIDTH | hbbr | max total bandwidth (in Mb/s) | |