{"id":26232669,"url":"https://github.com/pc2/jupyter-code-server","last_synced_at":"2025-04-22T10:42:08.525Z","repository":{"id":241724253,"uuid":"807426933","full_name":"pc2/jupyter-code-server","owner":"pc2","description":"Running VSCode Web IDE inside the Jupyter environment","archived":false,"fork":false,"pushed_at":"2024-11-29T06:07:22.000Z","size":48,"stargazers_count":3,"open_issues_count":1,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-22T10:42:04.624Z","etag":null,"topics":["codeserver","jupyter","jupyter-server-proxy","jupyterlab","jupyterlab-extension","visual-studio-code","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pc2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-29T04:53:54.000Z","updated_at":"2025-02-19T17:27:02.000Z","dependencies_parsed_at":"2024-06-19T14:06:58.972Z","dependency_job_id":null,"html_url":"https://github.com/pc2/jupyter-code-server","commit_stats":null,"previous_names":["mawigh/jupyter-code-server"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pc2%2Fjupyter-code-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pc2%2Fjupyter-code-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pc2%2Fjupyter-code-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pc2%2Fjupyter-code-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pc2","download_url":"https://codeload.github.com/pc2/jupyter-code-server/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250222204,"owners_count":21394835,"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":["codeserver","jupyter","jupyter-server-proxy","jupyterlab","jupyterlab-extension","visual-studio-code","vscode","vscode-extension"],"created_at":"2025-03-13T00:38:06.064Z","updated_at":"2025-04-22T10:42:08.461Z","avatar_url":"https://github.com/pc2.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pc2/jupyter-code-server/main)\n\n# jupyter-code-server\n\nRunning VSCode Web IDE code-server inside the Jupyter environment.\n\n![JupyterLab ](./imgs/code_lab_icon.png)\n\n## Table of Contents\n\n- [jupyter-code-server](#jupyter-code-server)\n  - [Table of Contents](#table-of-contents)\n  - [Requirements](#requirements)\n  - [Installation](#installation)\n  - [Configuration](#configuration)\n    - [Setting the working directory](#setting-the-working-directory)\n    - [Using pre-started code-server](#using-pre-started-code-server)\n    - [Enable/disable launcher](#enabledisable-launcher)\n    - [Loading code-server using Lmod](#loading-code-server-using-lmod)\n\n\n## Requirements\n\n* Installed version of [https://github.com/coder/code-server](https://github.com/coder/code-server)\n  * If code-server is installed via Lmod: [Loading code-server using Lmod](#loading-code-server-using-lmod)\n* `jupyter-server-proxy\u003e=4.1.2`\n\n## Installation\n\n```\npython3 -m pip install jupyter-code-server\n```\n\n## Configuration\n\n### Setting the working directory\n\nThe environment variable `CODE_WORKING_DIRECTORY` is prioritised and can be changed for the VSCode Web IDE independently of the Jupyter working/notebook directory.\n\nThe order/priority is as follows:\n1. `CODE_WORKING_DIRECTORY`, if not set:\n2. `JUPYTERHUB_ROOT_DIR`, if not set:\n3. `JUPYTER_SERVER_ROOT`, if not set:\n4. `HOME`\n\n### Using pre-started code-server\n\nIn case code-server is already running (e.g. started in sidecar container with Jupyter running in Kubernetes)\nand servig either via TCP port or UNIX socket, it is possible to proxy this already running instance instead\nof starting a new one with jupyter-server-proxy. Variables `JSP_CODE_SERVER_PORT` and `JSP_CODE_SERVER_SOCKET`\nset `command` to empty list which makes `jupyter-server-proxy` pass requests to specified port of socket.\n\nIf running code-server is listening to TCP port, environment variable `JSP_CODE_SERVER_PORT` may be set to\nport number.\n\nIf running code-server is listening to UNIX socket, environment variable `JSP_CODE_SERVER_SOCKET` may be set to\nsocket file path.\n\nIf none of these environment variables are set, jupyter-code-server starts new code-server process and proxies\nrequests to its socket.\n\n### Enable/disable launcher\n\nBy default code-server launcher is enabled and visible in JupyterLab. Option `JSP_CODE_SERVER_LAUNCHER_DISABLED`\nmay be set to any non-empty value to disable launcher. This is useful when e.g. certain users are not supposed\nto have code-server available in Jupyterhub as there is no easy way to disable loading of entire `jupyter-code-server`\nmodule for these users if module is for example built into Docker image.\n\n### Loading code-server using Lmod\n\nIf code-server needs to be loaded from an Lmod environment you can set the `JSP_CODE_SERVER_LMOD_MODULE` variable to the path of the module.\n\nExample: `JSP_CODE_SERVER_LMOD_MODULE=tools/code-server/4.22.1`\n\nThe module will then be loaded with the help of `LMOD_CMD` and `MODULEPATH` before the code-server is started.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpc2%2Fjupyter-code-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpc2%2Fjupyter-code-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpc2%2Fjupyter-code-server/lists"}