diff README.rst @ 2:6d0c0961ae13 draft

planemo upload for repository https://github.com/usegalaxy-au/tools-au/tree/master/tools/aarnet_filesender commit c8e1e0914854bf50287ea4b9ee86dfeb747a3342
author galaxy-australia
date Mon, 21 Oct 2024 23:12:46 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst	Mon Oct 21 23:12:46 2024 +0000
@@ -0,0 +1,26 @@
+FileSenderCLI  wrapper
+======================
+
+Galaxy wrapper of the AARNET
+`filesender <https://support.aarnet.edu.au/hc/en-us/articles/230067927-Send-files-with-FileSender>`__.
+
+Setting up credentials on Galaxy
+--------------------------------
+
+The admin can enable users to set their own credentials
+for this tool. To enable it, make sure the file
+``config/user_preferences_extra_conf.yml`` has the following section:
+
+.. code-block:: yaml
+
+    aarnet_filesender_account:
+        description: AARNet FileSender Account Info
+        inputs:
+            - name: username
+              label: AARNet FileSender Username
+              type: text
+              required: False
+            - name: apikey
+              label: AARNet FileSender API Key
+              type: password
+              required: False