diff options
author | elijah <elijah@riseup.net> | 2014-04-27 15:39:46 -0700 |
---|---|---|
committer | elijah <elijah@riseup.net> | 2014-04-27 15:39:46 -0700 |
commit | 7aba4766802ea13c063f546a51861d7ebf6533d5 (patch) | |
tree | 4fba04f1cb0e4c49d2fc097a3f01373364bd26d6 /docs | |
parent | 9657693d708c85e7178854c97b134c75fc0e1a16 (diff) |
added services <> node type table.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/platform/guide.md | 56 |
1 files changed, 52 insertions, 4 deletions
diff --git a/docs/platform/guide.md b/docs/platform/guide.md index 99147a8..4b3086e 100644 --- a/docs/platform/guide.md +++ b/docs/platform/guide.md @@ -16,15 +16,15 @@ When adding a new node to your provider, you should ask yourself four questions: Brief overview of the services: * **webapp**: The web application. Runs both webapp control panel for users and admins as well as the REST API that the client uses. Needs to communicate heavily with `couchdb` nodes. You need at least one, good to have two for redundancy. The webapp does not get a lot of traffic, so you will not need many. -* **couchdb**: The database for users and user data. You can get away with just one, but for proper redundancy you should have at least three. Communicates heavily with `webapp` and `mx` nodes. -* **soledad**: Handles the data syncing with clients. Typically combined with `couchdb` service, since it communicates heavily with couchdb. (not currently in stable release) -* **mx**: Incoming and outgoing MX servers. Communicates with the public internet, clients, and `couchdb` nodes. (not currently in stable release) +* **couchdb**: The database for users and user data. You can get away with just one, but for proper redundancy you should have at least three. Communicates heavily with `webapp`, `mx`, and `soledad` nodes. +* **soledad**: Handles the data syncing with clients. Typically combined with `couchdb` service, since it communicates heavily with couchdb. +* **mx**: Incoming and outgoing MX servers. Communicates with the public internet, clients, and `couchdb` nodes. * **openvpn**: OpenVPN gateway for clients. You need at least one, but want as many as needed to support the bandwidth your users are doing. The `openvpn` nodes are autonomous and don't need to communicate with any other nodes. Often combined with `tor` service. * **monitor**: Internal service to monitor all the other nodes. Currently, you can have zero or one `monitor` nodes. * **tor**: Sets up a tor exit node, unconnected to any other service. * **dns**: Not yet implemented. -webapp +Webapp ----------------------------------- The webapp node is responsible for both the user face web application and the API that the client interacts with. @@ -45,6 +45,54 @@ And then redeploy to all webapp nodes: By putting this in `services/webapp.json`, you will ensure that all webapp nodes inherit the value for `webapp.admins`. +Services +================================ + +What nodes do you need for a provider that offers particular services? + +<table class="table table-striped"> +<tr> +<th>Node Type</th> +<th>VPN Service</th> +<th>Email Service</th> +</tr> +<tr> +<td>webapp</td> +<td>required</td> +<td>required</td> +</tr> +<tr> +<td>couchdb</td> +<td>required</td> +<td>required</td> +</tr> +<tr> +<td>soledad</td> +<td>not used</td> +<td>required</td> +</tr> +<tr> +<td>mx</td> +<td>not used</td> +<td>required</td> +</tr> +<tr> +<td>openvpn</td> +<td>required</td> +<td>not used</td> +</tr> +<tr> +<td>monitor</td> +<td>optional</td> +<td>optional</td> +</tr> +<tr> +<td>tor</td> +<td>optional</td> +<td>optional</td> +</tr> +<table> + Locations ================================ |