From e2d4f002d861f62b43016c71702d83af0a6bdd18 Mon Sep 17 00:00:00 2001 From: drebs Date: Tue, 19 Dec 2017 15:22:07 -0200 Subject: [doc] small improvements in server doc --- docs/server.rst | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-) (limited to 'docs/server.rst') 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 -`_ to make it feasible to start and stop the -Soledad server service using a standard interface. +A `systemd `_ script is +included in the `Debian package `_ so the +server can be managed using a standard interface. Migrations ---------- -- cgit v1.2.3