diff options
| -rw-r--r-- | debian/manpages | 1 | ||||
| -rwxr-xr-x | debian/rules | 4 | ||||
| -rw-r--r-- | debian/soledad-server.install | 1 | ||||
| -rw-r--r-- | docs/man/soledad-server.1.rst | 76 | ||||
| -rw-r--r-- | pkg/server/soledad-server.conf.default | 15 |
5 files changed, 95 insertions, 2 deletions
diff --git a/debian/manpages b/debian/manpages index 42fb695f..22844b37 100644 --- a/debian/manpages +++ b/debian/manpages @@ -1 +1,2 @@ docs/man/soledad-create-userdb.1 +docs/man/soledad-server.1 diff --git a/debian/rules b/debian/rules index e78a8c31..ee6e33e2 100755 --- a/debian/rules +++ b/debian/rules @@ -14,7 +14,7 @@ NAME=soledad-server dh $@ --with python2 --namespace=leap.soledad --buildsystem=pybuild --with=systemd override_dh_prep: - rst2man docs/man/soledad-create-userdb.1.rst docs/man/soledad-create-userdb.1 + (cd ./docs/man; for src in *.rst; do tgt=$$(basename $${src} .rst); rst2man $${src} $${tgt}; done) dh_prep override_dh_installinit: @@ -25,4 +25,4 @@ override_dh_auto_clean: dh_auto_clean find . -name "*.pyc" -exec rm -rf {} \; find . -name ".tox" -exec rm -rf {} \; - rm -f docs/man/soledad-create-userdb.1 + rm -f docs/man/*.1 diff --git a/debian/soledad-server.install b/debian/soledad-server.install index bb80e20a..998df1ca 100644 --- a/debian/soledad-server.install +++ b/debian/soledad-server.install @@ -1,5 +1,6 @@ debian/python-leap.soledad/usr/bin/soledad-server usr/bin/ pkg/server/soledad-create-userdb usr/bin/ pkg/server/soledad-sudoers etc/sudoers.d/ +pkg/server/soledad-server.conf.default usr/share/doc/soledad-server/ src/leap/soledad/server usr/lib/python2.7/dist-packages/leap/soledad/ scripts/migration usr/share/soledad-server/ diff --git a/docs/man/soledad-server.1.rst b/docs/man/soledad-server.1.rst new file mode 100644 index 00000000..3d37a8d2 --- /dev/null +++ b/docs/man/soledad-server.1.rst @@ -0,0 +1,76 @@ +============== +soledad-server +============== + +----------------------- +Run the Soledad Server. +----------------------- + +:Author: The LEAP Encryption Access Project https://leap.se +:Copyright: GPLv3+ +:Manual section: 1 +:Manual group: General Commands Manual + +SYNOPSIS +======== + +``soledad-server`` [-v|--version] [-h|--help] + +DESCRIPTION +=========== + +``soledad-server`` runs the Soledad Server, which consists of two HTTP APIs +listening on different ports. By default, the ``Users HTTP API`` is provided +publicly in port 2323 through TLS-encrypted connections, and the ``Services +HTTP API`` is provided locally in port 2525 through plaintext connections. + +For more information and the complete documentation, see +`https://soledad.readthedocs.io/` and `https://leap.se/en/docs/design/soledad`. + +OPTIONS +======= + +--version + Print the version of the server and exit. + +-h, --help + Print a help message and exit. + +FILES +===== + +/etc/soledad/soledad-server.conf + The Soledad Server configuration file. See the possible options and their + default values in + `/usr/share/doc/soledad-server/soledad-server.conf.default`. + +/etc/soledad/services.tokens + File containing authentication information for local services. Each line + should be a `username`:`token` pair. + +ENVIRONMENT +=========== + +HTTPS_PORT + Public HTTPS Users API (2323 by default). + +LOCAL_SERVICES_PORT + Local HTTP Services API port (2525 by default). + +SOLEDAD_SERVER_CONFIG_FILE + Load configuration from this file instead of using the default one + (*/etc/soledad/soledad-server.conf*). + +SOLEDAD_HTTP_PERSIST + If set, persist HTTP connections. + +SOLEDAD_USE_PYTHON_LOGGING + If set, use python logging instead of twisted's logger. + +SOLEDAD_LOG_TO_STDOUT + If set, log to standard output. + +BUGS +==== + +Please report any bugs to https://leap.se/code/projects/report-issues diff --git a/pkg/server/soledad-server.conf.default b/pkg/server/soledad-server.conf.default new file mode 100644 index 00000000..92131012 --- /dev/null +++ b/pkg/server/soledad-server.conf.default @@ -0,0 +1,15 @@ +[soledad-server] +couch_url=http://localhost:5984 +create_cmd= +admin_netrc=/etc/couchdb/couchdb-admin.netrc +batching=true +blobs=false +blobs_path=/var/lib/soledad/blobs +services_tokens_file=/etc/soledad/services.tokens +concurrent_blob_writes=50 + +[database-security] +members=soledad +members_roles= +admins= +admins_roles= |