Commit 16250a71 authored by Silvio Rhatto's avatar Silvio Rhatto
Browse files

Merge branch 'feat/docs-refactor' into 'main' 

Refactor the Onionbalance documentation

Closes #37

See merge request !27
parents 98b09b8a 9d50c307

.gitignore

+1 −0
Original line number Diff line number Diff line
@@ -8,6 +8,7 @@ __pycache__/ 
# Distribution / packaging

.Python

env/

venv/

build/

develop-eggs/

dist/

docs/.pages

+5 −2
Original line number Diff line number Diff line 
nav:

  - Intro: README.md

  - Use cases: cases.md

  - Version 3: v3

  - Version 2: v2

  - Design: design.md

  - Tutorial: tutorial.md

  - Installation: installation.md

  - Configuration: config.md

  - Status socket: socket.md

  - Hacking: hacking.md

  - API: api.md

  - Changelog: changelog.md

  - Contributors: contributors.md

docs/README.md

+4 −19
Original line number Diff line number Diff line
@@ -4,26 +4,11 @@ 


## Overview



Onionbalance is the best way to load balance onion services across

[Onionbalance][] is the best way to load balance [Onion Services][] across

multiple backend Tor instances. This way the load of introduction and

rendezvous requests get distributed across multiple hosts. Onionbalance

rendezvous requests gets distributed across multiple hosts. Onionbalance

provides load-balancing while also making onion services more resilient

and reliable by eliminating single points-of-failure.



* Repository:

  [https://gitlab.torproject.org/tpo/onion-services/onionbalance][]

* GitHub mirror:

  [https://github.com/torproject/onionbalance][]

* Issue tracker:

  [https://gitlab.torproject.org/tpo/onion-services/onionbalance/-/issues][]

* PyPI: [https://pypi.org/project/Onionbalance][]

* IRC: #tor-dev @ OFTC



[https://gitlab.torproject.org/tpo/onion-services/onionbalance]: https://gitlab.torproject.org/tpo/onion-services/onionbalance

[https://github.com/torproject/onionbalance]: https://github.com/torproject/onionbalance

[https://gitlab.torproject.org/tpo/onion-services/onionbalance/-/issues]: https://gitlab.torproject.org/tpo/onion-services/onionbalance/-/issues

[https://pypi.org/project/Onionbalance]: https://pypi.org/project/Onionbalance



## Quickstart



Check the [v3 tutorial](v3/tutorial.md) page for setting up a v3 onionbalance.
 
[Onionbalance]: https://gitlab.torproject.org/tpo/onion-services/onionbalance

[Onion Services]: https://community.torproject.org/onion-services

docs/api.md

+3 −0
Original line number Diff line number Diff line 
# Onionbalance API



This page contains a raw description of Onionbalance's API.

For an overview, consult the [hacking page](hacking.md).



::: onionbalance

    options:

      show_root_toc_entry: false

docs/assets/architecture.png

+6.73 KiB (76.1 KiB)
Loading image diff...