diff options
| author | drebs <drebs@leap.se> | 2017-12-19 15:22:07 -0200 |
|---|---|---|
| committer | drebs <drebs@leap.se> | 2017-12-19 15:22:41 -0200 |
| commit | e2d4f002d861f62b43016c71702d83af0a6bdd18 (patch) | |
| tree | 503e3039dc5f11eae41ce2942330c5133e0e2045 | |
| parent | a3e3307fdc384be45ce4c62b95585d1825d4c849 (diff) | |
[doc] small improvements in server doc
| -rw-r--r-- | docs/server.rst | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/docs/server.rst b/docs/server.rst index f06668d7..08a83ae4 100644 --- a/docs/server.rst +++ b/docs/server.rst @@ -15,38 +15,38 @@ Soledad Server looks for a configuration file in ``/etc/soledad/soledad-server.conf`` and will read the following configuration options from the ``[soledad-server]`` section: -====================== =============================================== ================================ -Option Description Default value -====================== =============================================== ================================ -couch_url The URL of the CouchDB backend storage. ``http://localhost:5984`` -create_cmd The shell command to create user databases. None -admin_netrc The netrc file to be used for authenticating ``/etc/couchdb/couchdb.netrc`` - with the CouchDB backend storage. -batching Whether to use batching capabilities for ``true`` - synchronization. -blobs Whether to provide the Blobs functionality or ``false`` - not. -blobs_path The path for blobs storage in the server's file ``/var/lib/soledad/blobs`` - system. -concurrent_blob_writes Limit of concurrent blob writes to the 50 - filesystem. -services_tokens_file The file containing authentication tokens for ``/etc/soledad/services.tokens`` - services provided through the Services API. -====================== =============================================== ================================ +========================== =============================================== ================================ +Option Description Default value +========================== =============================================== ================================ +``couch_url`` The URL of the CouchDB backend storage. ``http://localhost:5984`` +``create_cmd`` The shell command to create user databases. None +``admin_netrc`` The netrc file to be used for authenticating ``/etc/couchdb/couchdb.netrc`` + with the CouchDB backend storage. +``batching`` Whether to use batching capabilities for ``true`` + synchronization. +``blobs`` Whether to provide the Blobs functionality or ``false`` + not. +``blobs_path`` The path for blobs storage in the server's file ``/var/lib/soledad/blobs`` + system. +``concurrent_blob_writes`` Limit of concurrent blob writes to the 50 + filesystem. +``services_tokens_file`` The file containing authentication tokens for ``/etc/soledad/services.tokens`` + services provided through the Services API. +========================== =============================================== ================================ Running ------- -This is written as a Twisted application and intended to be run using the -twistd command. To start the soledad server, run: +Soledad Server is written as a Twisted application and intended to be run using +the ``twistd`` command. To start the server, run: .. code-block:: bash twistd -n --python /path/to/leap/soledad/server/server.tac -An systemd script is included in the `Debian packages -<http://deb.leap.se/repository/>`_ to make it feasible to start and stop the -Soledad server service using a standard interface. +A `systemd <https://www.freedesktop.org/wiki/Software/systemd/>`_ script is +included in the `Debian package <http://deb.leap.se/repository/>`_ so the +server can be managed using a standard interface. Migrations ---------- |