Difference between revisions of "Serving Static Data"

From UFRC
Jump to navigation Jump to search
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
[[Category:Services]]
 
[[Category:Services]]
−
=Summary=
+
{|align=right
 +
  |__TOC__
 +
  |}
 +
==Summary==
 
[https://data.rc.ufl.edu/ 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.
 
[https://data.rc.ufl.edu/ 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=
+
==Use cases==
 
Some, but not all possible use cases include:
 
Some, but not all possible use cases include:
 
* Sharing data with external collaborators who do not have HiPerGator accounts.
 
* Sharing data with external collaborators who do not have HiPerGator accounts.
Line 10: Line 13:
 
* Not wanting to copy/move data already in /orange elsewhere.
 
* Not wanting to copy/move data already in /orange elsewhere.
  
−
=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.
+
As a part of the request, an /orange/GROUP/web directory tree and a '<code>rc-svc-GROUP-web</code>' user with membership in your GROUP will be created.
 +
 
 +
Any files or directories or symlinks to them placed under /orange/GROUP/web/public become immediately browsable via <nowiki>https://data.rc.ufl.edu/pub/GROUP/</nowiki>
 +
 
 +
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 <nowiki>https://data.rc.ufl.edu/secure/GROUP/</nowiki>.
  
−
=Implementation=
+
==Service Setup==
 
* [https://www.rc.ufl.edu/access/purchase-request/ Purchase an orange quota] if you don't have one.
 
* [https://www.rc.ufl.edu/access/purchase-request/ Purchase an orange quota] if you don't have one.
 
* Submit a [https://support.rc.ufl.edu/enter_bug.cgi support request] for the initial setup.
 
* Submit a [https://support.rc.ufl.edu/enter_bug.cgi support request] for the initial setup.
−
As a part of the request, an /orange/GROUP/web directory tree and a '<code>rc-svc-GROUP-web</code>' user with membership in your GROUP will be created.
+
 
−
* Use the '<code>generate_download_dir</code>' 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.
+
Once the request is closed you will be able to use the /orange/GROUP/web directory tree.
 +
 
 
'''Note:''' the rc-svc-GROUP-web user will be a member of your GROUP, so any data to be shared must be group-''readable''!
 
'''Note:''' the rc-svc-GROUP-web user will be a member of your GROUP, so any data to be shared must be group-''readable''!
 +
 +
==Secure Directory Setup==
 +
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 <nowiki>https://data.rc.ufl.edu/secure/GROUP/</nowiki> if needed. Every configured directory will appear under <nowiki>https://data.rc.ufl.edu/secure/GROUP</nowiki>. 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 <nowiki>https://data.rc.ufl.edu/secure/GROUP/DIRECTORY</nowiki> will have to enter the configured credentials after which they'll be able to browse the contents of the directory.
 +
 +
;Note: Set up the protected directory's configuration '''before''' copying or symlinking any data into it. While the secure directory tree is not browseable if someone can guess the exact path to a file they could potential download the file if the authentication is not set up.
 +
 +
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 <nowiki>https://data.rc.ufl.edu/secure/GROUP/</nowiki> 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.
 +
<div class="mw-collapsible mw-collapsed" style="width:70%; padding: 5px; border: 1px solid gray;">
 +
''Expand this section to view setup example.''
 +
<div class="mw-collapsible-content" style="padding: 5px;">
 +
<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>
 +
</div>
 +
</div>

Latest revision as of 18:37, 15 December 2022

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/*

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.

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/.

Service Setup

Once the request is closed you will be able to use the /orange/GROUP/web directory tree.

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

Secure Directory Setup

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.

Note
Set up the protected directory's configuration before copying or symlinking any data into it. While the secure directory tree is not browseable if someone can guess the exact path to a file they could potential download the file if the authentication is not set up.

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.

Expand this section to view setup example. 

$ 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.
Retrieved from "https://help.rc.ufl.edu/mediawiki/index.php?title=Serving_Static_Data&oldid=27064"