.. _`port-forwarding-gui`:

===============================
Port Forwarding To Access a GUI
===============================

.. contents::
   :depth: 1
   :local:

.. admonition:: Compute Resources

    - Have questions or need help with compute, including activation or issues? Follow `this link. <https://jira.ris.wustl.edu/servicedesk/customer/portal/1/group/22>`_
    - :ref:`User Agreement <compute-user-agreement>`

.. _`port-forwarding-gui-video`:

Video
-----

.. raw:: confluence

    <ac:structured-macro ac:name="html">
        <ac:plain-text-body><![CDATA[

.. raw:: confluence html

    <iframe width="560" height="315" src="https://www.youtube.com/embed/gGR-9vileCk" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

.. raw:: confluence

    ]]></ac:plain-text-body>
        </ac:structured-macro>

.. _`port-forwarding-gui-startup`:

Start Up GUI Docker
-------------------

- This works with any docker image that uses noVNC or other software that produces a server-like connection to the GUI through a web browser.
- In this example, we will use the RIS THPC GUI to demonstrate.
- Start up your image like you would otherwise.

.. image:: ./images/start-gui.png

.. _`port-forwarding-gui-forwarding`:

Connect With Forwarding
-----------------------

- Once you have the exec node that the job is running on, you then ssh directly to that node using the following ssh command.

.. code::

    ssh -L 8080:compute1-exec-N.compute.ris.wustl.edu:8901 wustlkey@compute1-client-X.ris.wustl.edu

- Where 8080 is the local port you select and 8901 is the port used when running the GUI job, N is the exec node number the job is running on, and X is simply whichever client you choose to use.

.. image:: ./images/start-tunneling.png

.. _`port-forwarding-gui-browser`:

Connect Via Browser
-------------------

- Once the forwarding is set up, you can connect to the GUI through a web browser like normal, only now you use ``https://localhost:8080`` where 8080 is the port you chose.

.. image:: ./images/localhost-connect.png

- Now you have access to your GUI just like you would connecting directly to the exec node via a web browser.

.. image:: ./images/gui-desktop.png

.. image:: ./images/module-options.png

.. image:: ./images/cistem-gui.png