[tor-commits] [oonib/master] Document configuration (#78)

[art at torproject.org]

commit 0396a55a27e9923537a6cd3d743d37009ef4715b
Author: Joe Landers <joe at joelanders.net>
Date:   Thu May 26 12:49:23 2016 +0200

    Document configuration (#78)
    
    * Update README.rst
    
    * remove old configuration option
---
 README.rst         | 17 +++++++++++++++++
 oonib.conf.example |  1 -
 2 files changed, 17 insertions(+), 1 deletion(-)

diff --git a/README.rst b/README.rst
index 63a242c..a73d776 100644
--- a/README.rst
+++ b/README.rst
@@ -107,6 +107,23 @@ this would simply be ``'report'``) and ``tor_datadir`` (where you would
 like the spawned Tor process to keep its data). If you compiled Tor yourself,
 you'll likely want to specify it for the ``tor_binary`` option.
 
+Configure bouncer and collector endpoints
+.........................................
+
+The bouncer and collector are HTTP applications ("protocols" in twisted terminology) that can be configured to run on top of plain TCP, TLS, or onion service endpoints.
+Here is an example of the relevant part of the configuration::
+    bouncer_endpoints:
+    - {type: tls, port: 10443, cert: "private/ssl-key-and-cert.pem"}
+    - {type: tcp, port: 10080}
+    - {type: onion, hsdir: "/some/private/bouncer"}
+
+    collector_endpoints:
+    - {type: tls, port: 11443, cert: "private/ssl-key-and-cert.pem"}
+    - {type: onion, hsdir: "/some/private/collector"}
+
+`scripts/gen-ssl-key-cert.sh` in this repo contains the openssl command to generate a self-signed certificate which you can use for the tls endpoint.
+txtorcon will use the hostname/private_key from the configured hsdir to start an onion service, or generate a new key if hsdir is empty.
+
 Generate self signed certs for OONIB
 ....................................
 If you want to use the HTTPS test helper, you will need to create a
diff --git a/oonib.conf.example b/oonib.conf.example
index 95df448..1925d81 100644
--- a/oonib.conf.example
+++ b/oonib.conf.example
@@ -27,7 +27,6 @@ main:
     debug: false
     stale_time: 3600
 
-    tor_hidden_service: false
     tor_datadir: null
 
     bouncer_endpoints: