Commit cf8cccfa authored by George Kadianakis's avatar George Kadianakis
Browse files

Add logo and improve documentation.

parent d4d26ad0
Loading
Loading
Loading
Loading
+7 −5
Original line number Diff line number Diff line
.. image:: obv3_logo.jpg

OnionBalance
============

Introduction
------------

The OnionBalance software allows for Tor onion service requests to be
distributed across multiple backend Tor instances. OnionBalance provides
load-balancing while also making onion services more resilient and reliable by
eliminating single points-of-failure.
OnionBalance allows Tor onion service requests to be distributed across
multiple backend Tor instances. OnionBalance provides load-balancing while also
making onion services more resilient and reliable by eliminating single
points-of-failure.

|build-status| |docs|

@@ -46,4 +48,4 @@ Cearbhaill. Thanks for all the code!!!
.. |docs| image:: https://readthedocs.org/projects/onionbalance-v3/badge/?version=latest
    :alt: Documentation Status
    :scale: 100%
    :target: https://onionbalance.readthedocs.org/en/latest/
    :target: https://onionbalance-v3.readthedocs.org/en/latest/
+7 −5
Original line number Diff line number Diff line
@@ -3,14 +3,16 @@
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

.. image:: ./../obv3_logo.jpg

Overview
========

OnionBalance is the best way to horizontally load balance onion services across
multiple backend Tor instances. This way the load of introduction and
rendezvous requests get distributed across multiple hosts. OnionBalance
provides load-balancing while also making onion services more resilient and
reliable by eliminating single points-of-failure.
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 provides
load-balancing while also making onion services more resilient and reliable by
eliminating single points-of-failure.

- Latest release: |version| (:ref:`changelog`)
- GitHub: https://github.com/asn-d6/onionbalance/
+6 −8
Original line number Diff line number Diff line
@@ -140,15 +140,13 @@ more than 10 instances.
-  **6-10 instances** - 10 IPs (selection from all instances)
-  **11 or more instances** - 10 IPs (distinct descriptors - selection from all instances)

If running in Complex mode, introduction points can be selected so as to
obscure that a service is using OnionBalance. Always attempting to
choose 3 introduction points per descriptor may make it more difficult
for a passive observer to confirm that a service is running
Always attempting to choose 3 introduction points per descriptor may make it
more difficult for a passive observer to confirm that a service is running
OnionBalance. However behavioral characteristics such as the rate of
introduction point rotation may still allow a passive observer to
distinguish an OnionBalance service from a standard Tor onion service.
Selecting a smaller set of introduction points may impact on performance
or reliability of the service.
introduction point rotation may still allow a passive observer to distinguish
an OnionBalance service from a standard Tor onion service.  Selecting a smaller
set of introduction points may impact on performance or reliability of the
service.

-  **1 instance**  - 3 IPs
-  **2 instances** - 3 IPs (2 IPs from one instance, 1 IP from the other

obv3_logo.jpg

0 → 100644
+108 KiB
Loading image diff...