sahajs59/labx repository overview

⁠LabX

A self-contained, Docker-powered Python development environment combining JupyterLab and a VS Code-compatible browser IDE in a single container.

⁠🧪 What is LabX?

LabX is a batteries-included Python lab environment that runs entirely inside Docker. With a single command you get:

Both services share the same Python environment and /workspace directory, so code you write in one is immediately available in the other.

⁠✨ Features

• 🐍 Python 3.11.9 on a slim Debian (Bookworm) base
• 📓 JupyterLab 4.6.2 with the Simpledark theme pre-configured
• 🖥️ LabX-Server (code-server 4.132.0) with custom branding, login strings, and a curated set of pre-installed VS Code extensions
• 📦 Rich Python package stack — NumPy, Pandas, Scikit-learn, PyTorch-ready (Keras, Transformers, Accelerate), OpenCV, NLTK, spaCy, MLflow, W&B, Stable-Baselines3, Gymnasium, and more
• 🔑 Password-protected — both services require authentication (default password configurable via env var)
• 🎨 Custom branding — LabX logo replaces all code-server icons and favicons
• 🔧 17 pre-bundled VS Code extensions installed offline from .vsix files, including Python, Jupyter, Prettier, Rainbow CSV, Database Client, Code Runner, and several themes
• 🏗️ Multi-arch — supports linux/amd64 and linux/arm64
• 📁 Persistent workspace — mount a host directory to /workspace and your files persist across container restarts

⁠🚀 Quick Start

⁠Prerequisites

• Docker⁠ installed and running

⁠1 — Pull & Run (once published to a registry)

docker run -d \
  --name labx \
  -p 5959:5959 \
  -p 5960:5960 \
  -v "$(pwd)/workspace:/workspace" \
  -e LABX_PASSWORD=mysecretpassword \
  labx:latest

⁠2 — Build from Source

git clone https://github.com/<your-org>/labx.git
cd labx

docker build -t labx:latest .

Then run the container:

docker run -d \
  --name labx \
  -p 5959:5959 \
  -p 5960:5960 \
  -v "$(pwd)/workspace:/workspace" \
  -e LABX_PASSWORD=mysecretpassword \
  labx:latest

⁠3 — Open in your browser

Login with the password you set via LABX_PASSWORD (default: labx@123).

⁠⚙️ Configuration

⁠🐳 Docker Compose (recommended)

Create a docker-compose.yml in your project directory:

services:
  labx:
    image: labx:latest
    container_name: labx
    ports:
      - "5959:5959"  # JupyterLab
      - "5960:5960"  # LabX-Server
    volumes:
      - ./workspace:/workspace
    environment:
      - LABX_PASSWORD=mysecretpassword
    restart: unless-stopped

Then start with:

docker compose up -d

⁠📦 Pre-installed Python Packages

⁠🔌 Pre-installed VS Code Extensions

⁠📁 Repository Structure

labx/
├── Dockerfile              # Main multi-stage Docker build
├── start.sh                # Container entrypoint — starts JupyterLab & LabX-Server
├── requirements.txt        # Top-level Python package list (unpinned)
├── requirements-linux.txt  # Fully pinned package list for Linux/Docker
├── branding/
│   └── logo.png            # LabX logo (applied to code-server UI)
├── jupyter/
│   └── overrides.json      # JupyterLab default theme settings
└── vscode/
    ├── settings.json       # Default VS Code / code-server user settings
    └── vsix/               # Pre-bundled VS Code extensions (.vsix)

⁠🛠️ Ports Reference

⁠🏗️ Building for Multiple Architectures

Use Docker Buildx to build for both amd64 and arm64:

docker buildx build \
  --platform linux/amd64,linux/arm64 \
  -t labx:latest \
  --push .

⁠🤝 Contributing

Contributions are welcome! Here are a few ways to help:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/my-feature)
3. Commit your changes (git commit -m "feat: add my feature")
4. Push to your branch (git push origin feature/my-feature)
5. Open a Pull Request

Please keep commits focused and descriptive.

⁠📄 License

This project is licensed under the MIT License — see the LICENSE⁠ file for details.