change doc for ftp_upload_dir/site

This commit is contained in:
Lucille Delisle
2021-06-18 11:08:48 +02:00
parent 7f9c7b297d
commit a93d3308bc
3 changed files with 32 additions and 30 deletions
+18 -17
View File
@@ -3652,28 +3652,29 @@
:Type: str
~~~~~~~~~~~~~~~~~~
``ftp_upload_dir``
~~~~~~~~~~~~~~~~~~
:Description:
Enable Galaxy's "Upload via FTP" interface. You'll need to
install and configure an FTP server (we've used ProFTPd since it
can use Galaxy's database for authentication) and set the
following two options. This should point to a directory containing
subdirectories matching users' identifier (defaults to e-mail),
where Galaxy will look for files.
:Default: ``None``
:Type: str
~~~~~~~~~~~~~~~~~~~
``ftp_upload_site``
~~~~~~~~~~~~~~~~~~~
:Description:
This should be the hostname of your FTP server, which will be
provided to users in the help text.
Enable Galaxy's "Upload via FTP" interface. You'll need to
install and configure an FTP server (we've used ProFTPd since it
can use Galaxy's database for authentication) and set the
following two options. This will be provided to users in the help
text as 'log in to the FTP server at '. Thus, it should be the
hostname of your FTP server.
:Default: ``None``
:Type: str
~~~~~~~~~~~~~~~~~~
``ftp_upload_dir``
~~~~~~~~~~~~~~~~~~
:Description:
This should point to a directory containing subdirectories
matching users' identifier (defaults to e-mail), where Galaxy will
look for files.
:Default: ``None``
:Type: str
+8 -7
View File
@@ -1809,15 +1809,16 @@ galaxy:
# Enable Galaxy's "Upload via FTP" interface. You'll need to install
# and configure an FTP server (we've used ProFTPd since it can use
# Galaxy's database for authentication) and set the following two
# options. This should point to a directory containing subdirectories
# matching users' identifier (defaults to e-mail), where Galaxy will
# look for files.
#ftp_upload_dir: null
# This should be the hostname of your FTP server, which will be
# provided to users in the help text.
# options. This will be provided to users in the help text as 'log in
# to the FTP server at '. Thus, it should be the hostname of your FTP
# server.
#ftp_upload_site: null
# This should point to a directory containing subdirectories matching
# users' identifier (defaults to e-mail), where Galaxy will look for
# files.
#ftp_upload_dir: null
# User attribute to use as subdirectory in calculating default
# ftp_upload_dir pattern. By default this will be email so a user's
# FTP upload directory will be ${ftp_upload_dir}/${user.email}. Can
+6 -6
View File
@@ -2659,22 +2659,22 @@ mapping:
desc: |
The URL to the myExperiment instance being used (omit scheme but include port).
ftp_upload_dir:
ftp_upload_site:
type: str
required: false
desc: |
Enable Galaxy's "Upload via FTP" interface. You'll need to install and
configure an FTP server (we've used ProFTPd since it can use Galaxy's
database for authentication) and set the following two options.
This should point to a directory containing subdirectories matching users'
identifier (defaults to e-mail), where Galaxy will look for files.
This will be provided to users in the help text as 'log in to the FTP
server at '. Thus, it should be the hostname of your FTP server.
ftp_upload_site:
ftp_upload_dir:
type: str
required: false
desc: |
This should be the hostname of your FTP server, which will be provided to
users in the help text.
This should point to a directory containing subdirectories matching users'
identifier (defaults to e-mail), where Galaxy will look for files.
ftp_upload_dir_identifier:
type: str