138 lines
5.5 KiB
Markdown
138 lines
5.5 KiB
Markdown
Tor Relay Panel for Raspberry Pi
|
||
================================
|
||
|
||
_Run a Tor relay at home with a beautiful, simple web dashboard._
|
||
|
||
Bring real privacy power to the internet—right from your Raspberry Pi. **Tor Relay Panel** makes it easy for anyone to run a **Tor middle relay** with a clean, password-protected dashboard, live charts, and simple controls. No command-line expertise needed.
|
||
|
||
Why run a Tor relay?
|
||
--------------------
|
||
|
||
* **Strengthen online privacy** – Keep the Tor network fast, healthy, and resilient for everyone who needs it.
|
||
|
||
* **Support digital freedom** – Join a global, decentralized infrastructure that protects free expression.
|
||
|
||
* **You’re in control** – Set your own bandwidth and monthly data cap to match your connection and plan.
|
||
|
||
|
||
Highlights
|
||
----------
|
||
|
||
* **Friendly web interface** – Configure everything in minutes.
|
||
|
||
* **Middle relay only** – Safe for homes; no exit traffic from your IP.
|
||
|
||
* **Live charts & stats** – See traffic trends from the last 48 hours at a glance.
|
||
|
||
* **Reachability widget** – Check if your relay is publicly reachable and has the **Running** flag.
|
||
|
||
* **Simple controls** – Edit nickname, contact, ORPort, bandwidth, burst, and monthly cap anytime.
|
||
|
||
* **Secure session login** – Password-protected dashboard for your local network.
|
||
|
||
* **Dark / Light theme** – Switch instantly; your preference is remembered.
|
||
|
||
* **First-time setup wizard** – Create your admin account and initial settings in one flow.
|
||
|
||
* **Lightweight & open-source** – Built for Raspberry Pi OS (Debian) Lite 64-bit.
|
||
|
||
|
||
Who is it for?
|
||
--------------
|
||
|
||
* **Home users** who want to contribute to internet privacy.
|
||
|
||
* **Makers & Raspberry Pi fans** looking for a meaningful, always-on project.
|
||
|
||
* **Community builders** who want a reliable middle relay with simple, visual management.
|
||
|
||
|
||
What you need
|
||
-------------
|
||
|
||
* A **Raspberry Pi** running Raspberry Pi OS (Debian) **Lite 64-bit**.
|
||
|
||
* A stable **home internet connection**.
|
||
|
||
* Recommended: **IPv4 port forward** (or **IPv6 inbound**) to your Tor **ORPort** so your relay can be publicly reachable.
|
||
|
||
|
||
> 🔒 The web dashboard is designed for your **local network**. You don’t need to expose it to the internet.
|
||
|
||
Setup in minutes
|
||
----------------
|
||
|
||
1. **Get the files**Clone or download this repository to your Raspberry Pi.
|
||
|
||
2. **Run the installer**From the project folder, run the install script with sudo (one line).
|
||
|
||
3. **Open the dashboard**Visit the Pi’s IP in your browser, follow the **first-time setup**, and you’re done.
|
||
|
||
|
||
You’ll then see:
|
||
|
||
* **Live status** (Tor version, bootstrap, circuits)
|
||
|
||
* **Traffic graphs** (read/written bytes over time)
|
||
|
||
* **Reachability check** (consensus, flags, “Tor thinks your address is…”)
|
||
|
||
* **Simple edit panel** for bandwidth, burst, and monthly cap
|
||
|
||
|
||
Screenshots
|
||
-----------
|
||
|
||
|
||
* **Dashboard (Dark Mode)**
|
||
|
||
|
||
* **Dashboard (Light Mode)**
|
||
|
||
|
||
* **Login Panel**
|
||
|
||
|
||
* **First-Time Setup**
|
||
|
||
|
||
|
||
Frequently asked questions
|
||
--------------------------
|
||
|
||
**Do I need to open a port?**Yes. To earn the **Running** flag and carry traffic, your relay must be reachable on its **ORPort** (default **9001/TCP**). The dashboard includes a reachability widget to help verify this. Most homes use a simple router port-forward (or allow inbound on IPv6).
|
||
|
||
**Is this an exit relay?**No. This runs as a **non-exit, middle relay**. Your IP is not used to access websites on behalf of others.
|
||
|
||
**Will this slow down my internet?**You choose your **bandwidth limit** and **monthly data cap**. Pick values that keep your connection comfortable.
|
||
|
||
**Is it safe to run at home?**A middle relay is a popular, community-friendly way to support Tor. Always follow your ISP’s terms and local laws.
|
||
|
||
**Do I need to expose the dashboard to the internet?**No. Keep the dashboard **local-only** on your home network. Only the Tor **ORPort** needs to be reachable from the outside.
|
||
|
||
**Can I stop or change limits later?**Yes—use the dashboard to pause, adjust bandwidth, burst, or monthly cap any time.
|
||
|
||
Tips for the best experience
|
||
----------------------------
|
||
|
||
* **Give it time:** after changes, it can take a while before your relay appears with the **Running** flag.
|
||
|
||
* **Be consistent:** keeping your Pi on helps the network and improves reliability.
|
||
|
||
* **Start modestly:** begin with conservative bandwidth/cap values, then adjust upward as you’re comfortable.
|
||
|
||
|
||
Uninstall
|
||
---------
|
||
|
||
Prefer to remove everything later? There’s a friendly uninstall script included to clean up the panel and related packages. Run it from the project folder with sudo.
|
||
|
||
Join the network
|
||
----------------
|
||
|
||
Spin up your Raspberry Pi, run the installer, set your limits, and start helping keep the open internet open. Your small contribution makes a **big** difference. 🧅
|
||
|
||
Keywords (for discoverability)
|
||
------------------------------
|
||
|
||
Raspberry Pi Tor relay, Tor middle relay dashboard, easy Tor relay setup, privacy network volunteer, run a Tor node at home, open-source Tor panel, simple Tor web interface, live Tor traffic graphs, secure Tor relay management, Raspberry Pi privacy project, Tor relay Raspberry Pi guide, local web dashboard for Tor, dark mode Tor panel, lightweight Tor admin UI |