Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
soledad
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
leap
soledad
Commits
1d1dd3da
There was a problem fetching the pipeline summary.
Unverified
Commit
1d1dd3da
authored
7 years ago
by
Kali Kaneko
Browse files
Options
Downloads
Patches
Plain Diff
[docs] update Readme with extra dependencies
parent
a9cd8020
No related branches found
No related tags found
No related merge requests found
Pipeline
#
Changes
1
Pipelines
2
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.rst
+14
-15
14 additions, 15 deletions
README.rst
with
14 additions
and
15 deletions
README.rst
+
14
−
15
View file @
1d1dd3da
...
@@ -8,30 +8,27 @@ LEAP project, an API for data storage and sync.
...
@@ -8,30 +8,27 @@ LEAP project, an API for data storage and sync.
This software is under development.
This software is under development.
There are currently three python packages maintained under thi
s
From version ``0.9.7`` on, soledad is a single package, with extra dependencie
s
repository:
for the client and the server backends.
**leap.soledad
.common** common pieces.
**leap.soledad
**
.. image:: https://badge.fury.io/py/leap.soledad.common.svg
.. image:: https://badge.fury.io/py/leap.soledad.common.svg
:target: http://badge.fury.io/py/leap.soledad.common
:target: http://badge.fury.io/py/leap.soledad.common
.. image:: https://img.shields.io/pypi/dm/leap.soledad.common.svg
.. image:: https://img.shields.io/pypi/dm/leap.soledad.common.svg
:target: http://badge.fury.io/py/leap.soledad.common
: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
Installing extra dependencies
: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
**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
pip install ".[client]"
: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
The server depends on CouchDB::
pip install ".[server]"
Compatibility
Compatibility
-------------
-------------
...
@@ -68,14 +65,15 @@ system.
...
@@ -68,14 +65,15 @@ system.
.. _`CouchDB`: https://couchdb.apache.org/
.. _`CouchDB`: https://couchdb.apache.org/
Privileges
Privileges
-----
-----
-----
In order to prevent privilege escalation, Soledad should not be run as a
In order to prevent privilege escalation, Soledad should not be run as a
database administrator. This implies the following side effects:
database administrator. This implies the following side effects:
-----------------
-----------------
Database creation:
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
It reads a netrc file that should be placed on
``/etc/couchdb/couchdb-admin.netrc``.
``/etc/couchdb/couchdb-admin.netrc``.
That file holds the admin credentials in netrc format and should be accessible
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.
...
@@ -96,5 +94,6 @@ automatically by the server, following the same logic as u1db server.
------------------
------------------
Database deletion:
Database deletion:
------------------
------------------
No code at all handles this and privilege to do so needs to be removed as
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.
explained before. This can be automated via a simple cron job.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment