setup.rst 3.21 KB
Newer Older
1 2
.. _installation:

3 4 5 6
Installation
============

There are packages to easily install and run the application in all major
7
platforms. You can download them from the `Agkyra home page`_.
8 9 10 11

Linux
-----

12
Untar the agkyra package and run the executable `agkyra`.
13 14 15 16

Windows
-------

17
Unzip the agkyra package and double-click the executable `agkyra.exe`.
18 19 20 21

Mac OS X
--------

22
Unzip the agkyra package and double-click the app `Agkyra.app`.
23 24 25

.. _setup:

26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
Setup
=====

Some essential settings must be provided in order for Agkyra to start syncing:

* A synnefo cloud URL
* A user authentication token
* A remote container (if it does not exist, it will be created)
* A local directory (if it does not exist, it will be created)

.. note:: The full list of settings is detailed in the settings section

If any of the above is missing or is outdated, agkyra will not be able to
function properly. There are several ways to provide and update these settings

GUI
---

Start agkyra (in GUI mode by default). If some of the required settings are
missing, or the token fails to authenticate, the `Settings` window will pop up.
Otherwise, click the tray icon and choose "Settings".

In the `Settings` window:

* The **cloud URL** must be provided manually.
* To get the **user token**, click the "Login to retrieve token" to authenticate with a username and password. It has to be re-retrieved every time it expires or is invalidated in any other way.
* Write the **container** name in the corresponding field. If the container does not exist, it will be created automatically, otherwise the contained data will be preserved and synchronized.
* Select the **local directory** by clicking the `Select` button and using the pop up dialog.

To apply the settings, press the `Save` button. If the Settings window is
closed without saving, all changes will be lost.

CLI
---

61
Use the **agkyra config** commands to set and update settings:
62 63 64 65

.. code-block:: console

    --- Set up a cloud named CLD ---
66 67
    $ agkyra config set cloud CLD url http://www.example.org/identity/v2.0
    $ agkyra config set cloud CLD token ex4mpl3-t0k3n
68 69

    --- Set up a sync (cloud, local directory, container) named SNC ---
70 71 72
    $ agkyra config set sync SNC directory /my/local/directory
    $ agkyra config set sync SNC cloud CLD
    $ agkyra config set sync SNC container remote_container
73 74

    --- Set the SNC sync as the default ---
75
    $ agkyra config set default_sync CLD
76 77


78
.. note:: use the **agkyra config list** command for the current settings
79 80 81 82 83 84 85 86 87 88 89 90 91


Config file
-----------

The config file is `HOME_DIRECTORY/.agkyra/config.rc` and can be edited,
although this practice is discouraged. The config file format is modeled after
the corresponding `kamaki.rc` format.

Here is a typical configuration:

.. code-block:: text

92
    # Agkyra configuration file version XXX
93 94 95
    [global]
    default_sync = CLD
    language = en
96
    ask_to_sync = on
97 98 99 100 101 102 103 104 105 106 107 108 109

    [cloud "CLD"]
    url = http://www.example.org/identity/v2.0
    token = ex4mpl3-t0k3n

    [sync "SNC"]
    directory = /my/local/directory
    container = agkyra
    cloud = CLD

Users can create as many clouds and syncs as they like, but only the
`default_sync` cloud is running each time `agkyra` is launched.

110 111 112
.. External links

.. _Agkyra home page: https://www.synnefo.org/agkyra/