From 87896a7d79ecfe06d2538e719061d6e75e1d7952 Mon Sep 17 00:00:00 2001 From: Micah Anderson Date: Tue, 21 Nov 2017 10:05:14 -0500 Subject: Docs: Update docs to prepare for 0.10.0 release Fixes: #8427, #8812 --- docs/en/services/tor/index.html | 48 +++++++++++++++++++++++++++++------------ 1 file changed, 34 insertions(+), 14 deletions(-) (limited to 'docs/en/services/tor') diff --git a/docs/en/services/tor/index.html b/docs/en/services/tor/index.html index 8fecf152..a6380d90 100644 --- a/docs/en/services/tor/index.html +++ b/docs/en/services/tor/index.html @@ -110,7 +110,7 @@ tor - LEAP Platform Documentation

tor

-
Tor exit node or hidden service
+
Tor services: relay, exit node and hidden service
    @@ -124,33 +124,53 @@ tor - LEAP Platform Documentation

    Topology

    -

    Nodes with tor service will run a Tor exit or hidden service, depending on what other service it is paired with:

    +

    Nodes with tor service will run a Tor relay with some pre-defined settings, which can be changed with some configuration (see Configuration below). You can enable an exit or a hidden service with additional configuration.

    + +

    Configuration

    + +

    By default, if a node has service ‘tor’ configured, it will run a tor relay (not an exit). The relay will be configured with bandwidth limitations, contacts, a nickname and a family. The defaults for these (shown below), can be overridden as desired.

      -
    • tor + openvpn: when combined with openvpn nodes, tor will create a Tor exit node to provide extra cover traffic for the VPN. This can be especially useful if there are VPN gateways without much traffic.
      • -
    • tor + webapp: when combined with a webapp node, the tor service will make the webapp and the API available via .onion hidden service.
      • -
    • tor stand alone: a regular Tor exit node.
      • +
    • tor.bandwidth_rate: the max bandwidth allocated to Tor, in KB per second, when used as an exit node (default: 6550 KB/sec).
      • +
    • tor.type: what type of tor node to make, at this moment only ‘exit’ is supported. If not specified, acts as a relay.
      • +
    • tor.contacts: the contact information for the relay (default: the list of provider contacts)
      • +
    • tor.nickname: the nickname of the relay (default: a combination of the node name and a hash of the family)
      • +
    • tor.family: a list of the other nicknames that are part of the same provider
      • +
    • tor.hidden_service: to enable a hidden service, set ‘active’ to be true (see below for an example), do not configure “services”: [“tor”] for the node!
    -

    If activated, you can list the hidden service .onion addresses this way:

    +

    Examples:

    -

    leap ls –print tor.hidden_service.address tor

    +

    To add a relay to a node:

    -

    Then just add ‘.onion’ to the end of the printed addresses.

    +
    { 
+ "services": ["tor"]
+}
+
    -

    Configuration

    +

    To enable a hidden service, without a relay, do not specify the tor service (it is not considered secure to have a node configured as a relay and a hidden service at the same time, see: https://trac.torproject.org/8742), instead configure the node to have the following:

    -
      -
    • tor.bandwidth_rate: the max bandwidth allocated to Tor, in KB per second, when used as an exit node.
      • -
    +
    {
+  "tor": {
+    "hidden_service": {
+    "active": true
+  }
+}
+
    +

    If activated, you can list the hidden service .onion addresses this way:

    + +

    leap ls –print tor.hidden_service.address tor

    + +

    Then just add ‘.onion’ to the end of the printed addresses.

    -

    For example:

    +

    To enable a Tor exit node:

    {
   "tor": {
-    "bandwidth_rate": 6550
+    "bandwidth_rate": 6550,
+    "type": "exit"
   }
 }
    -- cgit v1.2.3