Jupyter-remote-desktop-proxy

VNC servers' accessed via this project must be accessed via a unix
socket instead of a TCP port. Previously only TigerVNC was accessed via a unix
socket. This change means jupyter-remote-desktop-proxy can be used in shared
environments as long as the file permissions on the unix socket restrict access
to a single user. TCP connections to the VNC server are no longer supported.

Breaking changes

- TurboVNC version 3.1 or higher is now required ([145](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/145)).
- VNC servers needs to support the `-rfbunixpath` flag (TigerVNC and TurboVNC does) ([145](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/145)).
- This project no longer relies on `websockify` ([119](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/119)).

New features added

- Override xstartup with environment variable `JUPYTER_REMOTE_DESKTOP_PROXY_XSTARTUP` [134](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/134) ([manics](https://github.com/manics), [consideRatio](https://github.com/consideRatio))

Enhancements made

- Access TurboVNC via a unix socket instead of a port [145](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/145) ([consideRatio](https://github.com/consideRatio), [manics](https://github.com/manics))
- Resize desktop to window, instead of scaling [124](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/124) ([manics](https://github.com/manics), [yuvipanda](https://github.com/yuvipanda))
- Close clipboard if clicked outside [122](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/122) ([manics](https://github.com/manics), [yuvipanda](https://github.com/yuvipanda))
- Remove websockify, add Playwright test [119](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/119) ([manics](https://github.com/manics), [consideRatio](https://github.com/consideRatio))

Bugs fixed

- Build and package JS built with webpack --mode production [147](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/147) ([consideRatio](https://github.com/consideRatio), [manics](https://github.com/manics))

Maintenance and upkeep improvements

- Switch to date tag for base image, install nodejs [136](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/136) ([manics](https://github.com/manics), [consideRatio](https://github.com/consideRatio))
- Remove tigervnc-xorg-extension [132](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/132) ([manics](https://github.com/manics), [consideRatio](https://github.com/consideRatio))
- Rename tooltip to clipboard [121](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/121) ([manics](https://github.com/manics), [consideRatio](https://github.com/consideRatio))

Dependency updates

- Pin js dependency novnc to 1.5.0 until we support 1.6.0 [142](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/142) ([consideRatio](https://github.com/consideRatio))
- Update to use novnc 1.5.0 [123](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/123) ([manics](https://github.com/manics), [yuvipanda](https://github.com/yuvipanda))
- Pin novnc/novnc 1.4.x pending 1.5.x compatibility [120](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/120) ([manics](https://github.com/manics), [consideRatio](https://github.com/consideRatio))

Continuous integration improvements

- Pin dockerfile SHA, bump monthly with dependabot [130](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/130) ([manics](https://github.com/manics), [consideRatio](https://github.com/consideRatio))
- Install netcat-openbsd in tests and update screenshots for ubuntu 24.04 [129](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/129) ([manics](https://github.com/manics), [consideRatio](https://github.com/consideRatio))

Other merged PRs

This changelog entry omits automated PRs, for example those updating
dependencies in: images, github actions, pre-commit hooks. For a full list of
changes, see the [full comparison](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/compare/v2.0.1...v3.0.0).

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review.
See [our definition of contributors](https://github-activity.readthedocs.io/en/latest/#how-does-this-tool-define-contributions-in-the-reports).

([GitHub contributors page for this release](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/graphs/contributors?from=2024-06-13&to=2025-03-19&type=c))

benz0li ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Abenz0li+updated%3A2024-06-13..2025-03-19&type=Issues)) | consideRatio ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3AconsideRatio+updated%3A2024-06-13..2025-03-19&type=Issues)) | manics ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Amanics+updated%3A2024-06-13..2025-03-19&type=Issues)) | yuvipanda ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Ayuvipanda+updated%3A2024-06-13..2025-03-19&type=Issues))

([full changelog](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/compare/v2.0.0...v2.0.1))

Bugs fixed

- Retry a few times when the initial connection fails [112](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/112) ([sunu](https://github.com/sunu), [yuvipanda](https://github.com/yuvipanda))

Other merged PRs

- [pre-commit.ci] pre-commit autoupdate [111](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/111) ([consideRatio](https://github.com/consideRatio))

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review.
See [our definition of contributors](https://github-activity.readthedocs.io/en/latest/#how-does-this-tool-define-contributions-in-the-reports).

([GitHub contributors page for this release](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/graphs/contributors?from=2024-04-02&to=2024-06-13&type=c))

consideRatio ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3AconsideRatio+updated%3A2024-04-02..2024-06-13&type=Issues)) | sunu ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Asunu+updated%3A2024-04-02..2024-06-13&type=Issues)) | yuvipanda ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Ayuvipanda+updated%3A2024-04-02..2024-06-13&type=Issues))

This release removes a bundled VNC server, use of `jupyter-remote-desktop-proxy`
requires both `websockify` and a VNC server - TigerVNC and TurboVNC are
officially supported. For tested examples on how to install `websockify` and
officially supported VNC servers, see [this project's Dockerfile].

This project now publishes basic but tested images built on
[quay.io/jupyter/base-notebook] from the [jupyter/docker-stacks] to
[quay.io/jupyterhub/jupyter-remote-desktop-proxy]. Their purpose is currently
not scoped beyond use for testing and providing an example on how to install
officially supported VNC servers.

The Ctrl-Alt-Delete button is currently removed, but intended to be added back.
This is tracked by [this GitHub issue].

([full changelog](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/compare/v1.2.1...v2.0.0))

[this project's Dockerfile]: https://github.com/jupyterhub/jupyter-remote-desktop-proxy/blob/main/Dockerfile
[quay.io/jupyter/base-notebook]: https://quay.io/repository/jupyter/base-notebook?tab=tags
[quay.io/jupyterhub/jupyter-remote-desktop-proxy]: https://quay.io/repository/jupyterhub/jupyter-remote-desktop-proxy?tab=tags
[jupyter/docker-stacks]: https://github.com/jupyter/docker-stacks
[this GitHub issue]: https://github.com/jupyterhub/jupyter-remote-desktop-proxy/issues/83

Breaking Changes

- Require jupyter-server-proxy 4+ [91](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/91) ([consideRatio](https://github.com/consideRatio), [yuvipanda](https://github.com/yuvipanda))
- Require python 3.8+, up from 3.6+ [90](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/90) ([consideRatio](https://github.com/consideRatio), [manics](https://github.com/manics))
- Remove bundled VNC server [84](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/84) ([manics](https://github.com/manics), [consideRatio](https://github.com/consideRatio), [yuvipanda](https://github.com/yuvipanda))

New features added

- Publish TigerVNC and TurboVNC image to quay.io [94](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/94) ([consideRatio](https://github.com/consideRatio), [yuvipanda](https://github.com/yuvipanda))

Enhancements made

- Add a "Hub Control Panel" menu item if running inside a JupyterHub [79](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/79) ([yuvipanda](https://github.com/yuvipanda), [manics](https://github.com/manics), [unode](https://github.com/unode))
- Cleanup the UI to be much nicer [78](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/78) ([yuvipanda](https://github.com/yuvipanda), [manics](https://github.com/manics))

Bugs fixed

- MANIFEST.in: Include templates/ directory [103](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/103) ([zmcgrew](https://github.com/zmcgrew), [consideRatio](https://github.com/consideRatio))
- Fix failure to specify port for TurboVNC server [99](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/99) ([consideRatio](https://github.com/consideRatio))
- Fix TigerVNC detection for non-apt installations [96](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/96) ([consideRatio](https://github.com/consideRatio), [yuvipanda](https://github.com/yuvipanda), [goekce](https://github.com/goekce))
- [Docker image] Install fonts-dejavu for use by terminals [86](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/86) ([yuvipanda](https://github.com/yuvipanda), [manics](https://github.com/manics), [consideRatio](https://github.com/consideRatio))
- Remove xfce4-screensaver [76](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/76) ([manics](https://github.com/manics), [yuvipanda](https://github.com/yuvipanda))
- Fix container build [70](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/70) ([manics](https://github.com/manics), [yuvipanda](https://github.com/yuvipanda), [consideRatio](https://github.com/consideRatio))

Maintenance and upkeep improvements

- Fail early on missing websockify executable [107](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/107) ([consideRatio](https://github.com/consideRatio))
- refactor: small readability and consistency details [104](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/104) ([consideRatio](https://github.com/consideRatio))
- Bump dependency requirement a patch version [102](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/102) ([consideRatio](https://github.com/consideRatio))
- Fix image tests: vncserver, websockify, jupyter-remote-desktop-proxy [101](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/101) ([consideRatio](https://github.com/consideRatio), [yuvipanda](https://github.com/yuvipanda))
- Fix automation to publish tigervnc and turbovnc images [95](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/95) ([consideRatio](https://github.com/consideRatio))
- Require jupyter-server-proxy 4+ [91](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/91) ([consideRatio](https://github.com/consideRatio), [yuvipanda](https://github.com/yuvipanda))
- Require python 3.8+, up from 3.6+ [90](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/90) ([consideRatio](https://github.com/consideRatio), [manics](https://github.com/manics))
- Remove bundled VNC server [84](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/84) ([manics](https://github.com/manics), [consideRatio](https://github.com/consideRatio), [yuvipanda](https://github.com/yuvipanda))
- Stop vendoring noVNC [77](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/77) ([yuvipanda](https://github.com/yuvipanda), [manics](https://github.com/manics), [consideRatio](https://github.com/consideRatio))

Documentation improvements

- Fix typo in README.md [72](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/72) ([nthiery](https://github.com/nthiery), [yuvipanda](https://github.com/yuvipanda))

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review.
See [our definition of contributors](https://github-activity.readthedocs.io/en/latest/#how-does-this-tool-define-contributions-in-the-reports).

([GitHub contributors page for this release](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/graphs/contributors?from=2023-09-27&to=2024-04-02&type=c))

benz0li ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Abenz0li+updated%3A2023-09-27..2024-04-02&type=Issues)) | consideRatio ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3AconsideRatio+updated%3A2023-09-27..2024-04-02&type=Issues)) | goekce ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Agoekce+updated%3A2023-09-27..2024-04-02&type=Issues)) | manics ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Amanics+updated%3A2023-09-27..2024-04-02&type=Issues)) | nthiery ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Anthiery+updated%3A2023-09-27..2024-04-02&type=Issues)) | unode ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Aunode+updated%3A2023-09-27..2024-04-02&type=Issues)) | yuvipanda ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Ayuvipanda+updated%3A2023-09-27..2024-04-02&type=Issues)) | zmcgrew ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fjupyter-remote-desktop-proxy+involves%3Azmcgrew+updated%3A2023-09-27..2024-04-02&type=Issues))

([full changelog](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/compare/v1.2.0...v1.2.1))

Bugs fixed

- Revert "Simplify xtartup command" [64](https://github.com/jupyterhub/jupyter-remote-desktop-proxy/pull/64) ([yuvipanda](https://github.com/yuvipanda), [consideRatio](https://github.com/consideRatio))