Note: this is a draft documention, the content is in progress

iRODS clients

Cyberduck

Cyberduck is a free and open-source cloud storage browser for Mac and Windows with support for multiple protocols FTP, SFTP, WebDAV, S3, iRODS,…

title	platform	interface	metadata support	protocols	server version	license
Cyberduck	Windows MacOS	Graphical	Non	WebDAV iRODS	3.x.x 4.x.x	GNU GPL

Observations: For best performance use iRODS protocol

Install Cyberduck

You can install Cyberduck for Mac OS or Microsoft Windows

Go to the Cyberduck installation page at https://cyberduck.io

Configure Cyberduck for use with iRODS protocol

To connect Cyberduck to IN2P3 service with iRODS protocol, you must first enable the iRODS protocol and create a bookmark using a .cyberduckprofile Connection Profile file.

1. Click in your irodsZone in next table to download the Connection Profile file (xml file), which contains preconfigured settings for using Cyberduck:

Download Connection Profiles

tempZone

euclid-fr

rhone-alpes

virgo

inee

eros

grand

ccin2p3

NOTE: Mac OS sometimes adds automatically .xml extension to this file therefore it will not be recognized by Cyberduck, in this case rename (remove) the .xml extension in file

NOTE: if your irodsZone is not the table go to section Configure your Connection Profile file

2. Double click the irods-in2p3.cyberduckprofile file to open it as a Cyberduck bookmark. The profile will open so you can edit the defaults.

3. Update the Cyberduck bookmark.

   • Update the Username and Password fields with your irodsUserName and password.

   • Verify the Server and Port fields with your irodsHost and irodsPort.

   • In the More Options section, update the Path field with your irodsHome.

   • In the More Options section, update the “Transfer Files” setting, selecting “Open multiple connections”.

   • Close the window.

Configure Cyberduck for use with WebDAV protocol

The WebDAV/HTTP protocol is enabled for some iRODS zones, which are listed in the next table, verify if your irodsZone has a WebDAV host enabled:

irodsZone	WebDAV host
tempZone	ccirdtest.in2p3.fr
euclid-fr	ccirdeuclid.in2p3.fr
rhone-alpes	ccirdtidra.in2p3.fr
virgo	ccirdvirgo.in2p3.fr
inee	ccirdinee.in2p3.fr
eros	ccirderos.in2p3.fr
grand	ccirdgrand.in2p3.fr

1. Click on Open Connection or Bookmark in main menu.

2. Update the Cyberduck Open Connection or Bookmark:

   • Select WebDAV (HTTPS) in first list dialog.

   • Update the Server with the WebDAV host for your irodsZone (above table).

   • Update the Username and Password fields with your irodsUserName and password.

   • Verify the Port field is 443.

   • In the More Options section, update the Path field with your irodsHome.

   • Close the window.

Configure your Connection Profile file

If your irodsZone is not proposed on Table Connection Profiles you can create a Connection Profile file:

1. Click this link to download a Connection Profile template, which contains preconfigured settings for using Cyberduck with iRODS.

2. Use a text editor to edit the contents of the Connection Profile.

At a minimum, you will need to edit the “Region” key with the iRODS Zone name in the format irods_zone_name: (ending with colon) and the “Default Port” with the irods_port.

Using Cyberduck

These instructions provide basic instructions for downloading and uploading files to iRODS using Cyberduck.

For more information on how to use Cyberduck, please see the Cyberduck documentation or contact Cyberduck Support.

Connect to iRODS

In the Cyberduck window, double-click a bookmark.

Download Files

Once connected, to download a file or folder from iRODS using Cyberduck:

1. Click the file or folder to download.

2. Click the Cyberduck File menu and then click Download. The file is downloaded to your default download folder.

Upload Files

To upload a file or folder to an iRODS service using Cyberduck:

• Click the Cyberduck Upload icon.

• Click the file or folder to upload and then click Upload.

To navigate to a different folder:

Click the Cyberduck Go menu and then click Go to Folder:

• Enter the path to the folder

• Click Go.