How To ResVault

tiCrypt manual

The full documentation for tiCrypt software can be found at tiCrypt.com. This page contains some specifics to use tiCrypt the way it runs at the University of Florida.

tiCrypt Connect Client Install/Update

1. If the client is already installed, ensure there are no instances of tiCrypt currently running by opening tiCryptConnect and selecting the "Shut down Connect" button to the right of the screen. If the client is not yet installed, proceed to Step 2.
   • 
2. If the client isn't starting or responding, you might need to stop the process manually.
   • 
3. Download the appropriate launcher for your operating system from the HiPerGator-RV Download page.
4. Run the installer software for the tiCrypt Connect client and follow the prompts.
5. Once the installation is finished, run the client and check that the version number corresponds to the updated version. We recommend always using the latest deployment version, which is circled in the first image.

ResVault Login

1. Launch the tiCrypt Connect client, which will open a new tab on your Internet browser (http://127.0.0.1:8080/connect).
2. Click on the latest HyperGatorRV deployment or add a new deployment using the downloaded deployment file from Step 2 above. We recommend always using the latest deployment version.
3. If you see a message saying "You have no keys loaded.", click on "LOAD KEY" and select the <filename>.key.json key file.
4. Enter your RV password (not your GatorLinkID password).
5. Setup or access your virtual machine (VM) as described in the training sessions.

How to Transfer Data from/to RV

Move data into RV

1. My Vault: Click on the "Transfer Files" button and follow the prompts.
2. SFTP: Launch SFTP, copy the host and port, and then copy the password. For more information on using an SFTP client to transfer data to tiCrypt, please refer to this guide. You can also use a terminal.
3. Inboxes: The inbox function allows incoming data from users outside of ResVault. It can be assigned to different folders in My Files, and it creates a URL and command lines for external users. The inboxes can be edited, and the current upload speed for inboxes is about 50 Mbps.

Move data out of RV

1. My Vault: Click on the "Transfer Files" button and follow the prompts.
2. File Sharing: This allows file sharing with other team members.
3. Transfer button: This allows inbound and outbound transfer from a selected VM to the Vault. To transfer a file, select it and click on "Transfer".

How to encrypt a file for download

• Instructions can be found here How to encrypt a file for download
• For more information about data management, please visit HiPerGator-RV Data Management

How to Setup a VM

Data stored in My Vault can be processed with the RV VM. Windows and Linux options are available.

Follow these steps to set up a VM:

Setup Drives

1. Click on the Virtual Machines main tab and then click on Drives.
2. Add a drive and set up two drives: a Home and a Data drive. Users should specify which drives need backup.
3. Setup the Home data. It should be at least 10 GB.
4. Select the Team, Production Realm, and "Default".
   
   
   
   
   
   

Setup VM

1. Navigate to the Virtual Machines management tab and click on the "+" button next to the search bar.
2. Select the appropriate type of VM, including the operating system, under Basic Info.
3. Select the Drive.
   • Only Read-Only drives can share data with the share function.
   • You can save data in the default C:\ drive, but it will be wiped out at the end of every session. Therefore, creating a "Data" drive for storage in addition to the Vault is recommended.
4. Confirm the VM settings.
5. Launch the VM, if needed prompt to format the disk (fist time launch).
6. You can monitor a process with the progress bar on the bottom right corner of the screen.
7. You can share the VM with other users and give manager or user labels. This is only for users within the teams.
8. Access directory management is used to grant permissions to specific drives/folders. Only VM owners can manage it.
9. Connect by clicking on the Open button and follow the prompts.

Install Software into ResVault

As of April 2022, all HiPerGator software is available on Linux VMs under the /apps/ directory. You can load modules from a command line using the command $ module load (AppName), or search for modules using $ module spider (AppName). For a full list of available HiPerGator apps, please see this page.

If you have a specific software installation request, please contact our support team via the Helpdesk.

How to run Jupyter on Linux VMs in ResVault

You can use the same kernels that are available on HiPerGator within ResVault VMs by following the steps outlined in this guide.

How to transfer drive ownership from one user to another

Transferring drive ownership allows a different user to be the VM owner. VMs cannot be transferred, but the drives mounted in the VMs can be. The process requires assistance from the ResVault administrators and cannot be completed by users alone.

1. Shut down any VMs with the drive(s) to be transferred mounted.
2. In the Virtual Machine, Drives sub-panel, select the drive and click the Share icon.
3. You need to share the drive with Read-Write Access. Start typing the name of the user you want to transfer the drive to and select the user from the list.
4. Click Accept.
5. Once the drive has been shared with the desired new owner, contact Research Computing support and request that drive ownership be transferred.
6. Staff will transfer ownership, and the new owner can configure a VM using the drives that they now own and will be the owner of the VM.
7. Old user will still have access to the drives.

Troubleshooting Issues

To address technical issues regarding ResVault, please review our Troubleshooting Page.