blob: 8237b3e4bc71b5f23c9b2483fd412ed4bdc972ce (
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
<!DOCTYPE html>
<html lang='en'>
<head>
<title>
Services - LEAP Platform Documentation
</title>
<meta content='width=device-width, initial-scale=1.0' name='viewport'>
<meta charset='UTF-8'>
<base href="" />
<style>
body {
background: #444;
display: flex;
flex-direction: row;
padding: 10px;
margin: 0px;
}
#sidebar {
flex: 0 0 250px;
background: white;
margin-right: 10px;
padding: 20px;
}
#sidebar ul {
list-style-type: none;
padding-left: 0px;
margin: 0;
}
#sidebar li { padding: 4px }
#sidebar li a { text-decoration: none }
#sidebar li.active { background: #444 }
#sidebar li.active a { color: white }
#sidebar li.level1 { padding-left: 20px }
#sidebar li.level2 { padding-left: 40px }
#main {
flex: 1 1 auto;
background: white;
padding: 20px;
}
#title-box {
padding-bottom: 20px;
border-bottom: 5px solid #eee;
}
#title-box h1 {
margin-top: 0px;
}
pre {
padding: 10px;
background: #eef;
}
code {
background: #eef;
}
table {border-collapse: collapse}
table td {
border: 1px solid #ccc;
padding: 4px;
vertical-align: top;
}
</style>
</head>
<body>
<div id='sidebar'>
<ul>
<li class=''>
<a href='../index.html'>Home</a>
</li>
<li class=' level0'>
<a class='' href='guide.html'>Guide</a>
</li>
<li class=' level0'>
<a class='' href='tutorials.html'>Tutorials</a>
</li>
<li class='active level0'>
<a class='' href='services.html'>Services</a>
</li>
<li class=' level1'>
<a class='' href='services/couchdb.html'>couchdb</a>
</li>
<li class=' level1'>
<a class='' href='services/openvpn.html'>openvpn</a>
</li>
<li class=' level1'>
<a class='' href='services/monitor.html'>monitor</a>
</li>
<li class=' level1'>
<a class='' href='services/mx.html'>mx</a>
</li>
<li class=' level1'>
<a class='' href='services/soledad.html'>soledad</a>
</li>
<li class=' level1'>
<a class='' href='services/tor.html'>tor</a>
</li>
<li class=' level1'>
<a class='' href='services/webapp.html'>webapp</a>
</li>
<li class=' level0'>
<a class='' href='upgrading.html'>Upgrading</a>
</li>
<li class=' level0'>
<a class='' href='troubleshooting.html'>Troubleshooting</a>
</li>
<li class=' level0'>
<a class='' href='details.html'>Details</a>
</li>
</ul>
</div>
<div id='main'>
<div id='title-box'>
<h1>Guide to node services</h1>
<div id='summary'></div>
</div>
<div id='content-box'>
<div id="TOC"><ol>
<li>
<a href="services/index.html#introduction">Introduction</a>
</li>
<li>
<a href="services/index.html#available-services">Available services</a>
</li>
</ol></div>
<h1><a name="introduction"></a>Introduction</h1>
<p>Every node (server) must have one or more <code>services</code> defined that determines what role the node performs. For example:</p>
<pre><code>workstation$ cat nodes/stallman.json
{
"ip_address": "199.99.99.1",
"services": ["webapp", "tor"]
}
</code></pre>
<p>Here are common questions to ask when adding a new node to your provider:</p>
<ul>
<li><strong>many or few?</strong> Some services benefit from having many nodes, while some services are best run on only one or two nodes.</li>
<li><strong>required or optional?</strong> Some services are required, while others can be left out.</li>
<li><strong>who does the node communicate with?</strong> Some services communicate very heavily with other particular services. Nodes running these services should be close together.</li>
<li><strong>public or private network?</strong> Some services communicate with the public internet, while others only need to communicate with other nodes in the infrastructure.</li>
</ul>
<h1><a name="available-services"></a>Available services</h1>
<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>
<p>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></p>
<p><div class=' page-summary'>
<h2>
<a href='services/couchdb.html'>couchdb</a>
</h2>
<div class='summary'>Data storage for all user data.</div>
</div>
<div class=' page-summary'>
<h2>
<a href='services/openvpn.html'>openvpn</a>
</h2>
<div class='summary'>OpenVPN egress gateways</div>
</div>
<div class=' page-summary'>
<h2>
<a href='services/monitor.html'>monitor</a>
</h2>
<div class='summary'>Nagios monitoring and continuous testing.</div>
</div>
<div class=' page-summary'>
<h2>
<a href='services/mx.html'>mx</a>
</h2>
<div class='summary'>Incoming and outgoing MX servers.</div>
</div>
<div class=' page-summary'>
<h2>
<a href='services/soledad.html'>soledad</a>
</h2>
<div class='summary'>User data synchronization daemon</div>
</div>
<div class=' page-summary'>
<h2>
<a href='services/tor.html'>tor</a>
</h2>
<div class='summary'>Tor services: relay, exit node and hidden service</div>
</div>
<div class=' page-summary'>
<h2>
<a href='services/webapp.html'>webapp</a>
</h2>
<div class='summary'>leap_web user management application and provider API.</div>
</div>
</p>
</div>
</div>
</body>
</html>
|
