diff options
Diffstat (limited to 'docs/client.rst')
| -rw-r--r-- | docs/client.rst | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/docs/client.rst b/docs/client.rst index 0baba7e8..fbced197 100644 --- a/docs/client.rst +++ b/docs/client.rst @@ -7,34 +7,34 @@ The Soledad Client is a Python library aimed to provide access to a document store that can be synchronized securelly with other deviced through the Soledad Server. Key aspects of Soledad Client include: - * **Encrypted local storage:** All data cached locally is stored in an - encrypted database. +* **Encrypted local storage:** All data cached locally is stored in an + encrypted database. - * **Client-side encrypted sync:** Soledad puts very little trust in the - server by encrypting all data before it is synchronized to the server and - by limiting ways in which the server can modify the user's data. +* **Client-side encrypted sync:** Soledad puts very little trust in the + server by encrypting all data before it is synchronized to the server and + by limiting ways in which the server can modify the user's data. - * **Document database:** An application using the Soledad client library is - presented with a document-centric database API for storage and sync. - Documents may be indexed, searched, and versioned. +* **Document database:** An application using the Soledad client library is + presented with a document-centric database API for storage and sync. + Documents may be indexed, searched, and versioned. - * **Blobs storage:** The client and server API provide blobs storage, which - can be used both for data delivery in the server side (i.e. email) and - payload storage on the client side. +* **Blobs storage:** The client and server API provide blobs storage, which + can be used both for data delivery in the server side (i.e. email) and + payload storage on the client side. Setting-up ---------- The following information is needed in order to instantiate a soledad client: - * ``uuid``: the user's uuid. - * ``passphrase``: the user's passphrase. - * ``secrets_path``: a local path for secrets storage. - * ``local_db_path``: a local path for the documents database. - * ``server_url``: the Soledad Server's URL. - * ``cert_file``: a local path for the CA certificate. - * ``auth_token``: an authentication token obtained after logging into the - provider. +* ``uuid``: the user's uuid. +* ``passphrase``: the user's passphrase. +* ``secrets_path``: a local path for secrets storage. +* ``local_db_path``: a local path for the documents database. +* ``server_url``: the Soledad Server's URL. +* ``cert_file``: a local path for the CA certificate. +* ``auth_token``: an authentication token obtained after logging into the + provider. Once all pieces are in place, you can instantiate the client as following: |