Run Cylc gui on a different port

Cylc Cylc Support
1

Hi,
I’d like to launch the Cylc GUI on a specific port because several ports are already in use on the server I’m working on. Currently, it starts on a different port each time, which makes it a bit unpredictable.

Is there an option like cylc gui --port to set the port manually? Or maybe a configuration file I can modify to define a fixed port?

Thanks in advance!
Chloé Azria

2

Yes, you guessed right, it’s cylc gui --port=<port>.

There is also a Jupyter Server configuration for this - ServerApp.port (jupyter server configs).

1 Like
3

All cylc commands are self-documenting: cylc CMD --help

The cylc gui command is a little less obvious, in that it fronts a Jupyter server, but the top level help cylc gui --help mentions cylc gui --help-all, which shows:

--ServerApp.port=<Int>
    The port the server will listen on (env: JUPYTER_PORT).

So to get it to listen on, say, port 8891, you can do:

$ cylc gui --port=8891

#   or
$ cylc gui --ServerApp.port=8891

#   or
$ grep port ~/.cylc/uiserver/jupyter_config,py 
c.ServerApp.port = 8891
1 Like