.. _cyberduck:

*********
Cyberduck
*********

In this page you will find documentation about the usage of Cyberduck. 

.. contents:: 
    :depth: 4

Cyberduck offers a GUI to connect to almost a gazillion different storage systems with equally many protocols to copy, put, get and delete files and folders.
It can also be used to connect to Openstack SWIFT.
Cyberduck can be downloaded from https://cyberduck.io/ and is available for MS Windows and Mac OSX. 

======
Config
======

V3 authentication
-----------------

Users using their SURF Central User Administration (CUA) account need to use keystone V3 authentication. We have provided a pre-configured profile for you. You can download it from: :download:`surfswiftv3.cyberduckprofile <../../Scripts/cyberduck_profile/surfswiftv3.cyberduckprofile>`. Double click this file to install and register it.

For this profile you need to supply the **Project Name**, the **User Domain** and the **User Name**. For CUA users, the **User Domain** has to be set to **CuaUsers**. If you have a local account, then you can also use this profile, but **User Domain** has to be set to **Default**. Finally you have to supply your password.

Creating a new bookmark, for example, works as follows:

.. image:: /Images/cyberduckv3.png
           :width: 650px


S3 authentication
-----------------

It is also possible to use your S3 credentials to connect Cyberduck to SWIFT. Also for this case we have prepared a pre-configured profile that can be downloaded from: :download:`surfs3.cyberduckprofile <../../Scripts/cyberduck_profile/surfs3.cyberduckprofile>`. Double click this file to install and register it.

For the profile, you need to supply your EC2 credentials, the **Access Key** and the **Secret Key**. 

Creating a new bookmark, for example, works as follows:

.. image:: /Images/cyberducks3.png
           :width: 650px

====
Duck
====

Cyberduck al has a commandline client, called duck. It is available on MS Windows, Mac OSX and Linux. Information on how to install it is available at: https://trac.cyberduck.io/wiki/help/en/howto/cli. 

Information on how to use it is obtained by:

.. code-block:: bash

    duck --help

You need to install de profile :download:`surfswiftv3.cyberduckprofile <../../Scripts/cyberduck_profile/surfswiftv3.cyberduckprofile>` in ~/.duck/profiles.

Getting a listing of a container is done in the following manner:

.. code-block:: bash

    duck --username <project name:DOMAIN:user name> --password <password> -q -l surfswift://proxy.swift.surfsara.nl:5000/<container>

Users using keystone together with their SURF Central User Adminitration (CUA) account need to specify **CuaUsers** as **DOMAIN**. Users using local keystone account need to specify **default** as **DOMAIN**.