[Pkg-privacy-commits] [onionbalance] 74/117: Add use cases to the README

[Donncha O'Cearbahill]

This is an automated email from the git hooks/post-receive script.

donncha-guest pushed a commit to branch debian/sid
in repository onionbalance.

commit eb135acc5e69d3b68a206a330dcb00907760e263
Author: Donncha O'Cearbhaill <donncha at donncha.is>
Date:   Tue Jun 30 14:24:52 2015 +0100

    Add use cases to the README
---
 README.rst | 26 +++++++++++++++++++++++---
 1 file changed, 23 insertions(+), 3 deletions(-)

diff --git a/README.rst b/README.rst
index d4c8275..9136f62 100644
--- a/README.rst
+++ b/README.rst
@@ -62,7 +62,7 @@ The Tor config file at ``onionbalance/data/torrc-server`` can be used for the ma
     $ tor -f torrc-server
 
 Configuring the backend onion service instances
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Each backend instance should be run a standard onion service which serves your website or other content. More information about configuring onion services is available in the Tor Project's `hidden service configuration guide <https://www.torproject.org/docs/tor-hidden-service.html.en>`_.
 
@@ -73,7 +73,7 @@ If you have used the ``onionbalance-config`` tool you should transfer the genera
     $ tor -f instance_torrc
 
 OnionBalance config file
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 The OnionBalance management server must have access to the private key for the master onion service. This master private key determines the address that users will use to access your onion service. This private key must be kept secure.
 
@@ -82,7 +82,8 @@ The location of the private key must be specified as relative or absolute path u
 An example config file is provided in `config.example.yaml <onionbalance/data/config.example.yaml>`_. If you have used the ``onionbalance-config`` tool you can simply use the generated config file at ``master/config.yaml``.
 
 Running
--------
+~~~~~~~
+
 
 You can start the management server once your backend onion service instances are running. The management server must be left running to publish descriptors for your onion service.
 
@@ -92,6 +93,25 @@ You can start the management server once your backend onion service instances ar
 
 Multiple OnionBalance management servers can be run to make your service more resilient and remove a single point of failure. Each redundant server should be run with the same private key and config file.
 
+Use Cases
+---------
+
+- A popular onion service with an overloaded web server or Tor process:
+
+  A service such as Facebook which gets a large number of users would like to distribute client requests across multiple servers as the load is too much for a single Tor instance to handle. They would also like to balance between instances when the 'encrypted services' proposal is implemented [2555].
+
+- Redundancy and automatic failover:
+
+  A political activist would like to keep their web service accessible and secure in the event that the secret police seize some of their servers. Clients should ideally automatically fail-over to another online instances with minimal service disruption.
+
+- 'Shared Hosting' scenarios:
+
+  A hosting provider wishes to allow their customers to access their shared hosting control panel over an encrypted onion service. Rather than creating an individual onion service (with corresponding overhead) for thousands of customers, the host could instead run one onion service. Multiple service descriptors could then be published under unique customer onion addresses which would then be routed to that users control panel. This could also enable a low-resourced OnionFlare-type implem [...]
+
+- Secure Onion Service Key storage:
+
+  An onion service operator would like to compartmentalize their permanent onion key in a secure location separate to their Tor process and other services. With this proposal permanent keys could be stored on an independent, isolated system.
+
 Contact
 -------
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-privacy/packages/onionbalance.git