Tor Relay
Tor Relay is a Docker image that installs and runs a stable Tor relay, obfs4proxy, or Meek bridge on a home server, applying Tor Project configuration…
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.
33/100 Low
- Maintained
- 1last commit 723 days ago
- Popular
- 2110 GitHub stars
- Easy to install
- 351 install platform, install notes, Docker image
- Light to run
- 801 GB minimum RAM, runs on ARM
- Security check
- 75no serious findings
Availability: platform listings confirmed today, links checked 42 days ago
- GitHub stars
- 10
- Open issues
- 0
- Last commit
- 2024-11-28
- License
- CC-BY-SA-4.0
- Activity
- stale
Checked 20 days ago - source: GitHub (iAnonymous3000/Tor-Relay-Guide)
Resources & Compatibility
Minimum requirements: 1 GB RAM, 200 MB disk. ARM (e.g. Raspberry Pi) is supported.
Checked 54 days ago - source: Docker Hub image tags and published docs
First-install notes
- Use a public address, not 127.0.0.1, for remote clients The examples include 127.0.0.1, which means the same machine only. For a relay or transport that other networks should use, replace it with the machine's public IP or hostname, or remote users will not be able to connect. source
- If using pluggable transports, match their ports Pluggable transports (optional wrapped Tor connections) are announced with SMETHOD (the message sent when a transport starts), which carries the transport's address and port. Use the real address and port where the transport program is listening, because a mismatch means clients cannot reach the relay. source
- Back up onion-service private keys if you add them If you create an Onion Service (a hidden service) by using the ADD_ONION control command, the response may include a private key or client-authorization blob (data used to allow specific clients to connect). Store that value securely, because losing it can break the service and exposing it can let someone hijack it. source
- Configure the relay before first start Create the appdata/tor-data/config folder, copy the sample config from the tor-relay directory of the GitHub repository, and edit at least the NICKNAME and CONTACTINFO values before starting the container. source
- Review relay type and security guidance Review relay type, exit relay exposure, and security practices before exposing your relay. source
Fetched 30 days ago - each note links to its source
Variants
Alternatives (4)
- GNUnet
- Hyphanet - Hyphanet (formerly Freenet) is a peer-to-peer, censorship-resistant platform for private publishing and communication.
- Tor Snowflake Proxy - Snowflake is a system to defeat internet censorship.
- arti - Arti is an experimental Tor implementation written in Rust, and it is designed to be modular, reusable, and easy to audit.
Checked 54 days ago - source: AlternativeTo
Common questions
What must I edit before starting the Tor Relay container for the first time?
Create the appdata/tor-data/config folder, copy the sample config from the tor-relay directory, and edit at least the NICKNAME and CONTACTINFO values before starting the container.
Can I point the relay or bridge at 127.0.0.1 for remote clients?
No, use the machine's public IP or hostname instead of 127.0.0.1. Remote users will not be able to connect to a loopback address.
How do pluggable transport ports affect reachability?
Use the real address and port where the transport program is listening. A mismatch between the announced SMETHOD address/port and the listening transport prevents clients from reaching the relay.
Should I run a home bridge and use it for my own traffic?
Self-hosting a bridge for your own traffic is discouraged because of de-anonymization risk.
Will my ISP notice a home Tor relay?
Yes, they can detect a Tor relay, though they have to take the trouble to look for it. The most likely way they find one is by seeing heavy bandwidth use.
Answers sourced from forum.torproject.org, github.com, spec.torproject.org, spec.torproject.org, www.reddit.com
Community
- How to do the most good with Relays? - Tor Project Forum (forum)
- [tor-relays] Self hosting bridge at home - de-anonymization risk? (forum)
- Answering FAQs about running a Tor relay/bridge, plus lots of ... - Reddit (reddit)
Collected 53 days ago - public community threads