Last modified:February 06, 2024

X2Go remote desktop

You may use remote desktop for fast and secure access to graphical applications.

Warning

2-step authentication must be configured before logging into X2Go

install

download and install the X2go client from https://wiki.x2go.org/doku.php/download:start

configure

  1. Open the X2Go client program

  2. If you use Mac OSX, you may be prompted you to install X11 (10.7 and earlier) or XQuartz (10.8 and later). Proceed to install either package.

  3. Create a new session

    I recommend creating an X2Go session for multiple servers, so you can easily log into a server with the most resources available.

    • If a ‘Session Preferences’ window doesn’t appear, then select Session -> New Session from the file menu

    • Session Name: Anything goes. I use the server’s host name, e.g. nx4 (see below)

    • Host: Choose from a host in the table below. I recommend choosing a host with the fewest Users.

      host load
    • Login: Type your username on the Neuro cluster

    • Session Type: Use the drop-down menu to select ‘XFCE’

    click image to see full-scale:

    x2go session

    Optional:

    • Try auto login: If you configured a SSH key, then check the box next to ‘Try auto login (via SSH Agent or default SSH key).

start

  1. First enable 2-step authentication

  2. In the X2go client, there is a session box on the right with a picture of a seal and a menu (hamburger bar). To start a new session, click on the seal. To edit your session preferences, click on the menu button.

    x2go start
  3. Type your password in the field provided.

    x2go password
  4. A new window will open requesting a ‘Verification Code’. Open the Google Authenticator app on your device, and look for the 6 digit code. Type that code into the window requesting the ‘Verification Code’.

    x2go verification

suspend/resume or terminate?

To terminate your session, click the ‘power’ button.

x2go menu

Alternatively, you may resume your X2Go session later (from another computer). This is called ‘suspend’, although your jobs continue to run in the background. To suspend a session, click the ‘pause’ button just to the left of the power button (displayed above), or simply close your laptop.

If you suspended your X2Go session, and start a new X2Go session on a different computer, then your old X2Go session will be terminated automatically.

If you want to resume a X2Go session, but forgot where it’s running, then use the ‘cjobs’ command to locate your x2goagent process:

  1. Log into a Neuro cluster computer with secure shell

  2. Run the ‘cjobs’ command:

    [joe@nx5 ~]$ cjobs

performance

for best performance...

  1. Login to the X2Go server with the fewest number of users. This information is provided below, or by using ‘nxload’ command on the Neuro cluster.

    host load
  2. Limit cpu-intensive jobs within X2Go

    The X2Go servers have only 8 CPU cores, and are used by multiple labs.

    If you use more than 3 cpu cores in your X2Go session, then your jobs may be restricted to a single CPU core. You will receive email with instructions about how to use Grid Engine to run jobs in parallel. Grid Engine distributes jobs across the cluster for optimal performance.

  3. When using secure shell (SSH) or python notebook, log into the server where your X2Go session is running.

    Please do not log into multiple servers simultaneously. If you want to run jobs in parallel, please use Grid Engine.

  4. Use your local web browser to display the Jupyter Notebook.

  5. If you experience network lag...

    • in the office, use a wired network connection. Shared wireless networks may cause lag if somebody is transferring data.
    • disable backup software on your computer (dropbox, Google drive, Box, etc)
    • confirm that your (graphics) application uses a graphics processor to render images. For a list of applications that use a graphics processor, run ‘gapp’ from the command line.
  6. if you continue to experience performance problems, email support-neuro@berkeley.edu. Please include the following information:

    • description of problem, e.g. slow screen updates, analysis takes longer to complete, etc
    • name of server, e.g. nx1
    • name of program
    • command line used to run program
    • error message

troubleshooting

login fails

If you receive an error when logging in via X2Go, then

  1. wait a few minutes. The X2Go state database is refreshed every 5-10 minutes

  2. log into a server with the fewest users

    host load
  3. email support-neuro@berkeley.edu. If you’ve waited a few minutes, and want to resume your session, then email me. Sometimes I can help ;)

fonts

If text is too large or misaligned, then Set Display DPI=100 in the X2Go settings Input/Output tab.
This may be useful for FSL’s Feat application on MacOSX.