mirror of
https://github.com/jessfraz/dockerfiles.git
synced 2024-11-23 11:31:49 +01:00
3cdd8ce273
* Adding relay name env variable and env variables description in markdown file * Fixing env variable usage and adding relay type env variable * Adding bandwidth related environment variables
12 lines
1.2 KiB
Markdown
12 lines
1.2 KiB
Markdown
### Environment variables
|
|
|
|
| Name | Description | Default value |
|
|
| ---------------------------- |:----------------------------------------------------------------------------:| -------------:|
|
|
| **RELAY_TYPE** | The type of relay (bridge, middle or exit) | middle |
|
|
| **RELAY_NICKNAME** | The nickname of your relay | hacktheplanet |
|
|
| **CONTACT_GPG_FINGERPRINT** | Your GPG ID or fingerprint | none |
|
|
| **CONTACT_NAME** | Your name | none |
|
|
| **CONTACT_EMAIL** | Your contact email | none |
|
|
| **RELAY_BANDWIDTH_RATE** | Limit how much traffic will be allowed through your relay (must be > 20KB/s) | 100 KBytes |
|
|
| **RELAY_BANDWIDTH_BURST** | Allow temporary bursts up to a certain amount | 200 KBytes |
|