/docs/workstations/wizard
WorkstationsWizard webtop-manage v1.0.0

Dual-Track Provisioning Wizard

Learn how to provision containerized Linux workstations using Quick Launch templates or Custom Blueprints.

Dual-Track Provisioning Wizard

The workstation creation wizard in webtop-manage provides two distinct modes: Quick Launch for rapid 1-click deployments, and Custom Blueprint for power-user resource, network, and storage customization.


⚡ Mode 1: Quick Launch Track

Quick Launch is designed for developers who want a ready-to-code Linux desktop in seconds without configuring low-level Docker parameters.

code
┌────────────────────────────────────────────────────────┐
│ 1. Choose Environment Template (Ubuntu / Debian)       │
│    • Real-time local image cache detection (Ready)     │
│    • Pre-pull terminal helper (docker pull ...)        │
├────────────────────────────────────────────────────────┤
│ 2. Workstation Identity & Access                       │
│    • One-click random workstation name generator       │
│    • Secure password generator & visibility toggle     │
├────────────────────────────────────────────────────────┤
│ 3. Storage & Folder Isolation                          │
│    • OS Profile: workstation-<name>-config (/config)   │
│    • Project Folder: Interactive Host Folder Browser   │
└────────────────────────────────────────────────────────┘

Curated Environment Templates

TemplateDesktopBase OSIdle RAMDefault /dev/shmBest For
Ubuntu Workstation (XFCE) (Popular)XFCE 4.18Ubuntu 24.04 LTS~250 MB1024 MBVS Code, Node.js, Python, daily coding
Ubuntu Modern GUI (KDE)KDE PlasmaUbuntu 24.04 LTS~650 MB2048 MBHigh-DPI scaling, Dolphin file manager
Debian KDE PlasmaKDE PlasmaDebian 12~600 MB2048 MBRock-solid stability, apt package repository
Debian Lightweight (XFCE)XFCEDebian 12~200 MB1024 MBLow-footprint servers, minimal resource overhead

🔍 Image Cache Detection & Pre-Pull Helper

When selecting a preset, webtop-manage queries the local Docker daemon (GET /api/catalog/image-status?image=...):

  • Image Cached on Host: Displays a Ready badge. Launching the instance starts immediately with zero download wait time.
  • Image Not Cached (~1.2GB): Displays a pre-pull command helper with a 1-click Copy Command button:
    bash
    docker pull lscr.io/linuxserver/webtop:ubuntu-xfce
    

    !TIP Copy and run the pull command in your terminal. WebTop Manage automatically monitors image cache status and updates the template to Ready the moment the download finishes.


🛠️ Mode 2: Custom Blueprint Track

For advanced multi-container environments, air-gapped sandboxes, and hardware passthrough:

1. Distro Matrix & Custom Base Images

Choose from the validated distro matrix or supply any custom Docker base image (e.g., custom CUDA or Python images derived from linuxserver/webtop).

2. Live Port Conflict Scanner

Clicking the refresh port icon scans host TCP ports starting from BASE_PORT (3000) and automatically populates the next conflict-free port.

3. Egress Traffic Policies & Multi-Network Attachments

  • Full Outbound Internet (Default): Unrestricted package installation and web browsing.
  • Restricted / Air-Gapped Sandbox: Sets Docker --internal=true on the dedicated bridge network, blocking all outbound WAN traffic.
  • Secondary Networks: Selectively attach existing Docker networks (e.g., dev-db-net, redis-net) to communicate with sibling containers.

4. Advanced Storage & Bind Mounts

  • System Profile Volume: Assign a custom named volume or pick from existing Docker volumes.
  • Project Folder: Assign a host directory or named volume for /config/workspace.
  • Custom Host Root Bind Mount: Mount an entire host folder to /config for complete direct disk mapping.

5. Hardware Allocation & GPU Acceleration

  • Shared Memory (--shm-size): 1024MB (Default), 2048MB (High IDE load), 4096MB (Heavy browsing).
  • CPU & Memory Limits: Real-time quota enforcement (0 = Uncapped).
  • Hardware Acceleration: Automatically passes /dev/dri render nodes into the container for Intel QuickSync and GPU rendering.

📊 Live Provisioning Experience (SSE Stream)

When you click Launch Workstation, the modal transitions into the live provisioning view:

  1. 5-Step Animated Lifecycle Checklist:
    • 1. Docker Base Image $\rightarrow$ 2. Storage Volumes & Mounts $\rightarrow$ 3. Isolated Sandbox Network $\rightarrow$ 4. Launch & Port Binding $\rightarrow$ 5. Online Ready.
  2. Layer Download Progress Bar: Calculates and renders aggregated percentage, download speed, and megabytes across concurrent registry layers.
  3. Console Log Stream: Live output of container instantiation events with a Copy Logs button.
  4. Post-Provision Credentials Card: Displays assigned credentials (abc), one-click password reveal/copy, and a direct button to launch the desktop in a new browser tab.