duma.md 6.59 KB
Newer Older
1
# Data Upload Manager - DUMA  Quick Guide
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

{{TOC}}

## Overview
DUMA is an IBM Aspera  deployment at the LCSB-University of Luxembourg. DUMA supports end-to-end encrypted data transfer and can handle high data volumes e.g. several tera bytes.

## Obtaining a DUMA access link

You need an **access link** to use DUMA. An access link is a temporary, password-protected space, much like a drop box, on LCSB's DUMA server. In order to obtain an access link, you should contact your research collaborator at the LCSB-University of Luxembourg. Once created, you will receive your **access link** and associated **password** (link) by e-mail.

**IMPORTANT NOTE: Whenever the LCSB shares a password for a DUMA endpoint (collaborator), the password be reachable via a link, which will expire. Therefore you should make a record of your password once you view it.**

An access link can be reached via standard web browsers. Data can be transferred to/from an access link in two ways:

* Through the web browser by visiting the link, which is our recommended way of data transfer, described in this [section of the guide](#DUMA_WEB)
* Through the use of a command line tool. If your data sits in an environment, where you can not launch a web browser, then you may use use a command line client tool to reach an access link. This process is described in this [section of this guide](#DUMA_CLI).  

19
The use of DUMA is mediated by LCSB's data stewards. If you require assistance in using DUMA, you should send an email to [LCSB admin team](mailto:lcsb-sysadmins@uni.lu).
20

21
<a name="DUMA_WEB"></a>
22
23
## Accessing DUMA via Web Interface

24
In the following steps we provide instructions on how to use DUMA web interface.
25
26
27
28
29
30
31

1. Once you receive your **access link** and **password** from the LCSB, visit the link using a standard web browser. Firefox 66.x (or higher) recommended, but others should also work. You will be prompted for your password (see below).<br/>
 ![Alt](duma_1.png "Title")

2. When you visit a DUMA access link for the very first time, you will be prompted to install **IBM Aspera Connect** client.
      * click **Download** or **Download latest version** links (see below). <br/>![Alt](duma_2.png "Title")

32

33
34

      * Your browser will download the client installer.
35
36

        ![Alt](duma_3.png "Title")
37
38
39
40


      * Run the installer till you receive the completion message.

41
42
43
44
45
46
47
        ![Alt](duma_4.png "Title")


      * Once **IBM Aspera Connect** client is installed, refresh the **access link**. You will be prompted whether you want to open **IBM Aspera Launcher**, click **Open**.

         ![Alt](duma_5.png "Title")

48
49
50
51

3. The **access link** page will display a **File Browser** section. Depending on the settings per access link, users can create or delete folders in the File Browser and upload or download data.<br/>
  ![Alt](duma_6.png "Title")

52

53
54
55
56

4. Clicking **Upload** or **Download** will launch the **IBM Aspera Connect** client on your computer. You first will be asked whether you allow the client to connect to aspera.lcsb.uni.lu. Choose **Allow**. <br/>
  ![Alt](duma_7.png "Title")

57

58
59

5. At any time you can launch **IBM Aspera Connect** to display the status of uploads to or downloads from your computer. <br/>
60
  ![Alt](duma_8.png "Title")
61

62
63
64
65
66
67


6. All data are encrypted on server side and they stay encrypted also upon download. For decryption, you have to navigate into your **IBM Aspera Connect** window and click "**Unlock encrypted files**". <br/>
  ![Alt](duma_9.png "Title") <br/>
You will be prompted for encryption passphrase which you should already have received from the repository administrator. <br/>
  ![Alt](duma_10.png "Title") <br/>
68
Encrypted files are by default kept on your disc after decryption. If you want to change this behaviour, navigate to Options->Settings and check "Delete encrypted files when finished" box.
69
70
71



72
73
<a name="DUMA_CLI"></a>
## Accessing DUMA via Command-Line Tool
74
In the following steps we describe instructions on how to use DUMA web interface.
75
76
77

1. **Install the aspera command line client.** The _ascp_ tool, which can be found [here](https://downloads.asperasoft.com/en/downloads/62) as instructed.

78
1. **Obtain tokens.** You will need **tokens** while using _ascp_. You will need a **download token** for download and a separate **upload token** for upload. Your tokens can be viewed by clicking the **Help** icon on your access link (see below).<br/>
79
80
     ![Alt](duma_help_link.png "Title") <br/><br/><br/>
     ![Alt](duma_cli_tokens.png "Title")
81
82
83
84

1. **Obtain encryption passphrase.** You should receive corresponding passphrase from repository administrator.

1. **Obtain SSH key.** You will also need an **SSH private key** to authenticate. This is the Aspera key that comes with the Aspera Connect installation named `asperaweb_id_dsa.openssh`. Below are locations where the ssh_key can be found:
85
86
87
88
89


    * On MAC
	  * Local installation of Aspera connect:
	    * `/Users/username/Applications/Aspera Connect.app/Contents/Resources/asperaweb_id_dsa.openssh`
90
	  * System wide installation of Connect:
91
92
93
	    * `/Applications/Aspera  Connect.app/Contents/Resources/asperaweb_id_dsa.openssh` 	

    * On WINDOWS
94
	  * Local installation of Aspera connect:
95
	    * `C:\\Users\username\AppData\Local\Programs\Aspera\Aspera Connect\etc\asperaweb_id_dsa.openssh` 	
96
	  * System wide installation of Connect:
97
	    * `C:\\Program Files (x86)\Aspera\Aspera Connect\etc\asperaweb_id_dsa.openssh`
98

99
    * On LINUX
100
	  * Local installation of Aspera connect:
101
	    * `/home/username/.aspera/connect/etc/asperaweb_id_dsa.openssh` 	
102
	  * System wide installation of Connect:
103
104
	    * `/opt/aspera/etc/asperaweb_id_dsa.openssh`

105
1. **Set necessary environment variables**.  `KEY` and `TOKEN` environment variables should be set as follows. If you do not have any of the tokens use `None` as the value.
106
107
108
109

	* `KEY=<path to the ssh key>`
	* `DTOKEN=<<<<YOUR DOWNLOAD TOKEN>>>>>>`
	* `UTOKEN=<<<<YOUR UPLOAD TOKEN>>>>>>`
110
	* `export ASPERA_SCP_FILEPASS=<<<<<YOUR ENCRYPTION PASSPHRASE>>>>>`
111

112
1. **Run the relevant _ascp_ commands**.
113
114
115


     * Upload:
116
117
118
119
		* To upload all *png* files to the root of the share:
		  * `ascp -d -i $KEY -P 33001 --file-crypt=encrypt -W $UTOKEN *.png app_duma_public_read@aspera.lcsb.uni.lu:/`
		* To upload *document.txt* to a subfolder:
		  * `ascp -d -i $KEY -P 33001 --file-crypt=encrypt -W $UTOKEN document.txt app_duma_public_read@aspera.lcsb.uni.lu:/subfolder`
120
	 * Download:
121
122
		* To download *subfolder* and all it's content to the current directory:
		  * `ascp -d -i $KEY -P 33001 --file-crypt=decrypt -W $DTOKEN app_duma_public_read@aspera.lcsb.uni.lu:subfolder`
123
124
125


You can find more information also on the [Aspera website](https://downloads.asperasoft.com/en/documentation/62).