Joshgaby Tor Relay

A Docker image that runs the latest stable Tor relay server so you can donate bandwidth to the Tor network.

  • Network Services
  • Tools & Utilities
A Docker image that runs the latest stable Tor relay server so you can donate bandwidth to the Tor network. It installs the official Tor Debian package and configures it per Tor Project recommendations, runs Tor as an unprivileged regular user for security, and can optionally operate as a hidden bridge using obfs4proxy. Best for homelab users with at least 2 Mbit/s of symmetric bandwidth who want to help make the Tor network faster and more resilient.

Platform availability

Available on 1 of 10 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

18/100 Low

Maintained
0last commit 1475 days ago
Popular
00 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
701 GB minimum RAM

Availability: platform listings confirmed today, links checked 26 days ago

GitHub stars
0
Open issues
2
Last commit
2022-11-07
License
MIT
Activity
stale

Checked 8 days ago - source: GitHub (josh-gaby/tor-server)

Resources & Compatibility

Minimum requirements: 1 GB RAM. ARM (e.g. Raspberry Pi) is not supported.

Checked 54 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Installation and configuration Create an appdata/tor-data/config folder to persist the relay configuration between restarts. Download the sample torrc file from the GitHub repository and edit it to match your relay bandwidth and settings before starting the container. source
  • Bandwidth Plan for at least 2 Mbit/s of symmetric bandwidth before deploying the relay. source

Fetched 43 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

What network setup should I use so the relay can be published?

Run the container with host networking, using --net=host, so the Tor ORPort is reachable from the outside. The logs should show that it is publishing the server descriptor.

Does the container start as an exit node?

No. The provided quickstart command starts a safe default relay configuration that is not an exit node.

How do I keep Tor data if I upgrade or remove the container?

Create a data directory and mount it to /var/lib/tor. All Tor data is preserved in that mounted directory even if you upgrade or remove the container.

How do I set the relay nickname and contact email?

Set the TOR_NICKNAME environment variable using only letters and numbers, and optionally set CONTACT_EMAIL. If the default nickname is left unchanged, the startup script adds a randomized pronouncable suffix.

Can the image be used as an obfs4proxy bridge?

Yes, it can be run as a hidden bridge using obfs4proxy.

Answers sourced from github.com

Community

Collected 25 days ago - public community threads