Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info

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

  1. Register for an HTRC account if you do not already have one. Read the guide for extended directions, or follow the steps in the link below.

    Expand
    titleSign up for and sign in to the HTRC
    Include Page
    Sign Up and Sign In
    Sign Up and Sign In


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

    Expand
    titleInstall software to your computer

    Include Page
    Software Installation
    Software Installation


  3. Make sure you are still logged in to the HTRC where you just created an account. 

  4. From the HTRC, create a capsule by clicking on Capsule →  Create Capsule on the top menu. You will be asked to provide information about the capsule you would like to create.

    Expand
    titleCreate a capsule

    Include Page
    Create a capsule
    Create a capsule


  5. Start the capsule you created by clicking the Start Capsule button on the Show Capsules page.

    Expand
    titleStart the capsule

    Include Page
    Start the VM
    Start the VM


  6. Interact with the capsule via the VNC client. 

    Expand
    titleUse your capsule

    Include Page
    Interact with the VM via VNC Client
    Interact with the VM via VNC Client


  7. Alternatively, you can SSH into your capsule when it is in maintenance mode only. 

    Expand
    titleSSH 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.

    Code Block
    ssh -p <your capsule's port> dcuser@thatchpalm.pti.indiana.edu


    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.




  8. Switch between maintenance and secure mode.

    Expand
    titleSwitch capsule modes

    Include Page
    COM:Mode Switch: Maintenance and Secure Modes
    COM:Mode Switch: Maintenance and Secure Modes


  9. Fetch volume OCR content using the HTRC Data API. 

    Expand
    titleUse the HTRC Data API

    Include Page
    Fetching Volume OCR Content in HTRC Data Capsule (Secure Mode)
    Fetching Volume OCR Content in HTRC Data Capsule (Secure Mode)


  10. Run experiments. Follow the Use Case guides for examples.

  11. If you will need more than one session to complete your research, save your interim data.

    Expand
    titleSave 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:

    Code Block
    cd /media/secure_volume

    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:   

    Code Block
    releaseresults add /home/demouser/demo/r/Rplots.pdf

    Repeat using this command if you have other files to add.




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

  13. When you are finished with your research, request to export your non-consumptive data.

    Expand
    titleTurn off the capsuleExport non-consumptive results

    Include Page
    Finishing Up
    Finishing Up


  14. When you no longer need it, delete your capsule via the HTRC. 

Questions?