Address inconsistent capitalization (OnionBalance -> Onionbalance)

0.1.7

-----

- Add functionality to reconnect to the Tor control port while OnionBalance is

- Add functionality to reconnect to the Tor control port while Onionbalance is

  running. Thank you to Ceysun Sucu for the patch. #45

- Fix bug where instance descriptors were not updated correctly when an

  instance address was listed under multiple master service. #49

0.1.5

-----

- Log error when OnionBalance does not have permission to read a private key. #34

- Log error when Onionbalance does not have permission to read a private key. #34

- Fix bug loading descriptors when an address with .onion extension is listed

  in the configuration file. #37

- Add support for connecting to the Tor control port over a unix domain socket. #3

- Use setproctitle to set a cleaner process title

- Replace the python-schedule dependency with a custom scheduler.

- Add a Unix domain socket which outputs the status of the OnionBalance

- Add a Unix domain socket which outputs the status of the Onionbalance

  service when a client connects. By default this socket is created at

  `/var/run/onionbalance/control`. Thank you to Federico Ceratto for the

  original socket implementation.

-----

- Remove dependency on the schedule package to prepare for packaging

  OnionBalance in Debian. The schedule code is now included directly in

  Onionbalance in Debian. The schedule code is now included directly in

  onionbalance/schedule.py.

- Fix the executable path in the help messages for onionbalance and

  onionbalance-config.

.. image:: obv3_logo.jpg

OnionBalance

Onionbalance

============

Introduction

------------

OnionBalance allows Tor onion service requests to be distributed across

multiple backend Tor instances. OnionBalance provides load-balancing while also

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.

master_doc = 'index'

# General information about the project.

project = 'OnionBalance'

project = 'Onionbalance'

# Remove copyright notice for man page

copyright = ''

#html_title = None

# A shorter title for the navigation bar.  Default is the same as html_title.

html_short_title = "OnionBalance Docs"

html_short_title = "Onionbalance Docs"

# The name of an image file (relative to this directory) to place at the top

# of the sidebar.

============

Thank you to the following contributors and others for their invaluble help

and advice in developing OnionBalance. Contributions of any kind (code,

and advice in developing Onionbalance. Contributions of any kind (code,

documentation, testing) are very welcome.

* `Donncha Ó Cearbhaill <https://github.com/DonnchaC/>`_

  - Original author and maintainer of OnionBalance!!!

  - Original author and maintainer of Onionbalance!!!

* `Federico Ceratto <https://github.com/FedericoCeratto>`_

  - Tireless assistance with Debian packaging and OnionBalance improvements.

  - Tireless assistance with Debian packaging and Onionbalance improvements.

  - Replaced and reimplemented the job scheduler.

  - Implemented support for Unix signals and added a status socket to

    retrieve information about the running service.

* `s7r <https://github.com/gits7r>`_

  - Assisted in testing and load testing OnionBalance from an early stage.

  - Assisted in testing and load testing Onionbalance from an early stage.

  - Many useful suggestions for performance and usability improvements.

* `Ceysun Sucu <https://github.com/csucu>`_

  - Added code to reconnect to the Tor control port while OnionBalance is

  - Added code to reconnect to the Tor control port while Onionbalance is

    running.

* `Alec Muffett <https://github.com/alecmuffett>`_

  - Extensively tested OnionBalance, found many bugs and made many

  - Extensively tested Onionbalance, found many bugs and made many

    suggestions to improve the software.

* `duritong <https://github.com/duritong>`_

  - Packaged OnionBalance for Fedora, CentOS, and Redhat 7 (EPEL repository).

  - Packaged Onionbalance for Fedora, CentOS, and Redhat 7 (EPEL repository).

Overview

========

OnionBalance is the best way to load balance onion services across multiple

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

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.

- Repository: https://gitlab.torproject.org/tpo/core/onionbalance

- GitHub mirror: https://github.com/asn-d6/onionbalance/

- Issue tracker: https://github.com/asn-d6/onionbalance/issues

- PyPI: https://pypi.org/project/OnionBalance/

- PyPI: https://pypi.org/project/Onionbalance/

- IRC: #tor-dev @ OFTC

Quickstart