annotate README.md @ 2:2f7a70c0d3ab draft default tip

Uploaded
author ieguinoa
date Mon, 21 Feb 2022 14:22:53 +0000
parents 5d59238cd3f4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
1 # ena-upload-wrapper
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
2 Galaxy wrapper for ena-cli-upload
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
3
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
4 This tool is shipped in a ready to use Galaxy container found [here](https://github.com/ELIXIR-Belgium/ena-upload-container).
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
5
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
6 ## Setting up credentials on Galaxy
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
7
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
8 The admin of the server can set up global credentials through a file with the format:
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
9 ```
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
10 username: webin_id
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
11 password: webin_password
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
12 ```
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
13
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
14 The path to this file must be exported as an environment variable called $GALAXY_ENA_SECRETS
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
15
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
16 Alternatively, the admin can enable users to set their own credentials for this tool.
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
17 To enable it, make sure the file `config/user_preferences_extra_conf.yml` has the following section:
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
18
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
19 ```
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
20 ena_webin_account:
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
21 description: Your ENA Webin account details
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
22 inputs:
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
23 - name: webin_id
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
24 label: ENA Webin ID
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
25 type: text
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
26 required: False
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
27 - name: password
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
28 label: Password
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
29 type: password
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
30 required: False
5d59238cd3f4 Uploaded
ieguinoa
parents:
diff changeset
31 ```