summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorKali Kaneko <kali@leap.se>2017-06-24 00:47:01 +0200
committerKali Kaneko <kali@leap.se>2017-06-24 00:53:45 +0200
commit1d1dd3dab85d0e356330cc67feaf47d6518543fc (patch)
tree71b18052b83ca0ad0eee50897fdd976559e8ca88 /README.rst
parenta9cd80202515bad8507eeb457cf8004e2adc48c5 (diff)
[docs] update Readme with extra dependenciesonepython
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst29
1 files changed, 14 insertions, 15 deletions
diff --git a/README.rst b/README.rst
index d8713df6..e5304f2a 100644
--- a/README.rst
+++ b/README.rst
@@ -8,30 +8,27 @@ LEAP project, an API for data storage and sync.
This software is under development.
-There are currently three python packages maintained under this
-repository:
+From version ``0.9.7`` on, soledad is a single package, with extra dependencies
+for the client and the server backends.
-**leap.soledad.common** common pieces.
+**leap.soledad**
.. image:: https://badge.fury.io/py/leap.soledad.common.svg
:target: http://badge.fury.io/py/leap.soledad.common
.. image:: https://img.shields.io/pypi/dm/leap.soledad.common.svg
:target: http://badge.fury.io/py/leap.soledad.common
-**leap.soledad.client** where the soledad client lives.
-.. image:: https://badge.fury.io/py/leap.soledad.client.svg
- :target: http://badge.fury.io/py/leap.soledad.client
-.. image:: https://img.shields.io/pypi/dm/leap.soledad.client.svg
- :target: http://badge.fury.io/py/leap.soledad.client
+Installing extra dependencies
+-----------------------------
-**leap.soledad.server** oh surprise! bits needed for the soledad server.
+The client backend is based on sqlcipher::
-.. image:: https://badge.fury.io/py/leap.soledad.server.svg
- :target: http://badge.fury.io/py/leap.soledad.server
-.. image:: https://img.shields.io/pypi/dm/leap.soledad.server.svg
- :target: http://badge.fury.io/py/leap.soledad.server
+ pip install ".[client]"
+The server depends on CouchDB::
+
+ pip install ".[server]"
Compatibility
-------------
@@ -68,14 +65,15 @@ system.
.. _`CouchDB`: https://couchdb.apache.org/
Privileges
------
+----------
In order to prevent privilege escalation, Soledad should not be run as a
database administrator. This implies the following side effects:
-----------------
Database creation:
-----------------
-Can be done via a script located in ``server/pkg/create-user-db``
+
+Can be done via a script located in ``pkg/server/create-user-db``
It reads a netrc file that should be placed on
``/etc/couchdb/couchdb-admin.netrc``.
That file holds the admin credentials in netrc format and should be accessible
@@ -96,5 +94,6 @@ automatically by the server, following the same logic as u1db server.
------------------
Database deletion:
------------------
+
No code at all handles this and privilege to do so needs to be removed as
explained before. This can be automated via a simple cron job.