GUI Programs
HiPerGator 2.0 documentation |
Xpra Links
- Xpra Homepage: https://xpra.org/
- Xpra Basic Usage: https://xpra.org/trac/wiki/Usage
- Xpra Advanced Usage: http://xpra.org/manual.html
Step 1: Client Installation
Xpra client installation depends on what operating system is running on your local machine.
Linux
The recommended option is to use the distribution specific packages if possible:
Ubuntu/Debian
sudo apt-get install xpra
CentOS/RHEL
sudo su - rpm --import https://winswitch.org/gpg.asc cd /etc/yum.repos.d/ curl -O https://winswitch.org/downloads/CentOS/winswitch.repo yum install xpra
Windows
XP and Newer
Download and install MS Windows files: from https://xpra.org/, Installer file can be found at https://xpra.org/dists/windows/Xpra_Setup.exe. Note that installation will require an account with Admin privileges.
MAC OS
OS X 10.5 and Newer
Download and install MAC installer files: from https://xpra.org/, Installer file can be found at https://xpra.org/dists/osx/x86/Xpra.dmg. Note that installation will require an account with Admin privileges.
Step 2: Starting your application on HiPerGator2
Step 3: Connect to Xpra Session from the client side
Linux:
Xpra is typically automatically added to your path during installation, so you can connect to your running xpra instance using the following syntax where $USERNAME is your UF GatorLink user-name, $SERVERNAME is the server where your application is running inside xpra, and $PORT is the X11 port you assigned when you started your application.
xpra attach ssh:$USERNAME@$SERVERNAME:$PORT
As an example:
testuser@jr-physics:~$ xpra attach ssh:testuser@i21a-s3.rc.ufl.edu:143 --desktop-scaling=on --dpi=96
MAC OS:
Navigate to the folder that contains the xpra executable:
cd /Applications/Xpra.app/Contents/MacOS
Second, connect to your running xpra instance using the following syntax where $USERNAME is your GatorLink user-name, $SERVERNAME is the server where your application is running inside xpra, and $PORT is the X11 port you assigned when you started your application.
./Xpra attach ssh:$USERNAME@$SERVERNAME:$PORT
Example:
./Xpra attach ssh:test-user@i21a-s3.rc.ufl.edu:143 --desktop-scaling=on --dpi=96
Microsoft Windows
First, navigate to the install location of xpra (normally C:\Program Files (x86)\Xpra\).
- In MobaXterm
cd /drives/c/Progam\ Files\ \(x86\)/Xpra/
Second, connect to your running xpra instance using the following syntax where $USERNAME is your GatorLink user-name, $SERVERNAME is the server where your application is running inside xpra, and $PORT is the X11 port you assigned when you started your application.
./xpra attach ssh:$USERNAME@$SERVERNAME:$PORT
- Example
./xpra attach ssh:testuser@i21a-s3.rc.ufl.edu:143 --desktop-scaling=on --dpi=96
- NOTE
- If you close the window using the close button, this will exit your application just like a native application. If you want to simply detach the session and come back later, please follow the detaching xpra session instructions below
Step 4: Detaching Xpra Session
These instructions allow you to detach a running xpra client without closing the application.
Linux and MAC OS
In the original terminal where you activated the client, simply press Control-C to detach the session.
2016-04-06 15:18:17,173 Attached to ssh:testuser@i21a-s3.rc.ufl.edu:143 (press Control-C to detach) ^C got signal SIGINT, exiting 2016-04-06 15:18:42,513 Connection lost
You can re-attach to the running application using the xpra attach command as described in the instructions above.
Windows
- Start a new console and navigate to the xpra directory as shown above.
- Run the following command where $USERNAME is your UF GatorLink user-name, $SERVERNAME is the server where your application is running inside xpra, and $PORT is the X11 port you assigned when you started your application.
./xpra detach ssh:$USERNAME@$SERVERNAME:$PORT
- Example
cd "C:\Program Files (x86)\Xpra" ./xpra detach ssh:testuser@i21a-s3.rc.ufl.edu:143
- Note
- If you are using mobaXterm, you can press Control-C in the mobaXterm window to detach, just like using the Linux client.
Startup Scripts
Some applications that require key command line parameters for launching, are more convienent to wrap with a startup script. Here is an annotated version and some application examples. The executable file can be downloaded here: matlab-launch.sh
Matlab Example
The first line of the launch script should set which shell type to use. On HiPerGator systems, the default shell is bash.
#!/bin/bash
Next, load the modules required for the application:
module load matlab;
Finally, enter the launch command for the GUI application:
matlab -nosplash -desktop
Once the script is saved, you will need to make it executable to run as an application wrapper. This can be done with the "chmod" command:
[testuser@gator3 ~]$ chmod u+x matlab-launch.sh
Below are some other application launch script examples:
Other Examples
MZmine
#!/bin/bash module load mzmine; startMZmine_Linux.sh;
MZmine with 8GB of memory:
#!/bin/bash module load mzmine export _JAVA_OPTIONS="-Xmx8g" startMZmine_Linux.sh
Rstudio
#!/bin/bash module load gui rstudio; rstudio;
Other tested applications
- trackvis
Notes: Application window appears correctly, waiting on license key in inital window
- xterm
Notes: Works as expected
- End current Xpra documentation slated for wiki