summaryrefslogtreecommitdiff
path: root/docs/en/services
diff options
context:
space:
mode:
authorMicah Anderson <micah@riseup.net>2017-11-21 10:05:14 -0500
committerMicah Anderson <micah@riseup.net>2017-11-23 08:53:14 -0500
commit87896a7d79ecfe06d2538e719061d6e75e1d7952 (patch)
treec95d8f821b4230155b47dce4b205c7fc58d8b126 /docs/en/services
parentb584e92a6b654eee9427cd56d7317aa0125c92a4 (diff)
Docs: Update docs to prepare for 0.10.0 release
Fixes: #8427, #8812
Diffstat (limited to 'docs/en/services')
-rw-r--r--docs/en/services/couchdb.html2
-rw-r--r--docs/en/services/couchdb/index.html2
-rw-r--r--docs/en/services/index.html2
-rw-r--r--docs/en/services/mx.html4
-rw-r--r--docs/en/services/mx/index.html4
-rw-r--r--docs/en/services/openvpn.html2
-rw-r--r--docs/en/services/openvpn/index.html2
-rw-r--r--docs/en/services/tor.html48
-rw-r--r--docs/en/services/tor/index.html48
9 files changed, 77 insertions, 37 deletions
diff --git a/docs/en/services/couchdb.html b/docs/en/services/couchdb.html
index de50a692..43f7cfac 100644
--- a/docs/en/services/couchdb.html
+++ b/docs/en/services/couchdb.html
@@ -215,7 +215,7 @@ couchdb - LEAP Platform Documentation
<ul>
<li>search for the &ldquo;user_id&rdquo; field</li>
-<li>in this example <a href="&#x6d;&#x61;&#105;&#x6c;&#x74;&#x6f;&#58;&#116;&#x65;&#115;&#x74;&#x75;&#x73;&#x65;&#114;&#64;&#x65;&#120;&#x61;&#109;&#x70;&#x6c;&#x65;&#46;&#x6f;&#x72;&#103;">&#116;&#x65;&#115;&#116;&#x75;&#x73;&#101;&#114;&#x40;&#x65;&#120;&#x61;&#109;&#112;&#108;&#x65;&#46;&#111;&#x72;&#103;</a> uses the database user-665e004870ee17aa4c94331ff3cd59eb</li>
+<li>in this example <a href="&#x6d;&#97;&#105;&#x6c;&#x74;&#111;&#58;&#116;&#101;&#115;&#x74;&#117;&#115;&#101;&#x72;&#64;&#x65;&#120;&#97;&#x6d;&#x70;&#x6c;&#101;&#x2e;&#111;&#114;&#x67;">&#x74;&#101;&#x73;&#116;&#x75;&#115;&#101;&#x72;&#x40;&#101;&#x78;&#x61;&#109;&#x70;&#108;&#101;&#x2e;&#111;&#x72;&#103;</a> uses the database user-665e004870ee17aa4c94331ff3cd59eb</li>
</ul>
diff --git a/docs/en/services/couchdb/index.html b/docs/en/services/couchdb/index.html
index 9eb7fcb8..b48c4eb7 100644
--- a/docs/en/services/couchdb/index.html
+++ b/docs/en/services/couchdb/index.html
@@ -215,7 +215,7 @@ couchdb - LEAP Platform Documentation
<ul>
<li>search for the &ldquo;user_id&rdquo; field</li>
-<li>in this example <a href="&#x6d;&#97;&#105;&#108;&#x74;&#x6f;&#58;&#x74;&#x65;&#x73;&#116;&#117;&#115;&#101;&#x72;&#64;&#x65;&#x78;&#97;&#109;&#112;&#x6c;&#x65;&#46;&#111;&#114;&#103;">&#x74;&#101;&#115;&#116;&#x75;&#115;&#x65;&#x72;&#64;&#101;&#x78;&#x61;&#x6d;&#x70;&#x6c;&#101;&#x2e;&#111;&#x72;&#103;</a> uses the database user-665e004870ee17aa4c94331ff3cd59eb</li>
+<li>in this example <a href="&#109;&#97;&#x69;&#108;&#x74;&#x6f;&#58;&#x74;&#x65;&#115;&#116;&#117;&#x73;&#x65;&#114;&#x40;&#101;&#120;&#x61;&#109;&#x70;&#x6c;&#101;&#46;&#111;&#x72;&#103;">&#116;&#101;&#115;&#x74;&#x75;&#115;&#101;&#x72;&#x40;&#x65;&#120;&#97;&#x6d;&#112;&#108;&#x65;&#x2e;&#111;&#x72;&#103;</a> uses the database user-665e004870ee17aa4c94331ff3cd59eb</li>
</ul>
diff --git a/docs/en/services/index.html b/docs/en/services/index.html
index 6d5c68e1..261cd11b 100644
--- a/docs/en/services/index.html
+++ b/docs/en/services/index.html
@@ -235,7 +235,7 @@ Services - LEAP Platform Documentation
<h2>
<a href='tor.html'>tor</a>
</h2>
-<div class='summary'>Tor exit node or hidden service</div>
+<div class='summary'>Tor services: relay, exit node and hidden service</div>
</div>
<div class=' page-summary'>
<h2>
diff --git a/docs/en/services/mx.html b/docs/en/services/mx.html
index 8f5a36da..aa41186a 100644
--- a/docs/en/services/mx.html
+++ b/docs/en/services/mx.html
@@ -156,8 +156,8 @@ mx - LEAP Platform Documentation
<ol>
<li>alias lists: by specifying an array of destination addresses, as in the case of &ldquo;flock&rdquo;, the single email will get copied to each address.</li>
-<li>chained resolution: alias resolution will recursively continue until there are no more matching aliases. For example, &ldquo;flock&rdquo; is resolved to &ldquo;robin&rdquo;, which then gets resolved to &ldquo;<a href="&#x6d;&#x61;&#x69;&#108;&#x74;&#x6f;&#x3a;&#x72;&#111;&#98;&#105;&#110;&#x40;&#98;&#105;&#114;&#100;&#46;&#111;&#x72;&#x67;">&#x72;&#111;&#x62;&#x69;&#110;&#64;&#x62;&#105;&#114;&#x64;&#46;&#x6f;&#x72;&#103;</a>&rdquo;.</li>
-<li>virtual domains: by specifying the full domain, as in the case of &ldquo;<a href="&#109;&#97;&#x69;&#108;&#116;&#x6f;&#58;&#x63;&#104;&#105;&#x63;&#x6b;&#97;&#100;&#x65;&#x65;&#x40;&#97;&#x76;&#x69;&#97;&#110;&#x2e;&#x6f;&#114;&#x67;">&#x63;&#104;&#x69;&#99;&#107;&#x61;&#100;&#x65;&#x65;&#64;&#97;&#x76;&#x69;&#x61;&#110;&#x2e;&#111;&#114;&#x67;</a>&rdquo;, the alias will work for any domain you want. Of course, the MX record for that domain must point to appropriate MX servers, but otherwise you don&rsquo;t need to do any additional configuration.</li>
+<li>chained resolution: alias resolution will recursively continue until there are no more matching aliases. For example, &ldquo;flock&rdquo; is resolved to &ldquo;robin&rdquo;, which then gets resolved to &ldquo;<a href="&#x6d;&#x61;&#105;&#108;&#x74;&#x6f;&#58;&#114;&#x6f;&#x62;&#x69;&#110;&#x40;&#x62;&#105;&#x72;&#x64;&#x2e;&#111;&#114;&#x67;">&#x72;&#x6f;&#98;&#105;&#x6e;&#64;&#x62;&#x69;&#114;&#x64;&#46;&#x6f;&#x72;&#x67;</a>&rdquo;.</li>
+<li>virtual domains: by specifying the full domain, as in the case of &ldquo;<a href="&#109;&#x61;&#x69;&#108;&#116;&#111;&#58;&#x63;&#104;&#x69;&#x63;&#x6b;&#97;&#100;&#x65;&#101;&#64;&#97;&#x76;&#105;&#97;&#110;&#46;&#x6f;&#x72;&#103;">&#x63;&#x68;&#105;&#99;&#107;&#97;&#x64;&#101;&#x65;&#64;&#97;&#x76;&#x69;&#97;&#110;&#46;&#x6f;&#114;&#x67;</a>&rdquo;, the alias will work for any domain you want. Of course, the MX record for that domain must point to appropriate MX servers, but otherwise you don&rsquo;t need to do any additional configuration.</li>
<li>local delivery: for testing purposes, it is often useful to copy all incoming mail for a particular address and send those copies to another address. You can do this by adding &ldquo;@deliver.local&rdquo; as one of the destination addresses. When &ldquo;@local.delivery&rdquo; is found, alias resolution stops and the mail is delivered to that username.</li>
</ol>
diff --git a/docs/en/services/mx/index.html b/docs/en/services/mx/index.html
index e8e06e80..048f5198 100644
--- a/docs/en/services/mx/index.html
+++ b/docs/en/services/mx/index.html
@@ -156,8 +156,8 @@ mx - LEAP Platform Documentation
<ol>
<li>alias lists: by specifying an array of destination addresses, as in the case of &ldquo;flock&rdquo;, the single email will get copied to each address.</li>
-<li>chained resolution: alias resolution will recursively continue until there are no more matching aliases. For example, &ldquo;flock&rdquo; is resolved to &ldquo;robin&rdquo;, which then gets resolved to &ldquo;<a href="&#x6d;&#97;&#105;&#x6c;&#x74;&#x6f;&#58;&#x72;&#111;&#98;&#x69;&#x6e;&#64;&#x62;&#105;&#114;&#100;&#x2e;&#x6f;&#114;&#x67;">&#x72;&#x6f;&#x62;&#105;&#x6e;&#x40;&#x62;&#x69;&#114;&#x64;&#46;&#x6f;&#114;&#x67;</a>&rdquo;.</li>
-<li>virtual domains: by specifying the full domain, as in the case of &ldquo;<a href="&#109;&#x61;&#105;&#x6c;&#x74;&#111;&#58;&#x63;&#x68;&#x69;&#x63;&#x6b;&#x61;&#100;&#101;&#x65;&#x40;&#x61;&#x76;&#105;&#x61;&#110;&#x2e;&#x6f;&#x72;&#103;">&#99;&#x68;&#x69;&#99;&#107;&#x61;&#100;&#101;&#101;&#x40;&#x61;&#118;&#105;&#97;&#x6e;&#x2e;&#x6f;&#x72;&#x67;</a>&rdquo;, the alias will work for any domain you want. Of course, the MX record for that domain must point to appropriate MX servers, but otherwise you don&rsquo;t need to do any additional configuration.</li>
+<li>chained resolution: alias resolution will recursively continue until there are no more matching aliases. For example, &ldquo;flock&rdquo; is resolved to &ldquo;robin&rdquo;, which then gets resolved to &ldquo;<a href="&#109;&#x61;&#x69;&#108;&#x74;&#111;&#58;&#x72;&#111;&#x62;&#105;&#x6e;&#64;&#98;&#105;&#x72;&#x64;&#x2e;&#111;&#114;&#103;">&#114;&#x6f;&#x62;&#105;&#x6e;&#64;&#x62;&#x69;&#x72;&#100;&#x2e;&#x6f;&#x72;&#x67;</a>&rdquo;.</li>
+<li>virtual domains: by specifying the full domain, as in the case of &ldquo;<a href="&#109;&#97;&#105;&#x6c;&#116;&#x6f;&#x3a;&#x63;&#x68;&#105;&#99;&#107;&#x61;&#x64;&#x65;&#x65;&#x40;&#x61;&#118;&#x69;&#97;&#110;&#x2e;&#x6f;&#x72;&#x67;">&#x63;&#x68;&#105;&#x63;&#107;&#97;&#x64;&#101;&#x65;&#x40;&#97;&#x76;&#x69;&#x61;&#x6e;&#x2e;&#111;&#114;&#103;</a>&rdquo;, the alias will work for any domain you want. Of course, the MX record for that domain must point to appropriate MX servers, but otherwise you don&rsquo;t need to do any additional configuration.</li>
<li>local delivery: for testing purposes, it is often useful to copy all incoming mail for a particular address and send those copies to another address. You can do this by adding &ldquo;@deliver.local&rdquo; as one of the destination addresses. When &ldquo;@local.delivery&rdquo; is found, alias resolution stops and the mail is delivered to that username.</li>
</ol>
diff --git a/docs/en/services/openvpn.html b/docs/en/services/openvpn.html
index e5fe1128..1a420e21 100644
--- a/docs/en/services/openvpn.html
+++ b/docs/en/services/openvpn.html
@@ -133,8 +133,8 @@ openvpn - LEAP Platform Documentation
<p><em>Essential configuration</em></p>
<ul>
-<li><code>openvpn.gateway_address</code>: The address that OpenVPN daemon is bound to and that VPN clients connect to.</li>
<li><code>ip_address</code>: The main IP of the server, and the egress address for outgoing traffic.</li>
+<li><code>openvpn.gateway_address</code>: A secondary address on the same machine (sharing the same interface, or on a separate interface). The OpenVPN daemon is bound to this address and VPN clients connect to it.</li>
</ul>
diff --git a/docs/en/services/openvpn/index.html b/docs/en/services/openvpn/index.html
index 4a9dc993..23866436 100644
--- a/docs/en/services/openvpn/index.html
+++ b/docs/en/services/openvpn/index.html
@@ -133,8 +133,8 @@ openvpn - LEAP Platform Documentation
<p><em>Essential configuration</em></p>
<ul>
-<li><code>openvpn.gateway_address</code>: The address that OpenVPN daemon is bound to and that VPN clients connect to.</li>
<li><code>ip_address</code>: The main IP of the server, and the egress address for outgoing traffic.</li>
+<li><code>openvpn.gateway_address</code>: A secondary address on the same machine (sharing the same interface, or on a separate interface). The OpenVPN daemon is bound to this address and VPN clients connect to it.</li>
</ul>
diff --git a/docs/en/services/tor.html b/docs/en/services/tor.html
index f649c086..1f6ce112 100644
--- a/docs/en/services/tor.html
+++ b/docs/en/services/tor.html
@@ -110,7 +110,7 @@ tor - LEAP Platform Documentation
<div id='title-box'>
<h1>tor</h1>
-<div id='summary'>Tor exit node or hidden service</div>
+<div id='summary'>Tor services: relay, exit node and hidden service</div>
</div>
<div id='content-box'>
<div id="TOC"><ol>
@@ -124,33 +124,53 @@ tor - LEAP Platform Documentation
<h2><a name="topology"></a>Topology</h2>
-<p>Nodes with <code>tor</code> service will run a Tor exit or hidden service, depending on what other service it is paired with:</p>
+<p>Nodes with <code>tor</code> service will run a Tor relay with some pre-defined settings, which can be changed with some configuration (see <em>Configuration</em> below). You can enable an exit or a hidden service with additional configuration.</p>
+
+<h2><a name="configuration"></a>Configuration</h2>
+
+<p>By default, if a node has service &lsquo;tor&rsquo; 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.</p>
<ul>
-<li><code>tor</code> + <code>openvpn</code>: when combined with <code>openvpn</code> nodes, <code>tor</code> 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.</li>
-<li><code>tor</code> + <code>webapp</code>: when combined with a <code>webapp</code> node, the <code>tor</code> service will make the webapp and the API available via .onion hidden service.</li>
-<li><code>tor</code> stand alone: a regular Tor exit node.</li>
+<li><code>tor.bandwidth_rate</code>: the max bandwidth allocated to Tor, in KB per second, when used as an exit node (default: 6550 KB/sec).</li>
+<li><code>tor.type</code>: what type of tor node to make, at this moment only &lsquo;exit&rsquo; is supported. If not specified, acts as a relay.</li>
+<li><code>tor.contacts</code>: the contact information for the relay (default: the list of provider contacts)</li>
+<li><code>tor.nickname</code>: the nickname of the relay (default: a combination of the node name and a hash of the family)</li>
+<li><code>tor.family</code>: a list of the other nicknames that are part of the same provider</li>
+<li><code>tor.hidden_service</code>: to enable a hidden service, set &lsquo;active&rsquo; to be true (see below for an example), do <em>not</em> configure &ldquo;services&rdquo;: [&ldquo;tor&rdquo;] for the node!</li>
</ul>
-<p>If activated, you can list the hidden service .onion addresses this way:</p>
+<p>Examples:</p>
-<p> leap ls &ndash;print tor.hidden_service.address tor</p>
+<p>To add a relay to a node:</p>
-<p>Then just add &lsquo;.onion&rsquo; to the end of the printed addresses.</p>
+<pre><code>{
+ "services": ["tor"]
+}
+</code></pre>
-<h2><a name="configuration"></a>Configuration</h2>
+<p>To enable a hidden service, without a relay, do <em>not</em> 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: <a href="https://trac.torproject.org/8742">https://trac.torproject.org/8742</a>), instead configure the node to have the following:</p>
-<ul>
-<li><code>tor.bandwidth_rate</code>: the max bandwidth allocated to Tor, in KB per second, when used as an exit node.</li>
-</ul>
+<pre><code>{
+ "tor": {
+ "hidden_service": {
+ "active": true
+ }
+}
+</code></pre>
+<p>If activated, you can list the hidden service .onion addresses this way:</p>
+
+<p> leap ls &ndash;print tor.hidden_service.address tor</p>
+
+<p>Then just add &lsquo;.onion&rsquo; to the end of the printed addresses.</p>
-<p>For example:</p>
+<p>To enable a Tor exit node:</p>
<pre><code>{
"tor": {
- "bandwidth_rate": 6550
+ "bandwidth_rate": 6550,
+ "type": "exit"
}
}
</code></pre>
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
<div id='title-box'>
<h1>tor</h1>
-<div id='summary'>Tor exit node or hidden service</div>
+<div id='summary'>Tor services: relay, exit node and hidden service</div>
</div>
<div id='content-box'>
<div id="TOC"><ol>
@@ -124,33 +124,53 @@ tor - LEAP Platform Documentation
<h2><a name="topology"></a>Topology</h2>
-<p>Nodes with <code>tor</code> service will run a Tor exit or hidden service, depending on what other service it is paired with:</p>
+<p>Nodes with <code>tor</code> service will run a Tor relay with some pre-defined settings, which can be changed with some configuration (see <em>Configuration</em> below). You can enable an exit or a hidden service with additional configuration.</p>
+
+<h2><a name="configuration"></a>Configuration</h2>
+
+<p>By default, if a node has service &lsquo;tor&rsquo; 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.</p>
<ul>
-<li><code>tor</code> + <code>openvpn</code>: when combined with <code>openvpn</code> nodes, <code>tor</code> 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.</li>
-<li><code>tor</code> + <code>webapp</code>: when combined with a <code>webapp</code> node, the <code>tor</code> service will make the webapp and the API available via .onion hidden service.</li>
-<li><code>tor</code> stand alone: a regular Tor exit node.</li>
+<li><code>tor.bandwidth_rate</code>: the max bandwidth allocated to Tor, in KB per second, when used as an exit node (default: 6550 KB/sec).</li>
+<li><code>tor.type</code>: what type of tor node to make, at this moment only &lsquo;exit&rsquo; is supported. If not specified, acts as a relay.</li>
+<li><code>tor.contacts</code>: the contact information for the relay (default: the list of provider contacts)</li>
+<li><code>tor.nickname</code>: the nickname of the relay (default: a combination of the node name and a hash of the family)</li>
+<li><code>tor.family</code>: a list of the other nicknames that are part of the same provider</li>
+<li><code>tor.hidden_service</code>: to enable a hidden service, set &lsquo;active&rsquo; to be true (see below for an example), do <em>not</em> configure &ldquo;services&rdquo;: [&ldquo;tor&rdquo;] for the node!</li>
</ul>
-<p>If activated, you can list the hidden service .onion addresses this way:</p>
+<p>Examples:</p>
-<p> leap ls &ndash;print tor.hidden_service.address tor</p>
+<p>To add a relay to a node:</p>
-<p>Then just add &lsquo;.onion&rsquo; to the end of the printed addresses.</p>
+<pre><code>{
+ "services": ["tor"]
+}
+</code></pre>
-<h2><a name="configuration"></a>Configuration</h2>
+<p>To enable a hidden service, without a relay, do <em>not</em> 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: <a href="https://trac.torproject.org/8742">https://trac.torproject.org/8742</a>), instead configure the node to have the following:</p>
-<ul>
-<li><code>tor.bandwidth_rate</code>: the max bandwidth allocated to Tor, in KB per second, when used as an exit node.</li>
-</ul>
+<pre><code>{
+ "tor": {
+ "hidden_service": {
+ "active": true
+ }
+}
+</code></pre>
+<p>If activated, you can list the hidden service .onion addresses this way:</p>
+
+<p> leap ls &ndash;print tor.hidden_service.address tor</p>
+
+<p>Then just add &lsquo;.onion&rsquo; to the end of the printed addresses.</p>
-<p>For example:</p>
+<p>To enable a Tor exit node:</p>
<pre><code>{
"tor": {
- "bandwidth_rate": 6550
+ "bandwidth_rate": 6550,
+ "type": "exit"
}
}
</code></pre>