Difference between revisions of "Serving Static Data"

From UFRC
Jump to navigation Jump to search
Line 11: Line 11:
  
 
=Description=
 
=Description=
Service that allows you to present data you have in your /orange/GROUP directory tree whether publicly or via password-protected directories. You can copy or symlink files and directories into /orange/GROUP/web/public or /orange/GROUP/web/secure directories and be able to secure directories under web/secure with a single command (generate_download_dir from the ufrc environment module) that generates a username and password combination. The data will appear under a [https://data.rc.ufl.edu/pub/GROUP https://data.rc.ufl.edu/pub/GROUP] or [https://data.rc.ufl.edu/secure/GROUP/secure_directory https://data.rc.ufl.edu/secure/GROUP/secure_directory] URL.
+
Service that allows you to present data you have in your /orange/GROUP directory tree whether publicly or via password-protected directories. Actual directories and files as well as symlinks to directories and files located elsewhere in /orange/GROUP can be used under /orange/GROUP/web/*
  
Alternatively, you can request UFRC Single-Signon protection and specify HiPerGator group(s), all HiPerGator users, or all UF GatorLink users as the allowed audience for a particular directory/URL.
+
Any files or directories or symlinks to them placed under /orange/GROUP/web/public become immediately browsable via <code>https://data.rc.ufl.edu/pub/GROUP/</code>
 +
 
 +
The content of the /orange/GROUP/web/secure directory is not browsable. There is an immutable index.html file in /orange/GROUP/web/secure explaining that to clients attempting to access <code>https://data.rc.ufl.edu/secure/GROUP/</code>.
 +
 
 +
Use the <code>secure_data_download_directory_setup</code> command from the ufrc module to set up password-protected directories under /orange/GROUP/web/secure, which will create password-protected sites under https://data.rc.ufl.edu/secure/GROUP/ if needed. Every configured directory will appear under <code>https://data.rc.ufl.edu/secure/GROUP</code>. Run <code>secure_data_download_directory_setup -h</code> for help or see below. Once a directory (e.g. named 'DIRECTORY') is set up any client who goes to <code>https://data.rc.ufl.edu/secure/GROUP/DIRECTORY</code> will have to enter the configured credentials after which they'll be able to browse the contents of the directory.
 +
 
 +
If there is a need, you can [https://support.rc.ufl.edu submit a support request] to request that UFRC Single-Signon protection is set up for a particular directory/URL under https://data.rc.ufl.edu/secure/GROUP/ say for a long-term internal UF collaboration. Please specify one or more HiPerGator groups, all HiPerGator users, or all UF GatorLink users as the allowed audience.
 +
 
 +
;secure_data_download_directory_setup usage
 +
<pre>
 +
$ secure_data_download_directory_setup -h
 +
 
 +
secure_data_download_directory_setup [-h] [-u <USER>] [-p <PASSWORD>] [-d <DIRECTORY>] OR [-f <INPUT FILE>]  -- Generates a new download location.
 +
 
 +
Where:
 +
    -h  show this help text
 +
    -o  overwrite existing location
 +
EITHER
 +
    -f  input file with a list of download locations: "user password directory_name"
 +
    -l  delimiter to use with the input file (default is the tab: '    ')
 +
OR
 +
    -u  username
 +
    -p  password
 +
    -d  download location directory
 +
Note: You need to provide either the file name or the individual options.
 +
</pre>
  
 
=Implementation=
 
=Implementation=

Revision as of 13:26, 29 March 2021

Summary

RC Static Data Sharing service enables sharing of data from the /orange filesystem as static files through a webserver whether publicly or with password protection for individual directories.

Use cases

Some, but not all possible use cases include:

  • Sharing data with external collaborators who do not have HiPerGator accounts.
  • Looking for a more lightweight and faster to set up approach than Globus.
  • Long-term stable URL for supporting data for a publication or project.
  • Not wanting to copy/move data already in /orange elsewhere.

Description

Service that allows you to present data you have in your /orange/GROUP directory tree whether publicly or via password-protected directories. Actual directories and files as well as symlinks to directories and files located elsewhere in /orange/GROUP can be used under /orange/GROUP/web/*

Any files or directories or symlinks to them placed under /orange/GROUP/web/public become immediately browsable via https://data.rc.ufl.edu/pub/GROUP/

The content of the /orange/GROUP/web/secure directory is not browsable. There is an immutable index.html file in /orange/GROUP/web/secure explaining that to clients attempting to access https://data.rc.ufl.edu/secure/GROUP/.

Use the secure_data_download_directory_setup command from the ufrc module to set up password-protected directories under /orange/GROUP/web/secure, which will create password-protected sites under https://data.rc.ufl.edu/secure/GROUP/ if needed. Every configured directory will appear under https://data.rc.ufl.edu/secure/GROUP. Run secure_data_download_directory_setup -h for help or see below. Once a directory (e.g. named 'DIRECTORY') is set up any client who goes to https://data.rc.ufl.edu/secure/GROUP/DIRECTORY will have to enter the configured credentials after which they'll be able to browse the contents of the directory.

If there is a need, you can submit a support request to request that UFRC Single-Signon protection is set up for a particular directory/URL under https://data.rc.ufl.edu/secure/GROUP/ say for a long-term internal UF collaboration. Please specify one or more HiPerGator groups, all HiPerGator users, or all UF GatorLink users as the allowed audience.

secure_data_download_directory_setup usage
$ secure_data_download_directory_setup -h

secure_data_download_directory_setup [-h] [-u <USER>] [-p <PASSWORD>] [-d <DIRECTORY>] OR [-f <INPUT FILE>]  -- Generates a new download location.

Where:
    -h  show this help text
    -o  overwrite existing location
EITHER
    -f  input file with a list of download locations: "user password directory_name"
    -l  delimiter to use with the input file (default is the tab: '     ') 
OR
    -u  username
    -p  password
    -d  download location directory
Note: You need to provide either the file name or the individual options.

Implementation

As a part of the request, an /orange/GROUP/web directory tree and a 'rc-svc-GROUP-web' user with membership in your GROUP will be created.

  • Use the 'generate_download_dir' command from the ufrc environment module to generate a username and password configuration in the target directory under /orange/GROUP/web/secure/. That directory will be immediately protected by the webserver. Create a protected directory before copying or symlinking any data into it.

Note: the rc-svc-GROUP-web user will be a member of your GROUP, so any data to be shared must be group-readable!