We have released cylc-uiserver 1.4.0.
This update upgrades cylc-uiserver to work with the most recent versions of Jupyter components, namely:
- Jupyter Server v2.7+
- Jupyter Hub v4.0+
This release offers some big improvements for sites looking to deploy the Cylc GUI with Jupyter Hub:
- Users can now be authorised to start UI Servers on behalf of other users.
- There is now a box in the top-left of the GUI for switching user / deployment.
- The Cylc UI Server can now be deployed along with the latest versions of Jupyter Lab.
Upgrading an existing Jupyter Hub deployment to use cylc-uiserver requires some extra configuration due to the new authorisation frameworks in Jupyter Hub and Jupyter Server. For more information on how to set up a Jupyter Hub deployment with cylc-uiserver 1.4.0 see this page:
https://cylc.github.io/cylc-doc/stable/html/user-guide/sharing-access-to-workflows.html
Jupyter Hub compatibility
(note this only applies to sites which wish to deploy cylc-uiserver using Jupyer Hub)
- For cylc-flow 8.2.x, we will continue to maintain both cylc-uiserver 1.3.x and 1.4.x:
- Use cylc-uiserver 1.3.x for Jupyter Hub 1.4 - 3
- Use cylc-uiserver 1.4.x for Jupyter Hub 4.0+
- From cylc-flow 8.3.0 onwards, Jupyter Hub 4.0+ will be required.
How to update
# For Conda managed environments:
conda update 'cylc-uiserver=1.4.0'
# For Pip managed environments:
pip install 'cylc-uiserver==1.4.*'