summaryrefslogtreecommitdiff
path: root/scripts/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/README.rst')
-rw-r--r--scripts/README.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/scripts/README.rst b/scripts/README.rst
new file mode 100644
index 00000000..fdd1d642
--- /dev/null
+++ b/scripts/README.rst
@@ -0,0 +1,17 @@
+Soledad Scripts
+===============
+
+The scripts in this directory are meant to be used for development purposes.
+
+Currently, the scripts are:
+
+ * server-side-db.py: Gives access to server-side soledad user database,
+ based on the configuration in /etc/leap/soledad-server.conf. One should
+ use it as:
+
+ python -i server-side-db.py <uuid>
+
+ * client-side-db.py: Gives access to client-side soledad user database,
+ based on data stored in ~/.config/leap/soledad. One should use it as:
+
+ python -i client-side-db.py <uuid> <passphrase>