Hi all,
While it is simple to use the Cylc Web GUI via the ARE, many of us prefer to use the CLI over ARE. It’s possible to use the Web GUI using SSH tunneling.
First, connect to Gadi with port forwarding set up:
ssh -L <port_local>:localhost:<port_remote> <user>@gadi.nci.org.au
<port_local> is the port that your machine uses to connect to <port_remote> on Gadi. It’s easiest if these are the same, and it’s recommended to set them between 20000-29999. Ports are exclusive- you can’t select the same <port_remote> as someone else. If you’ve selected the same port as someone else, you’ll see a message like:
bind [127.0.0.1]:<port_remote>: Address already in use
channel_setup_fwd_listener_tcpip: cannot listen to port: <port_remote>
Could not request local forwarding.
If you see this, use a different port- we have 10000 to choose from, and I’m pretty sure we don’t have 10000 users so you should be able to find a free one.
After connecting and loading the Cylc8 module, call
cylc gui --no-browser --port=<port_remote>
You can also specify a <workflow_name> if you want the GUI to open at a specific workflow.
This should print a bunch of text. Most of it is not useful, except for:
[C 2026-10-21 12:17:37.523 ServerApp]
To access the server, open this file in a browser:
file:///home/564/<user>/.cylc/uiserver/info_files/jpserver-1497525-open.html
Or copy and paste one of these URLs:
http://localhost:<port_remote>/cylc?token=2edd364ad6489fd89c385a8ee5002c344e04dbecbd427135
http://127.0.0.1:<port_remote>/cylc?token=2edd364ad6489fd89c385a8ee5002c344e04dbecbd427135
Take one of the URLs and paste it into your desired browser locally. You should now see the Cylc Web GUI. When your SSH connection shuts down, you will relinquish that port and others can use it.
Please tell me if you have problems- I’ve done this on a Linux machine, so there may be unforeseen problems on other OS.
We will turn this into Hive docs documentation at some point, but use this as a temporary guide.