JupyterLab module

[bpmct]

A discussion dedicated to the JupyterLab module. Share your thoughts, questions, and feedback here.

Module Scorecard

Presentation & Onboarding	IDE Integration	Credential Hygiene	Restricted-Environment Readiness	Engineering Quality	Overall
17 / 25	13 / 25	20 / 20	0 / 20	8 / 10	58 / 100

Drilldown

Presentation & Onboarding — 17 / 25

Criterion	Max	Score	Notes
Configuration-mode examples	12	12	README provides two examples: basic usage and advanced configuration with the config parameter showing JupyterLab server settings customization including CSP headers and root_dir
Coder-context framing	8	0	README does not explain what JupyterLab adds on top of Coder or where Coder fits in the flow; it only states "A module that adds JupyterLab in your Coder template" without context about the integration benefits
Visual preview	5	5	README includes an embedded image: 

IDE Integration — 13 / 25

Criterion	Max	Score	Notes
Dashboard entry point	7	7	coder_app resource present with proper configuration including healthcheck, subdomain support, and URL handling for both subdomain and path-based access
Managed configuration	6	6	config variable documented with JSON configuration support; writes to ~/.jupyter/jupyter_server_config.json via coder_script.jupyterlab_config; README shows example with ServerApp settings
Configurable folder or workdir	6	0	No documented support for opening or starting in a configured folder; the example shows root_dir = "/workspace/notebooks" as part of general config but this is not presented as a dedicated workdir feature
Pre-installed extensions	6	0	No documented support for pre-installing JupyterLab extensions

Credential Hygiene — 20 / 20

Criterion	Max	Score	Notes
Secrets marked sensitive	16	16	No sensitive inputs in the module; README examples show token and password set to empty strings (authentication disabled for local access), which is appropriate for the Coder context
Non-hardcoded auth path	4	4	Module disables authentication (--ServerApp.token='' --ServerApp.password='') relying on Coder's authentication layer; no raw keys required

Restricted-Environment Readiness — 0 / 20

Criterion	Max	Score	Notes
Mirrorable artifact source	10	0	No variable to override the JupyterLab package source; installation uses hardcoded pipx install jupyterlab or uv pip install jupyterlab with no URL override capability
Bring-your-own binary	5	0	No documented way to skip installation when JupyterLab is pre-installed; script checks command -v jupyter-lab and skips install if found, but this is not documented in README
Egress transparency	3	0	No dedicated README section enumerating external endpoints; PyPI access for package installation is implicit but not documented
Runs without sudo	2	0	Script uses pipx and uv which install to user directories ($HOME/.local/bin, $HOME/.venv/bin), but the test file shows apk add pipx and apk --no-cache add uv which require root; the module assumes these tools are pre-installed but doesn't document the no-sudo installation path

Engineering Quality — 8 / 10

Criterion	Max	Score	Notes
Input quality	6	6	Variables have clear descriptions and sensible defaults; share has validation; port, log_path, subdomain, order, group, and config all well-documented
Test coverage	4	2	TypeScript tests cover installer detection, config file writing, and CSP fallback behavior; however, actual installation tests are commented out as TODOs due to timeouts; no .tftest.hcl file present

Overall — 58 / 100

---

Scored against SCORECARD.md on 2026-08-03 with claude-sonnet-4-5.