Giter Club home page Giter Club logo

pi-relay's Introduction

Pi Relay

Pi Relay is a free and open-source tool that transforms a Raspberry Pi into a relay for the Tor Network, aiming to enhance internet safety and access. It is especially beneficial in regions where internet censorship is present. Users such as journalists, librarians, and businesses can utilize Pi Relay to contribute the resiliency and performance of the Tor Network. Pi Relay facilitates the navigation through internet restrictions, upholds privacy, and assists in secure access. By supporting a network that counters digital security threats, it contributes to the broader goals of human rights, open societies, and internet freedom. Add an e-paper display to visualize your relay's activity.

Easy Install:

curl --proto '=https' --tlsv1.2 -sSfL https://install.pirelay.computer | bash

Install an e-Paper Display:

curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/scidsg/pi-relay/main/scripts/display.sh | bash

System Requirements

Raspberry Pi

  • Hardware: Raspberry Pi 4/3B+
  • Memory:
    • Non-exit relay @ <5 MB/s: >= 512 MB RAM (Default settings)
    • Non-exit relay @ >5 MB/s: >=1 GB RAM
  • Default Settings:
    • Relay Type: Middle
    • Monthly data: 1.5 TB
    • Bandwidth rate: 2 MB/s
    • Bandwidth burst: 4 MB/s
    • ORPort: 443
  • Storage: >=8 GB microSD
  • OS: Raspberry Pi OS (64-bit)
  • Display (optional): Waveshare 2.13" e-Paper display
  • (๐Ÿ‘† Affiliate links)

Learn more: https://community.torproject.org/relay/relays-requirements/

Pi Relay Devices

Why Pi Relay?

Pi Relay is designed to make setting up a Tor relay easy for everyone:

  • No manually editing files
  • Smart defaults
  • Tor repositories automatically included
  • Set limits on your relay's data usage
  • Settings that minimize risk - only middle relay config
  • Automatic relay naming
  • Nyx setup included
  • Automatic updates
  • Add an e-ink display to see up-to-date information about your relay's usage

Contribution Guidelines

๐Ÿ™Œ We're excited that you're interested in contributing to Pi Relay. To maintain the quality of our codebase and ensure the best experience for everyone, we ask that you follow these guidelines:

Code of Conduct

By contributing to Pi Relay, you agree to our Code of Conduct.

Reporting Bugs

If you find a bug in the software, we appreciate your help in reporting it. To report a bug:

  1. Check Existing Issues: Before creating a new issue, please check if it has already been reported. If it has, you can add any new information you have to the existing issue.
  2. Create a New Issue: If the bug hasn't been reported, create a new issue and provide as much detail as possible, including:
    • A clear and descriptive title.
    • Steps to reproduce the bug.
    • Expected behavior and what actually happens.
    • Any relevant screenshots or error messages.
    • Your operating system, browser, and any other relevant system information.

Submitting Pull Requests

Contributions to the codebase are submitted via pull requests (PRs). Here's how to do it:

  1. Create a New Branch: Always create a new branch for your changes.
  2. Make Your Changes: Implement your changes in your branch.
  3. Follow Coding Standards: Ensure your code adheres to the coding standards set for this project.
  4. Write Good Commit Messages: Write concise and descriptive commit messages. This helps maintainers understand and review your changes better.
  5. Test Your Changes: Before submitting your PR, test your changes thoroughly. Please link to a Gist containing your terminal's output of the end-to-end install of Pi Relay. For an example of a Gist, refer to the QA table below under the "Install Gist" column.
  6. Create a Pull Request: Once you are ready, create a pull request against the main branch of the repository. In your pull request description, explain your changes and reference any related issue(s).
  7. Review by Maintainers: Wait for the maintainers to review your pull request. Be ready to make changes if they suggest any.

By following these guidelines, you help to ensure a smooth and efficient contribution process for everyone.

QA

Repo Install Type OS/Source OS Codename Installed Install Gist Display Working Display Version Host Auditor Date Commit Hash
main Middle Raspberry Pi OS (64-bit) Bookworm โœ… link โœ… 1.1 Pi 4 4GB Glenn Nov-07-2023 08155d0

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.