Update and enable Bridge functions.

Author: FoRTu

Dockerfile

@@ -1,12 +1,13 @@
 FROM debian:stable-slim
 
 LABEL maintainer="FoRTu" \
-maintainer.website="https://github.com/FoRTu"
+maintainer.ebail="me@fortu.io" \
+maintainer.website="https://github.com/FoRTu/docker-tor-relay"
 
-# Install Updates + tor + tor-arm:
+# Install Updates + tor + tor-arm + obfs4proxy + curl:
 RUN apt update && \
 apt upgrade -y && \
-apt -y install tor tor-arm && \
+apt -y install tor tor-arm obfs4proxy curl && \
 apt-get -y autoclean && \
 apt-get -y autoremove && \
 apt-get -y purge --auto-remove && \
@@ -19,7 +20,11 @@ rm -rf \
         /var/lib/apt/lists/* \
         /usr/share/doc/*
 
-EXPOSE 9001 9030 9050
+EXPOSE 9001 9030 9050 8024
+
+# Add launcher.sh
+ADD launcher.sh /launcher.sh
+RUN ["chmod", "+x", "/launcher.sh"]
 
 # Command to run on container startup
-CMD ["tor", "-f", "/etc/tor/torrc"]
+CMD ["/launcher.sh"]

README.md

@@ -1,8 +1,35 @@
 # Docker Tor-Relay
-An Docker image of a Tor-Relay based on the latest stable-slim Debian image.
 
-You can build it by [Dockerfile](https://github.com/FoRTu/docker-tor-relay/blob/master/Dockerfile) or just download from Docker Hub [https://hub.docker.com/r/fortu/tor-relay](https://hub.docker.com/r/fortu/tor-relay).
+Docker image based on the latest stable-slim Debian image to run a Tor relay.
 
-I created it for being used on [unRAID](https://unraid.net/) systems, but you know, Docker can be run on any GNU/Linux.
+You can build the image by the [Dockerfile](https://github.com/FoRTu/docker-tor-relay/blob/master/Dockerfile) or just download it from Docker Hub:
 
-Here you are a [torrc](https://github.com/FoRTu/docker-tor-relay/blob/master/torrc) configuration file for the Tor-Relay. You can be used as a template as it is fully functional.
+* [https://hub.docker.com/r/fortu/tor-relay](https://hub.docker.com/r/fortu/tor-relay)
+
+In this repository you will find a template of the requested [`torrc`](https://github.com/FoRTu/docker-tor-relay/blob/master/torrc) configuration file to run `tor`. You can use it as a template or just use as it is. Because is totally functional, but I recommend to customize to make it unique and yours.
+
+## How to create a container from this image
+
+Easy, just run the command below by changing the `torrc` configuration file path:
+
+```bash
+docker run --name='tor-relay' \
+-p '9001:9001/tcp' \
+-p '9030:9030/tcp' \
+-p '9050:9050/tcp' \
+-p '8024:8024/tcp' \
+-v '[PATH OF torrc FILE]':'/etc/tor/':'rw' \
+'fortu/tor-relay'
+```
+
+The launcher inside the container will check if the required `torrc` file exist. This file is necessary to run `tor`. If it doesn't, a template will be download from this git repository. The template itself is totally functional, so in case of run the container for the first time or the `torrc` file doesn't exist because has been deleted, it will be downloaded automatically.
+
+I highly recommend to customize the `torrc` file with you info to make it unique.
+
+Be aware that if you are behind a NAT or Firewall you have to open this  TCP ports:
+
+* 9091/TCP
+* 9030/TCP
+* 8024/TCP
+
+Let's make Internet more anonymous!

launcher.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+ERROR='\033[0;31m'
+WARNING='\033[0;33m'
+GREEN='\033[0;32m'
+MAGENTA='\033[0;35m'
+NC='\033[0m' # No Color
+
+echo -e "\n${MAGENTA}===============================${NC}"
+echo -e "${MAGENTA}      TOR: RELAY + BRIDGE      ${NC}"
+echo -e "${MAGENTA}===============================${NC}\n"
+echo -e " · ${WARNING}Checking if required files exists...${NC}"
+if [ ! -f "/etc/tor/torrc" ]; then
+ echo -e " · ${ERROR}Configuration 'torrc' file not found!${NC}"
+ echo " · Downloading template 'torrc' file..."
+ curl --silent --output "/etc/tor/torrc" \
+ "https://raw.githubusercontent.com/FoRTu/docker-tor-relay/master/torrc"
+ if [ -f "/etc/tor/torrc" ]; then
+  echo -e " · Configuration 'torrc' file has been downloaded. ${WARNING} Please customize the file with your info.${NC}  "
+  echo -e " · ${WARNING}If something in the 'torrc' file isn't right, please open a new issue on https://github.com/FoRTu/docker-tor-relay please.${NC}"
+ else
+  echo -e " · ${ERROR}Something was wrong downloading the 'torrc' configuration file.${NC}"
+  echo -e " · ${ERROR}Go to https://github.com/FoRTu/docker-tor-relay and download by yourself.${NC}"
+  echo -e " · ${WARNING}If something in the 'torrc' file isn't right, please open a new issue on https://github.com/FoRTu/docker-tor-relay please.${NC}"
+  exit 1
+ fi
+else
+ echo -e " · ${GREEN}Everything is right, '/etc/tor/torrc' file exist${NC}"
+fi
+
+# Launch tor
+echo -e "\n\n · ${GREEN}Launching TOR (Relay + Bridge)...${NC}\n"
+tor -f "/etc/tor/torrc"
+

torrc

@@ -17,12 +17,17 @@ SocksPort 0.0.0.0:9050
 Controlport 9051
 CookieAuthentication 1
 
-# Run as a relay only (change policy to enable exit node)
-ExitPolicy reject *:*        # no exits allowed
+# No exits allowed
+ExitPolicy reject *:*
 ExitPolicy reject6 *:*
-ExitRelay 0
 IPv6Exit 0
 
+# Run as a relay and bridge
+ExitRelay 0
+BridgeRelay 1
+ServerTransportPlugin     obfs4 exec /usr/bin/obfs4proxy
+ServerTransportListenAddr obfs4 0.0.0.0:8024
+
 # Set some limits
 
 # Limits the max number of bytes sent and received 
@@ -32,7 +37,9 @@ IPv6Exit 0
 #AccountingStart day 00:00
 
 # Limits the average incoming and outgoing bandwidth
-RelayBandwidthRate 768 KB   # Throttle traffic to
+# Throttle traffic to
+
+RelayBandwidthRate 768 KB   
 
 # Limit the maximum token bucket size (also known as the burst) 
 RelayBandwidthBurst 1024 KB