jupyter-code-server

Running VSCode Web IDE code-server inside the Jupyter environment.

Table of Contents

• jupyter-code-server
  • Table of Contents
  • Requirements
  • Installation
  • Configuration
    • Setting the working directory
    • Loading code-server using Lmod

Requirements

• Installed version of https://github.com/coder/code-server
  • If code-server is installed via Lmod: Loading code-server using Lmod
• jupyter-server-proxy>=4.1.2

Installation

python3 -m pip install jupyter-code-server

Configuration

Setting the working directory

The environment variable CODE_WORKING_DIRECTORY is prioritised and can be changed for the VSCode Web IDE independently of the Jupyter working/notebook directory.

The order/priority is as follows:

1. CODE_WORKING_DIRECTORY, if not set:
2. JUPYTERHUB_ROOT_DIR, if not set:
3. JUPYTER_SERVER_ROOT, if not set:
4. HOME

Loading code-server using Lmod

An example of loading code-server via Lmod can be found in the branch lmod_pre_start: lmod_pre_start

Important: You might want to change the loaded code-server version.