Commit e5535f42 authored by Giorgos Korfiatis's avatar Giorgos Korfiatis
Browse files

docs: Explain retrieving credentials

parent 8a7f9bff
...@@ -6,16 +6,17 @@ ...@@ -6,16 +6,17 @@
BaaS User Guide BaaS User Guide
=============== ===============
BaaS (Backup as a Service) is a service provided to Synnefo users in order to BaaS (Backup as a Service) is a service provided to Synnefo cloud users in
backup their data to `Pithos`_ Storage. It supports encrypted, incremental backups order to backup their data to `Pithos`_ Storage. It supports encrypted,
in a space and bandwidth-efficient way through a Graphical User Interface (GUI) incremental backups in a space and bandwidth-efficient way through a
as well as a Command Line Interface (CLI). user-friendly Graphical User Interface (GUI).
BaaS uses `Duplicity`_ as the backend. BaaS uses `Duplicity`_ as the backend.
BaaS GUI is implemented and supported by the `Synnefo Development Team`_ of the BaaS is implemented and supported by the `Synnefo Development Team`_ of the
`Greek Research and Technology Network`_ and is an open source project, licensed `Greek Research and Technology Network`_ and is an open source project,
under GPL v3. licensed under GPL v3.
Contents: Contents:
......
...@@ -30,23 +30,24 @@ Setup ...@@ -30,23 +30,24 @@ Setup
In order to create your first backup set or to restore In order to create your first backup set or to restore
an existing one you will need: an existing one you will need:
* A synnefo cloud URL * the cloud authentication URL
* A user authentication token * your user authentication token
If any of the above is missing or is outdated, BaaS will not be able to If any of the above is missing or the token has expired, BaaS will not be
function properly. able to function properly.
GUI GUI
--- ---
Start BaaS in GUI mode. If a cloud configuration is missing you will be prompted Start BaaS. If a cloud configuration is missing, you will be prompted to add
to add one in `Cloud Settings` section: one in `Cloud Settings` section. To get your cloud credentials, browse to
your cloud website, log in and click on `API access`.
* The **Cloud URL** must be provided manually. * The **Cloud URL** must be provided manually.
* To get the **User token** click "Login to retrieve token" to authenticate * The **User token** can be automatically retrieved, by clicking on
with a user name and password. It has to be re-retrieved every time it "Auto-fill token with login". You will just need to authenticate to your
expires or is invalidated in any other way. cloud system.
Config file Config file
----------- -----------
...@@ -68,22 +69,6 @@ Here is a typical example: ...@@ -68,22 +69,6 @@ Here is a typical example:
} }
} }
CLI
---
BaaS uses `Duplicity`_ as the backend.
Before using it with Synnefo, two environment variables must be set:
.. code-block:: console
$ export SWIFT_PREAUTHURL = "https://pithos.okeanos.grnet.gr/object-store/v1/<uuid>"
$ export SWIFT_PREAUTHTOKEN = <user token>
Where uuid is your ~Okeanos user ID.
.. note:: In Windows duplicity runs with Cygwin which is provided with the current installation.
.. External links .. External links
.. _BaaS home page: https://www.synnefo.org/baas/ .. _BaaS home page: https://www.synnefo.org/baas/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment