6. CRSP clientsο
Depending on your laptop there are a few clients that can be installed.
Please note that RCIC does not provide Windows OS or macOS support for the campus. If there is an operating system related issue, RCIC will refer you to you get support to address your systems issue first before installing CRSP Desktop.
For issues with clients please see CRSP Troubleshooting
6.1. DUO Multifactor Authenticationο
In July 2024, Campus DUO authentication will be mandatory for all CRSP desktop clients. The push response of DUO can become very tiresome. On some clients, DUO can make CRSP unusable because every file transfer requires another DUO push. RCIC cannot βturn off DUO.β
However, ssh keys with strong passwords is a secure method to to provide a different second factor of authentication. SSH keys managed properly do not require DUO after initial setup but still maintain strong security. Never copy an ssh private key file!
Quick Start
You should follow the guide to Generate SSH keys for different platforms.
Note
It is highly recommended that your private key file is in PEM format and has a .pem file extension. The CRSP desktop clients more reliably recognize PEM-formatted keys.
If using Windows, it is recommended to use the Powershell method for generating ssh keys and not use PuTTY.
Important
All ssh keys that you generate MUST have a strong password. Passwordless keys are a security violation.
DO NOT COPY ssh keys from one laptop to another. Every different physical device should have a different ssh key pair.
Make sure you uploaded your public keys to CRSP per Managing Public SSH Keys on CRSP.
Learn how to use SSH Agent on your desktop/laptop. If on Windows, you can also Puttyβs pageant. SSH agents securely store a private key in memory so that you only have to type the keyβs passphrase once.
6.2. Supported Protocols for Accessing CRSPο
There are only three underlying data transfer protocols supported for accessing CRSP:
- SFTP:
- This is the only protocol available to desktop clients.
- NFSv4:
- Network File System.This is only supported on HPC3 through the path /share/crsp.
- HTTPS:
- This provides very simple, browser-based access to CRSP.This is a fallback access method.
6.3. CRSP Desktop App for macOSο
The CRSP Desktop for macOS is a licensed and branded version of the generic Mountain Duck link:https://mountainduck.io/[Mountain Duck] product. product. It allows you to map one or more CRSP drives or file paths to a folder on your Mac.
Supported Operating System |
Minimum Hardware Requirements |
---|---|
Monterey / Mojave / Catalina / Big Sur / Ventura |
Intel or ARM (Apple Silicon) Processor 8 GB of memory 1 GB of disk space |
6.3.1. macOS: Download Desktop Appο
Important
You must either be on the campus network or connected to the UCI campus VPN to download the installers.
UCI pays a per-seat license for CRSP Desktop. Please do not share your downloaded copy of CRSP Desktop Installer with anyone.
If you have a different (previous or newer) version of the CRSP Desktop (or Mountain Duck), you need to uninstall it.
- Download Step 1:
Using your choice of the web browser login to the CRSP File Browser using your UCNetID and password:
Respond to the DUO push:
- Download Step 2:
- After a successful authentication the window will look similar to the one shown below.Click on the CRSP-Desktop-Downloads tab, then click on the CONNECT:
- Download Step 3:
You should see three items on screen: a .pkg file for Mac clients, a .exe file for Windows, and older-versions folder. To toggle the between list and icon view click on the Layout icon outlined in green.
For the Mac, simply click on the file with .pkg ending:
- Download Step 4:
You should then see a screen with a download button on it and the full name of the file that will be downloaded to your local computer. Click Download:
You may see a popup window asking if you want to allow downloads from this site, click on Allow button and save the file to your local computer:
6.3.2. macOS: Install Desktop Appο
- Install Step 1:
Find the downloaded file, depending on your Mac configuration, the file is in your Downloads folder or in your Desktop:
- Install Step 2:
Double-click on the downloaded file name to launch the installation. You will see a confirmation window, click Open:
Congratulations! CRSP Desktop is now installed in your system!
6.3.5. macOS: Password + DUO vs. Passphraseο
You have two authentication options when connecting to CRSP:
- 1. SSH Key with Passphrase
What to Expect with a Passphrase
It is highly recommended that you use ssh keys with a passphrase as described in the Quick Start guide.
When you click connect in the previous step, you should see popup window similar to the following (with your ssh key info):
Notice that a local file (ssh private key ~/.ssh/crsp-npw) and a passphrase are requested. You can optionally save the passphrase.
Assuming that the public key for the private key has been properly installed on CRSP, you should be connected without a DUO prompt.
- 2. UCINetID + password + DUO Push
What to expect with a Password + DUO
If you do NOT install an ssh key, you will be prompted for your UCINetID password and a DUO push. Even if you have the CRSP Desktop remember your password, the DUO Push will be required each and every time the desktop reconnects to CRSP.
Step 1 Enter your password, similar to the following:
Step 2 Respond to the DUO push
Usually, you would enter 1 in the box, click on Continue and you will receive a duo push on your phone. If your phone isnβt available, then you can enter one of your DUO backup codes that you set up when you enrolled in DUO through the UCI Office of Information Technology.
6.4. CRSP Desktop App for Windowsο
The CRSP Desktop for Windows is a licensed and branded version of the generic Mountain Duck link:https://mountainduck.io/[Mountain Duck] product. product. It allows you to map one or more CRSP drives or file paths to a folder on your PC.
Supported Operating System |
Minimum Hardware Requirements |
---|---|
Windows 10 / Windows 11 |
Pentium Class Processor 4 GB of memory (8 GB recommended) 1 GB of disk space |
6.4.1. Windows: Download Desktop Appο
Important
You must either be on the campus network or connected to the UCI campus VPN to download the installers.
UCI pays a per-seat license for CRSP Desktop. Please do not share your downloaded copy of CRSP Desktop Installer with anyone.
If you have a different (previous or newer) version of the CRSP Desktop (or Mountain Duck), you need to uninstall it.
- Download Step 1:
Using your choice of the web browser login to the CRSP File Browser using your UCNetID and password, follow with DUO authentication:
Respond to the DUO push:
- Download Step 2:
- After a successful authentication the window will look similar to the one shown below.Click on the CRSP-Desktop-Downloads tab, then click on the CONNECT:
- Download Step 3:
You should see three items on screen: a .pkg file for Mac clients, a .exe file for Windows, and older-versions folder. To toggle the between list and icon view click on the Layout icon outlined in green.
For the Windows, simply click on the file with .exe ending.
- Download Step 4:
You should then see a screen with a download button on it and the full name of the file that will be downloaded to your local computer. Click Download and save the file to your local computer:
6.4.2. Windows: Install Desktop Appο
- Install Step 1
By default, the file is downloaded in your Downloads folder. Find the downloaded file, double-click on it to launch the installation. This installation includes the licensed version of CRSP Desktop.
- Install Step 2
In the opened window click Install to Install the CRSP Desktop on your laptop.
- Install Step 3
After a successful installation, follow the instructions and click Restart to restart your computer:
Congratulations! CRSP Desktop is now installed in your system!
6.4.5. Windows: Password + DUO vs. Passphraseο
You have two authentication options when connecting to CRSP:
- 1. SSH Key with Passphrase
What to Expect with a Passphrase
It is highly recommended that you use ssh keys with a passphrase as described in the Quick Start guide.
When you click connect in the previous step, you should see popup window similar to the following:
Notice that a local file (ssh private key) and a passphrase is requested. You can optionally save the passphrase. Assuming that the public key for the private key has been properly installed on CRSP, you should be connected without a DUO prompt.
- 2. UCINetID + password + DUO Push
What to expect with a Password + DUO
If you do NOT install an ssh key, you will be prompted for your UCINetID password and a DUO push. Even if you have the CRSP Desktop remember your password, the DUO Push will be required each and every time the desktop reconnects to CRSP.
Step 1 Enter your password, similar to the following:
Step 2 Respond to the DUO push
Usually, you would enter 1 in the box, and you will receive a duo push on your phone. If your phone isnβt available, then you can enter one of your DUO backup codes that you set up when you enrolled in DUO through the UCI Office of Information Technology
6.5. Web based File Browserο
A simple, easy to use File Browser is platform independent and is compatible with most web browsers.
Please note that File Browser is suitable only for lightweight use. We provide CRSP Desktop App for macOS and CRSP Desktop App for Windows for moderate to heavy use.
Important
Your system must be updated with the latest version of Google Chrome, or Firefox or Safari
You must be registered and setup with UCI DUO
6.5.1. Logging inο
Using your choice of the web browser login to the CRSP File Browser using your UCNetID and password:
Respond to the DUO push:
6.5.2. Connect to your Lab or HOME areaο
Once logged in, you will be presented with the CRSP top level screen. You can follow the tabs to your Lab shared areas in My-labs or HOME private area in My-Home:
Important
Nothing can be stored in HOME area, it is used for for files associated with the account and for storing quota info file. It is a completely private area, only you have access.
We recommend that you do most work on CRSP in your lab area. Lab areas are flexible for sharing. You can be granted access to multiple Lab areas.
To see your labs, Click on My-Labs, then click on CONNECT. You will see a screen similar to the next one. In this example a user npw has an access to 4 labs:
6.6. Linux SSHFSο
This page illustrates how use sshfs on Linux laptops for accessing CRSP. Sshfs will Map CRSP Lab Share as a folder on your laptop.
6.6.1. Install sshfsο
On your laptop you will need super user (sudo) rights to install sshfs.
- For CentOS based laptop
$ yum -y install sshfs
- For Ubuntu/Debian based systems
$ apt-get -y install sshfs
6.6.4. Using sshfsο
Examples of sshfs use:
- Copy a file from your local system to your sshfs mounted drive
$ cp ~/dir1/file.tar.gz ~/crsp_mount/share/
- Recursively copy a directory from local system to mounted CRSP share using
rsync
$ rsync -rltv ~/dir1 ~/crsp_mount/share/
6.7. Access from HPC3ο
On HPC3, CRSP shares are mounted in /share/crsp:
[user@login-x:~]$ ls /share/crsp
home HOME-SNAPSHOTS lab LAB-SNAPSHOTS
- home:
HOME area for all users accounts
- HOME-SNAPSHOTS:
read-only access for HOME area snapshots
- lab:
Lab area for all users accounts
- LAB-SNAPSHOTS:
read-only access for LAB area snapshots
6.7.1. CRSP HOMEο
User CRSP HOME area is /share/crsp/home/ucinetid:
it is a placeholder for login related files
it is not the same as your cluster accountβs $HOME
Do not store anything in your CRSP HOME
File /share/crsp/home/ucinetid/quotas.txt in your CRSP HOME area provides information about quotas. Please see Quotas for details.
6.7.2. CRSP LABο
LAB area is your primary storage area and is in /share/crsp/lab/ucinetid or any other LAB directories you have access for.
If you are a PI and itβs your lab
USERNAME |
LABNAME |
Mounted location |
Who has read/write access |
---|---|---|---|
your UCINetID |
your UCINetID |
/share/crsp/lab/LABNAME |
you can create any directories and files |
/share/crsp/lab/LABNAME/USERNAME |
your personal space |
If you are added to a PI lab e.g., you are a student/postdoc in the lab
USERNAME |
LABNAME |
Mounted location |
Who has read/write access |
---|---|---|---|
your UCINetID |
your PI UCINetID |
/share/crsp/lab/LABNAME/USERNAME |
you and PI |
/share/crsp/lab/LABNAME/share |
all lab members |
The following example shows the directory structure and permissions for a PI panteater who has a lab and added 2 students:
[user@login-x:~]$ ls -ld /share/crsp/lab/panteater
drwxr-x--T 3 panteater panteater_lab_share 512 Mar 6 15:58 /share/crsp/lab/panteater
[user@login-x:~]$ ls -l /share/crsp/lab/panteater
drwx--S--- 2 panteater panteater_lab 2048 Jul 12 10:22 panteater # by PI
drwxrws--- 2 student1 panteater_lab 512 Apr 29 10:27 student1 # by student1/PI
drwxrws--- 2 student2 panteater_lab 512 Apr 29 10:27 student2 # by student2/PI
drwxrws--T 4 panteater panteater_lab_share 512 Nov 2 2020 share # by all in lab
6.7.3. Moving data to CRSPο
Please see Data transfer for in-depth commands examples.
For example, to recursively copy your mydir/ directory from DFS6 to your LAB share on CRSP:
[user@login-x:~]$ rsync -rv /dfs6/pub/paneater/mydir /share/crsp/lab/panteater/
6.8. Unsupported Clientsο
Please see the Unsupported CRSP Clients Guide for some pointers on unsupported clients.