Once you have your capsule running, you may find it useful to open this guide in an internet browser in your capsule so you can copy and paste commands. The short link for this page is: https://wiki.htrc.illinois.edu/x/TQFRAQ.
Expand title Sign up for and sign in to the HTRC Include Page Sign Up and Sign In Sign Up and Sign In
Install a VNC client on your computer to enable the communication between your computer and the capsule you will remote access into. You can choose any VNC client you prefer. We use VNC View for Google Chrome in the screenshots below. You can also use Screen Sharing on a Mac.
Expand title Install software to your computer Include Page Software Installation Software Installation
- Make sure you are still logged in to HTRC Analytics where you just created an account.
From the Analytics homepage, create a capsule by clicking on Capsule on the top menu. You will be asked to provide information about the capsule you would like to create.
Expand title Create a capsule Include Page Create a capsule Create a capsule
Start the capsule you created by clicking the Start Capsule button on the Capsules page.
Expand title Start the capsule Include Page Start the VM Start the VM
Interact with the capsule via the VNC client. You will need to enter both your VNC password (the one you set when you created your capsule) and the capsule's operating system password (dcuser) to log-in.
Expand title Use your capsule Include Page Interact with the VM via VNC Client Interact with the VM via VNC Client
Alternatively, you can SSH into your capsule when it is in maintenance mode only.
Expand title SSH access in maintenance mode
Key information for accessing your capsule is located on the Capsule Status page.
On a Linux terminal, enter the following command inserting your capsule's port number found on the Capsule Status page. Then enter the password dcuser when prompted.
ssh -p <your capsule's port> firstname.lastname@example.org
Note that if you want to interact with the Ubuntu desktop of your capsule, or if you want to use your capsule in secure mode, you will need to use a VNC client as described above.
Switch between maintenance and secure mode.
Expand title Switch capsule modes Include Page COM:Mode Switch: Maintenance and Secure Modes COM:Mode Switch: Maintenance and Secure Modes
Fetch volume OCR content using the HTRC Data API. Bring text data into your capsule.
Expand title Use the HTRC Data APIGet data Include Page Fetching Volume OCR Content in HTRC Data Capsule (Secure Mode) Fetching Volume OCR Content in HTRC Data Capsule (Secure Mode)
If you will need more than one session to complete your research, save your interim data.
Expand title Save data to Secure Volume
Save data to the Secure Volume
Make sure your capsule is in secure mode (see directions above if needed).
Open a terminal window in the capsule and navigate to the secure volume by typing:
Suppose the file you'd like to release is at /home/demouser/demo/r/Rplots.pdf
You can prepare the result data for release by adding it, which is done by typing the command:
releaseresults add /home/demouser/demo/r/Rplots.pdf
Repeat using this command if you have other files to add.
Between sessions, stop the capsule via the HTRC using the web browser on your personal desktop. The next time you log in, you can restart the same capsule and continue your work.
When you are finished with your research, request to export your non-consumptive data.
Expand title Export non-consumptive results Include Page Finishing Up Finishing Up
- When you no longer need it, delete your capsule via the HTRC.