# Joshgaby Tor Relay

Joshgaby Tor Relay is a self-hosted network services app. A Docker image that runs the latest stable Tor relay server so you can donate bandwidth to the Tor network. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/2432/joshgaby-tor-relay

## Description

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.

## Health score

18/100 (Low), based on 4 of 4 factors.
- Maintained: 0 (last commit 1475 days ago)
- Popular: 0 (0 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Light to run: 70 (1 GB minimum RAM)

## Links

- GitHub: https://github.com/josh-gaby/tor-server
- Docker Hub: https://hub.docker.com/r/joshgaby/tor-server/
- Unraid: https://ca.unraid.net/apps/joshgaby-tor-relay-1ugbsad1lczjcx?q=joshgaby-tor-relay

## 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.

---
Source: Our Local Host (https://ourlocalhost.com/app/2432/joshgaby-tor-relay), the self-hosted and open-source app directory.
