blob: aa4ffc73816542cbd15c76abfbb870f8763a1562 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
@nav_title = "Services"
@title = "Guide to node services"
@summary = ""
@toc = true
# Introduction
Every node (server) must have one or more `services` defined that determines what role the node performs. For example:
```
cat nodes/stallman.json
{
"ip_address": "199.99.99.1",
"services": ["webapp", "tor"]
}
```
Here are common questions to ask when adding a new node to your provider:
* **many or few?** Some services benefit from having many nodes, while some services are best run on only one or two nodes.
* **required or optional?** Some services are required, while others can be left out.
* **who does the node communicate with?** Some services communicate very heavily with other particular services. Nodes running these services should be close together.
* **public or private network?** Some services communicate with the public internet, while others only need to communicate with other nodes in the infrastructure.
# Available services
<table class="table table-striped">
<tr>
<th>Service</th>
<th>VPN</th>
<th>Email</th>
<th>Notes</th>
</tr>
<tr>
<td>webapp</td>
<td><i class="fa fa-circle"></i></td>
<td><i class="fa fa-circle"></i></td>
<td>User control panel, provider API, and support system.</td>
</tr>
<tr>
<td>couchdb</td>
<td><i class="fa fa-circle"></i></td>
<td><i class="fa fa-circle"></i></td>
<td>Data storage for everything. Private node.</td>
<td></td>
</tr>
<tr>
<td>soledad</td>
<td><i class="fa fa-circle-o"></i></td>
<td><i class="fa fa-circle"></i></td>
<td>User data synchronization daemon. Usually paired with <code>couchdb</code> nodes.</td>
<td></td>
</tr>
<tr>
<td>mx</td>
<td><i class="fa fa-circle-o"></i></td>
<td><i class="fa fa-circle"></i></td>
<td>Incoming and outgoing MX servers.</td>
</tr>
<tr>
<td>openvpn</td>
<td><i class="fa fa-circle"></i></td>
<td><i class="fa fa-circle-o"></i></td>
<td>OpenVPN gateways.</td>
</tr>
<tr>
<td>monitor</td>
<td><i class="fa fa-dot-circle-o"></i></td>
<td><i class="fa fa-dot-circle-o"></i></td>
<td>Nagios monitoring. This service must be on the webapp node.</td>
</tr>
<tr>
<td>tor</td>
<td><i class="fa fa-dot-circle-o"></i></td>
<td><i class="fa fa-dot-circle-o"></i></td>
<td>Tor exit node.</td>
</tr>
</table>
Key: <i class="fa fa-circle"> Required</i>, <i class="fa fa-dot-circle-o"> Optional</i>, <i class="fa fa-circle-o"> Not Used</i>
<%= child_summaries %>
|
