Login-Web Interface ====================== Login-Web is a "one stop shop" for access to our High Performance Computing resources. With Login-Web, it is possible to upload and download files, create, edit, submit, run GUI applications, and connect to nodes via SSH, all via a web browser, with no client software to install and configure. System Requirements ------------------- Currently, the site is confirmed to work with newer versions of Chrome (22+), Firefox (16+), and Microsoft Edge (11+). We are still working to expand availability to additional clients, and are planning on including compatibility for mobile devices (phones and tablets) in the future. .. note:: When logging in for the first time to Login-Web, you will be required to set up MFA, please see the MFA documentation for more information: https://docs.hpc.cam.ac.uk/hpc/user-guide/mfa.html If you need to reconfigure your MFA please contact support@hpc.cam.ac.uk and request a token reset. Connecting ~~~~~~~~~~ To connect to Login-Web, visit https://login-web.hpc.cam.ac.uk. The first page of the Login-Web site redirects you to the login page. .. tip:: For a video guide on how to use Login-Web for CSD3, please visit https://www.hpc.cam.ac.uk/getting-started-csd3-tutorials Logging in ~~~~~~~~~~ Login with your CSD3 HPC credentials: CRSid and password. .. image:: ../images/ondemand-login.png :alt: Login page Once completed you will be presented with this page: .. image:: ../images/ondemand-front-page.png :alt: screenshot of Login-Web front page Or this page if your browser window is more compact: .. image:: ../images/ondemand-front-page-compact.png :alt: screenshot of Login-Web front page The three-lined icon to the right of the compact page expands when clicked to show the full toolbar available on the non-compact page. At this point, it is possible to access the tools available in Login-Web. File Transfer and Management ---------------------------- This function allows the transfer of data to and from `Research Storage Services `_ project areas, or your CSD3 home directory. To use the file transfer client, select ``Files`` in the main menu. .. image:: ../images/ondemand-files-menu.png :alt: Files menu open Login-Web provides a web-based File Explorer that can be used to upload and download files to/from your CSD3 home directory or project directory, and copy, delete, rename, and edit files. Below you can see a screenshot of the main interface: .. image:: ../images/ondemand-files.png :alt: Files menu open Navigating ~~~~~~~~~~~ .. image:: ../images/ondemand-files-goto.png :alt: Files menu open By default, the file browser will be looking at your home directory. If you have access to a RDS or RCS project space, browse to the rds or rcs subdirectories of your home directory as normal; alternatively if you know the full path to the directory you can move stepwise through the path near the top of the window. In addition, you can use the ``Change Directory`` option in the top menu to type the path you wish to navigate to. Both the directory path and ``Change Directory`` button are highlighted in red in the image above. Uploading and Downloading Files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. image:: ../images/ondemand-files-upload.png :alt: Files menu open There are several methods of uploading files. The first is to simply navigate to the desired destination, and then drag the file from your local desktop or window navigator to the Login-Web window. You can also click the ``Upload`` button to open a dialog that will allow you to navigate your local computer and select which files you want to upload. This process is highlighted in the image above. To download files, you must select the file or files you wish to download, and then use the ``Download`` button. If you select multiple files (``Ctrl + Mouse click`` or ``Shift + Mouse click``) or a folder, the server will zip the files up and download a single zip archive to your desktop machine. File Operations ~~~~~~~~~~~~~~~ Most file operations can be accomplished by selecting the file in the main window pane and selecting the desired operation from the dropdown menu found by clicking the vertical ellipsis on the file. .. image:: ../images/ondemand-files-operations.png :alt: Files operations Viewing and/or Editing a File ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The application also includes several built-in file editors. To access these editors and viewers, select the vertical ellipsis dropdown menu file you wish to view or edit, and select ``Edit`` from the main menu. This will open up a text editor in a new tab. Job Management -------------- This function allows you to create, edit, submit, and monitor jobs. To access the job management tools, use the ``Jobs`` menu. .. image:: ../images/ondemand-jobs-menu.png :alt: Jobs menu open Login-Web provides two related job management tools: one allows you to create and submit jobs via your web browser, and the other allows you to monitor queued and running jobs. Job Composer ~~~~~~~~~~~~ Selecting ``Job Composer`` in the ``Jobs`` menu will open an application which allows you to inspect the results of jobs submitted, and to create new jobs and submit them to the cluster via this tool. .. image:: ../images/ondemand-jobs-composer.png :alt: Jobs menu open New Job ^^^^^^^ Use the following steps in order to create a job: 1. Create a new job by using an existing job template by clicking ``+New Job`` and then ``From Template`` (or alternatively ``From Default Template``). Select the job template to copy, then click ``Create New Job``. The template directory will be copied and a new job row will be added to the top of the jobs table on the page titled ``Jobs``: .. image:: ../images/ondemand-jobs-create.png :alt: Create new Job 2. Select the job, then modify and/or add any files to this job by clicking ``Edit Files``: .. image:: ../images/ondemand-jobs-edit-files.png :alt: Edit files 3. Select the job and click ``Job Options`` to change the cluster, job name, or job script, if necessary: .. image:: ../images/ondemand-jobs-options.png :alt: Options 4. At this point, you can submit the job using the green ``Submit`` button from the ``Jobs`` page; or return to this job later to modify it further. You can also monitor the job status here. Currently you must reload the page to see job status changes. Job Management ~~~~~~~~~~~~~~ On the main screen for ``Jobs``, click on a job to examine it. Submit Job ^^^^^^^^^^ If the job has not been submitted, the ``Green Submit`` button will be active, and will submit the selected job to the queue. Stop Job ^^^^^^^^ The ``Stop`` button will allow you to kill a running job. Delete Job ^^^^^^^^^^ The ``Delete`` button will allow you to delete a job. Active Jobs ~~~~~~~~~~~ The ``Active Jobs`` application will show all of your jobs currently in the queue (running or queued), regardless of how the jobs were submitted. You can click the button at the top to switch from: * All jobs submitted from your CSD3 user account * All jobs submitted by all CSD3 users You can also use the ``Filter`` tool to search jobs based on system, status (running, queued, or held), CSD3 user account, etc. .. image:: ../images/ondemand-jobs-listing.png :alt: Jobs menu open Job Inspection ~~~~~~~~~~~~~~ Clicking the arrow to the left of each job will show more information about the job. .. image:: ../images/ondemand-jobs-inspection.png :alt: Jobs inspection open Shell Access ------------ Login-Web provides the ability to SSH to a CSD3 login node from inside your web browser. To obtain a terminal, select the ``Clusters`` menu and choose the desired flavour of login node. .. image:: ../images/ondemand-shell-menu.png :alt: Shell menu open .. note:: Please note that this action will open a "pop-up" window. If your browser is configured to block pop-ups, you will not see the terminal. Interactive Apps ---------------- .. image:: ../images/ondemand-apps-menu.png :alt: Apps menu open This function launches a browser-based remote Linux desktop on which to run GUI applications, without the hassle or performance problems associated with X11 forwarding or custom VNC clients. To use this feature, please select an item from under Desktops, GUIs or Servers from the ``Interactive Apps`` menu. Remote Desktop ~~~~~~~~~~~~~~ .. image:: ../images/ondemand-remote-desktop-select.png :alt: Remote desktop This option will launch a full remote desktop in a browser tab. Select ``Remote Desktop`` and you will arrive on the page shown below. Click ``Launch``. You may need to wait for a few minutes for the application to launch. .. image:: ../images/ondemand-remote-desktop-wait.png :alt: Remote desktop To access the desktop you can choose from ``Launch Remote Desktop`` to reach your desktop as shown below and interact with it normally, or ``View Only (Shareable Link)`` to share your desktop with colleagues in ``View Only`` mode. .. image:: ../images/ondemand-remote-desktop-starting.png :alt: Remote desktop .. image:: ../images/ondemand-remote-desktop-launch.png :alt: Remote desktop Once the desktop is ready to be used, your session manager will show a job which looks like the image below: .. image:: ../images/ondemand-remote-desktop-xfce.png :alt: XFCE Remote desktop The remaining options shown under ``Interactive Apps`` will use the same functionality to launch specific applications, rather than full desktops. .. include:: loginweb-apps-matlab.rst .. include:: loginweb-apps-jupyter.rst .. include:: loginweb-apps-rstudio.rst Reference --------- Login-Web is based on `Open OnDemand `_ This documentation is based on Ohio Supercomputer Center user documentation for their Open OnDemand deployment (OSC OnDemand). More detail can be found at: * `OSC OnDemand User Guide `_ * `Open OnDemand Documentation `_ * `Open OnDemand User Forum `_ App Developers ~~~~~~~~~~~~~~ If you'd like to develop your own app through OnDemand, see the link below for detailed instructions. * `Open OnDemand App Development `_