Skip to content

Add command to enable Cylc uiserver in Jupyter launcher #624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add command to enable Cylc uiserver in Jupyter launcher #624

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,12 @@ However, you can also deploy Jupyter Hub separately from the servers it
deploys (e.g. Jupyter Lab or Cylc UI Server) and launch it via the `jupyterhub`
command.

Enable the Cylc UI Server in `jupyterhub` or `jupyter lab` by running
```bash
jupyter server extension enable --py cylc.uiserver
```
The Cylc UI will be available by replacing `/lab` in the URL with `/cylc`.

Comment on lines +122 to +127
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Enable the Cylc UI Server in `jupyterhub` or `jupyter lab` by running
```bash
jupyter server extension enable --py cylc.uiserver
```
The Cylc UI will be available by replacing `/lab` in the URL with `/cylc`.

I think this command will fail (or create a file in a user-specific location) in many situations because it requires the user to have write access to the deployment which they might not have. For transparency we aught to document the configuration and leave them to decide where best to configure it.

Note, this applies to Jupyter Lab not Jupyter Hub.

If you are deploying Jupyter Hub separately from Cylc UI Server, these
configurations may be relevant:

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* If the `spawner.cmd` is something other than `cylc hubapp` (e.g. `jupyter lab`), then you will need to use the Jupyter Server [jpserver_extensions](https://jupyter-server.readthedocs.io/en/latest/other/full-config.html) configuration to enable the Cylc UI Server i.e. `jpserver_extensions = {"cylc.uiserver": true}`. The Cylc UI will be available by replacing `/lab` in the URL with `/cylc`.

Expand Down