{"id":15687154,"url":"https://github.com/manics/jupyterhub-rtc-example","last_synced_at":"2025-05-07T19:09:41.285Z","repository":{"id":45371702,"uuid":"391196128","full_name":"manics/jupyterhub-rtc-example","owner":"manics","description":"Example of using JupyterHub with JupyterLab RTC","archived":false,"fork":false,"pushed_at":"2021-12-17T02:37:45.000Z","size":4,"stargazers_count":11,"open_issues_count":1,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-05-07T19:08:48.576Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/manics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-07-30T22:01:09.000Z","updated_at":"2025-01-30T18:05:09.000Z","dependencies_parsed_at":"2022-09-19T09:00:58.777Z","dependency_job_id":null,"html_url":"https://github.com/manics/jupyterhub-rtc-example","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Fjupyterhub-rtc-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Fjupyterhub-rtc-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Fjupyterhub-rtc-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Fjupyterhub-rtc-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/manics","download_url":"https://codeload.github.com/manics/jupyterhub-rtc-example/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252940934,"owners_count":21828769,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-03T17:44:16.131Z","updated_at":"2025-05-07T19:09:41.217Z","avatar_url":"https://github.com/manics.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JupyterHub JupyterLab RTC demo\n\nThis is a demo of configuring JupyterHub to support [JupyterLab Real Time Collaboration](https://jupyterlab.readthedocs.io/en/stable/user/rtc.html).\n\nSee https://discourse.jupyter.org/t/plans-on-bringing-rtc-to-jupyterhub/9813/5\n\n**WARNING: This uses unreleased features of JupyterHub. The configuration is only for demo purposes and is insecure.**\n\n\n## Installation\n\nClone this repository:\n```\ngit clone https://github.com/manics/jupyterhub-rtc-example.git\n```\n\nInstall JupyterHub's dependencies including configurable-http-proxy:\n```\ncd jupyterhub-rtc-example\nconda env create -n jupyterhub-rtc --file environment.yml\n```\nActivate the environment, then install JupyterHub from GitHub using pip:\n```\nconda activate jupyterhub-rtc\npip install git+https://github.com/jupyterhub/jupyterhub.git@main#egg=jupyterhub\n```\n(Last tested with `git+https://github.com/jupyterhub/jupyterhub.git@3800ceaf9edf33a0171922b93ea3d94f87aa8d91#egg=jupyterhub`)\n\n\n## Run JupyterHub\n\nActivate environment\n```\nconda activate jupyterhub-rtc\ncd jupyterhub-rtc-example\n```\nRun JupyterHub:\n```\njupyterhub --config jupyterhub_config.py\n```\n\n\n## Login\n\nGo to http://localhost:8000 and login as `user-1` with any password.\nYou should be in JupyterLab.\nCreate a new Python notebook.\n\nIn a different browser or incognito window go to http://localhost:8000 and login as `user-2` with any password.\nYou should see your own JupyterLab separate from `user-1`.\n\nCopy `user-1`'s JupyterLab notebook URL into `user-2`'s browser.\nClick `Authorize` if prompted.\nYou should now have an RTC connection to `user-1`'s server!\n\nIf you logout, and login as `user-3`, you should *not* have access to anyone else's server.\n\n\n## How this works\n\nThis uses JupyterHub's new [*Role Base Access Control (RBAC)*](https://jupyterhub.readthedocs.io/en/rbac/rbac/) which will be part of JupyterHub 2.\nRBAC allows very fine-grained control of permissions in JupyterHub.\nIn this example users who are part of a group `rtc` are given the `access:servers` permission, which allows them to access the servers of any other user in the `rtc` group.\n\nSee `c.JupyterHub.load_roles` in [`jupyterhub_config.py`](./jupyterhub_config.py).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanics%2Fjupyterhub-rtc-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmanics%2Fjupyterhub-rtc-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanics%2Fjupyterhub-rtc-example/lists"}