golovanovsv/torgate repository overview

⁠About

Container with TOR⁠ software which can work as socks-proxy, relay or exit node. By default socks-proxy listen on 9150/tcp port. Dockerfile and entrypoint script available in github⁠.

⁠Configure

Container configured by next environment variables:

• HEARTBEATPERIOD. Log a heartbeat message every HeartbeatPeriod seconds. This is a log level notice message, designed to let you know your Tor server is still alive and doing useful things. Settings this to 0 will disable the heartbeat. Default: 30 minutes
• SOCKSPORT. Port to listen for connections from SOCKS-speaking applications. Default: 9150
• RELAYPORT. Enable TOR-relay on defined port. Default: none.
• EXITNODE. Enable exit relay. Default: none.
• NICKNAME. Set Nickname for tor-node (from 3.4.8 tag). Default: Unnamed.
• CONTROLPORT. Set ControlPort for tor-node. Default: none. (from 3.4.8 tag)
• HASHEDCONTROLPASSWORD. Set ControlPassword for tor-node. Default: none. (from 3.4.8 tag)

CONTROLPORT and HASHEDCONTROLPASSWORD must be used together!

⁠How to start socks-proxy only

$ docker run -d --name <container name> \
    -p 9150:9150 \
golovanovsv/torgate

⁠How to start socks-proxy only with custom proxy port

$ docker run -d --name <container name> \ 
    -e "SOCKSPORT=8080" \
    -p 8080:8080 \
golovanovsv/torgate

⁠How to start TOR-relay

$ docker run -d --name <container name> \
    -e "RELAYPORT=9100" \
    -p 9100:9100 \
    -p 9150:9150 \
golovanovsv/torgate

⁠How to start Exit relay

$ docker run -d --name <container name> \
    -e "RELAYPORT=9100" \
    -e "EXITNODE=yes" \
    -p 9100:9100 \
    -p 9150:9150 \
golovanovsv/torgate

⁠How to enable control port

$ docker run -d --name <container name> \
    -e "CONTROLPORT=9151" \
    -e "HASHEDCONTROLPASSWORD=<your password hash>" \
golovanovsv/torgate