Environment variables (#331)

* 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

tor-relay/Dockerfile

@@ -31,6 +31,16 @@ COPY torrc.bridge /etc/tor/torrc.bridge
 COPY torrc.middle /etc/tor/torrc.middle
 COPY torrc.exit /etc/tor/torrc.exit
 
+# copy the run script
+COPY run.sh /run.sh
+RUN chmod u+rwx /run.sh
+
+# default environment variables
+ENV RELAY_NICKNAME hacktheplanet
+ENV RELAY_TYPE middle
+ENV RELAY_BANDWIDTH_RATE 100 KBytes
+ENV RELAY_BANDWIDTH_BURST 200 KBytes
+
 # make sure files are owned by tor user
 RUN chown -R tor /etc/tor
 
@@ -40,4 +50,4 @@ RUN mkdir /var/lib/tor/.tor
 VOLUME /var/lib/tor/.tor
 RUN chown -R tor /var/lib/tor/.tor
 
-ENTRYPOINT [ "tor" ]
+ENTRYPOINT [ "/run.sh" ]

tor-relay/README.md

@@ -0,0 +1,11 @@
+ ### 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    |

tor-relay/run.sh

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+for relaytype in bridge middle exit; do
+  sed -i 's/${RELAY_NICKNAME}/'"$RELAY_NICKNAME"'/g' "/etc/tor/torrc.$relaytype"
+  sed -i 's/${CONTACT_GPG_FINGERPRINT}/'"$CONTACT_GPG_FINGERPRINT"'/g' "/etc/tor/torrc.$relaytype"
+  sed -i 's/${CONTACT_NAME}/'"$CONTACT_NAME"'/g' "/etc/tor/torrc.$relaytype"
+  sed -i 's/${CONTACT_EMAIL}/'"$CONTACT_EMAIL"'/g' "/etc/tor/torrc.$relaytype"
+  sed -i 's/${RELAY_BANDWIDTH_RATE}/'"$RELAY_BANDWIDTH_RATE"'/g' "/etc/tor/torrc.$relaytype"
+  sed -i 's/${RELAY_BANDWIDTH_BURST}/'"$RELAY_BANDWIDTH_BURST"'/g' "/etc/tor/torrc.$relaytype"
+done
+
+tor -f /etc/tor/torrc.${RELAY_TYPE}

tor-relay/torrc.bridge

@@ -97,7 +97,7 @@ ORPort 9001
 # OutboundBindAddress 10.0.0.5
 
 ## A handle for your relay, so people don't have to refer to it by key.
-Nickname hacktheplanet
+Nickname ${RELAY_NICKNAME}
 
 ## Define these to limit how much relayed traffic you will allow. Your
 ## own traffic is still unthrottled. Note that RelayBandwidthRate must
@@ -107,6 +107,8 @@ Nickname hacktheplanet
 ## 2^20, etc.
 #RelayBandwidthRate 100 KBytes  # Throttle traffic to 100KB/s (800Kbps)
 #RelayBandwidthBurst 200 KBytes # But allow bursts up to 200KB (1600Kb)
+RelayBandwidthRate ${RELAY_BANDWIDTH_RATE}
+RelayBandwidthBurst ${RELAY_BANDWIDTH_BURST}
 
 ## Use these to restrict the maximum traffic per day, week, or month.
 ## Note that this threshold applies separately to sent and received bytes,

tor-relay/torrc.exit

@@ -97,7 +97,7 @@ ORPort 9001
 # OutboundBindAddress 10.0.0.5
 
 ## A handle for your relay, so people don't have to refer to it by key.
-Nickname hacktheplanet
+Nickname ${RELAY_NICKNAME}
 
 ## Define these to limit how much relayed traffic you will allow. Your
 ## own traffic is still unthrottled. Note that RelayBandwidthRate must
@@ -107,6 +107,8 @@ Nickname hacktheplanet
 ## 2^20, etc.
 #RelayBandwidthRate 100 KBytes  # Throttle traffic to 100KB/s (800Kbps)
 #RelayBandwidthBurst 200 KBytes # But allow bursts up to 200KB (1600Kb)
+RelayBandwidthRate ${RELAY_BANDWIDTH_RATE}
+RelayBandwidthBurst ${RELAY_BANDWIDTH_BURST}
 
 ## Use these to restrict the maximum traffic per day, week, or month.
 ## Note that this threshold applies separately to sent and received bytes,

tor-relay/torrc.middle

@@ -97,7 +97,7 @@ ORPort 9001
 # OutboundBindAddress 10.0.0.5
 
 ## A handle for your relay, so people don't have to refer to it by key.
-Nickname hacktheplanet
+Nickname ${RELAY_NICKNAME}
 
 ## Define these to limit how much relayed traffic you will allow. Your
 ## own traffic is still unthrottled. Note that RelayBandwidthRate must
@@ -107,6 +107,8 @@ Nickname hacktheplanet
 ## 2^20, etc.
 #RelayBandwidthRate 100 KBytes  # Throttle traffic to 100KB/s (800Kbps)
 #RelayBandwidthBurst 200 KBytes # But allow bursts up to 200KB (1600Kb)
+RelayBandwidthRate ${RELAY_BANDWIDTH_RATE}
+RelayBandwidthBurst ${RELAY_BANDWIDTH_BURST}
 
 ## Use these to restrict the maximum traffic per day, week, or month.
 ## Note that this threshold applies separately to sent and received bytes,