Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix typos #834

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix typos #834

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

## What is this repo?

Rita is one part of the 'Althea Telecom Stack' a system that allows home wifi routers to buy and sell bandwidth autnomously, technically this is very similar to how BGP functions in the internet exchange with the key difference that Rita settles payment for banwidth automatically on a blockchain payment backend and all routing setup is fully automated.
Rita is one part of the 'Althea Telecom Stack' a system that allows home wifi routers to buy and sell bandwidth autonomously, technically this is very similar to how BGP functions in the internet exchange with the key difference that Rita settles payment for bandwidth automatically on a blockchain payment backend and all routing setup is fully automated.

[This video](https://www.youtube.com/watch?v=G4EKbgShyLw) provides a good explanation of key concepts.

This repo contains 'Rita' the coordination, management, and billing software for the 'Althea Telecom Stack'. Rita is the glue that ties together the different components of the system.

Rita interacts with and manages an instance of the [Babeld](https://github.com/althea-net/babeld) routing protocol that implements the [price aware routing extension](https://github.com/althea-net/babel-drafts/blob/master/draft-ietf-babel-price-propagation/draft-ietf-babel-price-propagation.xml). This extention provides a cash price for bandwidth independent of the routing cost, which is usually determined by packet loss and optionally latency in Babeld.
Rita interacts with and manages an instance of the [Babeld](https://github.com/althea-net/babeld) routing protocol that implements the [price aware routing extension](https://github.com/althea-net/babel-drafts/blob/master/draft-ietf-babel-price-propagation/draft-ietf-babel-price-propagation.xml). This extension provides a cash price for bandwidth independent of the routing cost, which is usually determined by packet loss and optionally latency in Babeld.

Rita discovers peers on physical interfaces and uses [WireGuard](https://www.wireguard.com/) to build a network of authenticated tunnels. Rita keeps track of traffic on these tunnels to compute how much each neighbor is owed or owes. Rita then attaches Babeld on top of this network of WireGuard tunnels to provide an authenaticated path for traffic.
Rita discovers peers on physical interfaces and uses [WireGuard](https://www.wireguard.com/) to build a network of authenticated tunnels. Rita keeps track of traffic on these tunnels to compute how much each neighbor is owed or owes. Rita then attaches Babeld on top of this network of WireGuard tunnels to provide an authenticated path for traffic.

From there Rita communicates with an instance of Rita exit, the exit is a privacy protecting server of the users selection that peers their traffic out onto the internet. Preventing anyone along the path from spying on the users traffic while it automatically roams within the Babel routing layer to the route with the best ratio of price to quality.

Expand All @@ -20,7 +20,7 @@ Finally Rita also contains [user dashboard](https://github.com/althea-net/rita-d

This is primarily an infrastructure repo, to get a working version of Althea for real world use you should look at [installer](https://github.com/althea-net/rita-installer) for desktop linux and [rita-firmware](https://github.com/althea-net/rita-firmware) for OpenWRT.

Rita supports either [Althea L1](https://github.com/althea-net/althea-L1) or any EVM based blockchain as it's payment backend.
Rita supports either [Althea L1](https://github.com/althea-net/althea-L1) or any EVM based blockchain as its payment backend.

## Building

Expand Down Expand Up @@ -66,10 +66,10 @@ If you wish to test a commit you are developing, or just see Rita in action loca

bash scripts/test.sh

This runs both the unit and integration tests you will need to have installed the depenencies listed in the Building section
This runs both the unit and integration tests you will need to have installed the dependencies listed in the Building section
as well as docker and have the [WireGuard](https://www.wireguard.com/install/) kernel module loaded for your operating system.

Due to a gotcha in the docker container build you will need to have your changes commited for the integration tests to work.
Due to a gotcha in the docker container build you will need to have your changes committed for the integration tests to work.

## Contributing

Expand Down