dockerfiles/tor-relay/README.md

13 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

### 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 |
| **RELAY_PORT** | Default port used for incoming Tor connections (ORPort) | 9001 |