feat: Containerized remote development workspaces

.cspell.json

@@ -447,6 +447,9 @@
 		"venv",
 		"vetur",
 		"Vetur",
+		"devbox",
+		"devboxes",
+		"websockify",
 		"Vevay",
 		"vfat",
 		"vimrc",
@@ -483,4 +486,4 @@
 		"sdg",
 		"asrc"
 	]
-}
+}

dashboard/src2/components/NavigationItems.vue

@@ -143,6 +143,13 @@ export default {
 					),
 					disabled: enforce2FA
 				},
+				{
+					name: 'Dev Boxes',
+					icon: () => h(Package),
+					route: '/devboxes',
+					condition: this.$team.doc?.devboxes_enabled,
+					disabled: enforce2FA
+				},
 				{
 					name: 'Billing',
 					icon: () => h(WalletCards),

devbox-dockerfile/Dockerfile

@@ -0,0 +1,134 @@
+FROM debian:12-slim
+
+ENV DEBIAN_FRONTEND=noninteractive \
+    LANG=en_US.UTF-8 \
+    LC_ALL=C.UTF-8 \
+    PASSWORD=password \
+    VNC_PASSWORD=password
+
+# Install required packages
+RUN apt-get update && apt-get install -y \
+    xfce4 \
+    xfce4-terminal \
+    tigervnc-standalone-server \
+    tigervnc-common \
+    novnc \
+    websockify \
+    supervisor \
+    curl \
+    wget \
+    git \
+    net-tools \
+    procps \
+    xauth \
+    dbus-x11 \
+    firefox-esr \
+    mariadb-server \
+    mariadb-client \
+    python3-dev \
+    python3-pip \
+    redis-server \
+    xvfb \
+    libfontconfig \
+    wkhtmltopdf \
+    sudo \
+    x11-xserver-utils \
+    xfonts-base \
+    pm-utils \
+    pulseaudio \
+    dbus-x11 \
+    policykit-1-gnome \
+    python3-venv \
+    cron \
+    locales \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/* \
+    && locale-gen en_US.UTF-8
+
+# Configure MariaDB root password
+RUN service mariadb start && \
+    mysqladmin -u root password 'frappe' && \
+    mysql -u root -pfrappe -e "GRANT ALL PRIVILEGES ON *.* TO 'root'@'localhost' IDENTIFIED BY 'frappe' WITH GRANT OPTION; FLUSH PRIVILEGES;"
+
+# Add frappe user and add to sudoers
+RUN useradd -m -s /bin/bash frappe && \
+    echo "frappe:password" | chpasswd && \
+    usermod -aG sudo frappe && \
+    echo "frappe ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers
+
+# Create necessary directories and set permissions
+RUN mkdir -p /home/frappe/.config /home/frappe/.vnc /home/frappe/.local && \
+    mkdir -p /var/log/supervisor && \
+    mkdir -p /run/user/1000 && \
+    mkdir -p /var/run/dbus && \
+    mkdir -p /var/lib/dbus && \
+    touch /home/frappe/.Xauthority && \
+    dbus-uuidgen > /var/lib/dbus/machine-id && \
+    chown -R frappe:frappe /home/frappe && \
+    chown -R frappe:frappe /var/log/supervisor && \
+    chown -R frappe:frappe /run/user/1000 && \
+    chmod -R 755 /home/frappe/.config && \
+    chmod -R 755 /home/frappe/.local && \
+    chmod 700 /run/user/1000 && \
+    chmod 755 /var/run/dbus && \
+    chmod -R 755 /var/lib/dbus
+
+# Set up VNC configuration
+RUN mkdir -p /home/frappe/.vnc && \
+    echo "#!/bin/bash\n\
+    export XDG_SESSION_TYPE=x11\n\
+    export DBUS_SESSION_BUS_ADDRESS=unix:path=/run/dbus/system_bus_socket\n\
+    export XDG_RUNTIME_DIR=/run/user/1000\n\
+    unset SESSION_MANAGER\n\
+    unset DBUS_SESSION_BUS_ADDRESS\n\
+    exec dbus-launch --exit-with-session startxfce4" > /home/frappe/.vnc/xstartup && \
+    chmod +x /home/frappe/.vnc/xstartup && \
+    chown -R frappe:frappe /home/frappe/.vnc
+
+# Install bench CLI
+RUN pip3 install frappe-bench --break-system-packages
+
+# Switch to frappe user for remaining operations
+USER frappe
+WORKDIR /home/frappe
+ENV PATH="/home/frappe/.local/bin:$PATH"
+
+# Install NVM, Node.js, and Yarn
+RUN curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash && \
+    export NVM_DIR="/home/frappe/.nvm" && \
+    [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" && \
+    [ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion" && \
+    echo 'export NVM_DIR="$HOME/.nvm"' >> ~/.bashrc && \
+    echo '[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"' >> ~/.bashrc && \
+    echo '[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"' >> ~/.bashrc && \
+    . ~/.bashrc && \
+    nvm install 18 && \
+    nvm use 18 && \
+    nvm alias default 18 && \
+    npm install -g yarn
+
+# Install code-server
+RUN curl -fsSL https://code-server.dev/install.sh | sh
+
+# Create code-server config directory and default config
+RUN mkdir -p /home/frappe/.config/code-server && \
+    echo "bind-addr: 0.0.0.0:8443\n\
+    auth: password\n\
+    cert: false" > /home/frappe/.config/code-server/config.yaml
+
+# Copy supervisor configuration and startup script
+COPY --chown=frappe:frappe supervisord.conf /etc/supervisor/conf.d/supervisord.conf
+COPY --chown=frappe:frappe start.sh /home/frappe/start.sh
+RUN chmod +x /home/frappe/start.sh
+
+# Set environment variables
+ENV NVM_DIR=/home/frappe/.nvm \
+    PATH="/home/frappe/.nvm/versions/node/v18/bin:/home/frappe/.local/bin:${PATH}" \
+    XDG_RUNTIME_DIR=/run/user/1000 \
+    DBUS_SESSION_BUS_ADDRESS=unix:path=/run/dbus/system_bus_socket
+
+# Expose ports
+EXPOSE 6969 8443 5901
+
+# Set the default command
+CMD ["/home/frappe/start.sh"]

devbox-dockerfile/readme.md

@@ -0,0 +1,32 @@
+### Create the volumes for persistence
+
+```shell
+docker volume create db-data
+
+docker volume create home
+```
+
+### Build
+
+```shell
+docker build -t your_image_name .
+```
+
+### Run
+
+6969 is for NOVNC \
+8443 is for VSCode Server \
+5901 is for Bare VNC Port
+
+```
+docker run -d \
+  -p 6969:6969 \
+  -p 8443:8443 \
+  -p 5901:5901 \
+  -v db-data:/var/lib/mysql \
+  -v home:/home/frappe \
+  -e PASSWORD="your_code_server_password" \
+  -e VNC_PASSWORD="your_vnc_password" \
+  your_image_name
+
+```

devbox-dockerfile/start.sh

@@ -0,0 +1,56 @@
+#!/bin/bash
+
+# Stop VNC server if running
+pkill Xtigervnc || true
+
+# Clean up only specific X server files
+rm -f /tmp/.X1-lock /tmp/.X11-unix/X1 || true
+
+# Start dbus daemon using sudo
+sudo dbus-daemon --system --nofork --nopidfile &
+
+# Wait for DBus to start properly
+sleep 2
+
+# Check if DBus is running
+if ! pgrep -x "dbus-daemon" > /dev/null; then
+    echo "Error: dbus-daemon failed to start!"
+    exit 1
+fi
+
+# Initialize Xauthority
+touch ~/.Xauthority
+chmod 600 ~/.Xauthority
+
+# Validate and set VNC password
+if [ ! -z "$VNC_PASSWORD" ]; then
+    if [ ${#VNC_PASSWORD} -lt 6 ]; then
+        echo "Error: VNC password must be at least 6 characters long"
+        exit 1
+    fi
+    echo "$VNC_PASSWORD" | vncpasswd -f > ~/.vnc/passwd
+    chmod 600 ~/.vnc/passwd
+fi
+
+# Validate and set code-server password
+if [ ! -z "$PASSWORD" ]; then
+    if [ ${#PASSWORD} -lt 6 ]; then
+        echo "Error: Code-server password must be at least 6 characters long"
+        exit 1
+    fi
+    mkdir -p ~/.config/code-server
+    echo "bind-addr: 0.0.0.0:8443
+auth: password
+password: $PASSWORD
+cert: false" > ~/.config/code-server/config.yaml
+    chmod 600 ~/.config/code-server/config.yaml
+fi
+
+# Start VNC server
+if ! vncserver :1 -geometry 1280x800 -depth 24 -localhost no -xstartup ~/.vnc/xstartup; then
+    echo "Error: VNC server failed to start!"
+    exit 1
+fi
+
+# Start supervisord
+exec supervisord -n -c /etc/supervisor/conf.d/supervisord.conf

devbox-dockerfile/supervisord.conf

@@ -0,0 +1,76 @@
+[supervisord]
+nodaemon=true
+user=frappe
+logfile=/var/log/supervisor/supervisord.log
+pidfile=/run/user/1000/supervisord.pid
+
+[program:dbus]
+priority=1
+command=sudo /usr/bin/dbus-daemon --system --nofork --nopidfile
+user=frappe
+startsecs=5
+autostart=true
+autorestart=true
+
+[program:vncserver]
+priority=10
+directory=/home/frappe
+command=vncserver :1 -geometry 1280x800 -depth 24 -localhost no -xstartup /home/frappe/.vnc/xstartup
+user=frappe
+environment=HOME="/home/frappe",USER="frappe",DISPLAY=":1",XDG_RUNTIME_DIR="/run/user/1000",LANG="en_US.UTF-8",LC_ALL="C.UTF-8",DBUS_SESSION_BUS_ADDRESS="unix:path=/run/dbus/system_bus_socket"
+autostart=true
+autorestart=true
+startsecs=5
+startretries=5
+stderr_logfile=/var/log/supervisor/vncserver.stderr.log
+stdout_logfile=/var/log/supervisor/vncserver.stdout.log
+stopasgroup=true
+killasgroup=true
+
+[program:novnc]
+priority=20
+directory=/usr/share/novnc
+command=/usr/bin/websockify --web=/usr/share/novnc 6969 localhost:5901
+user=frappe
+environment=HOME="/home/frappe",USER="frappe"
+autostart=true
+autorestart=true
+startsecs=5
+startretries=3
+stderr_logfile=/var/log/supervisor/novnc.stderr.log
+stdout_logfile=/var/log/supervisor/novnc.stdout.log
+
+[program:code-server]
+priority=30
+directory=/home/frappe
+command=/usr/bin/code-server --config /home/frappe/.config/code-server/config.yaml
+user=frappe
+environment=HOME="/home/frappe",USER="frappe",XDG_DATA_HOME="/home/frappe/.local/share",XDG_CONFIG_HOME="/home/frappe/.config"
+autostart=true
+autorestart=true
+startsecs=5
+startretries=3
+stderr_logfile=/var/log/supervisor/code-server.stderr.log
+stdout_logfile=/var/log/supervisor/code-server.stdout.log
+
+[program:redis]
+priority=40
+command=sudo /usr/bin/redis-server
+user=frappe
+autostart=true
+autorestart=true
+startsecs=5
+startretries=3
+stderr_logfile=/var/log/supervisor/redis.stderr.log
+stdout_logfile=/var/log/supervisor/redis.stdout.log
+
+[program:mariadb]
+priority=50
+command=sudo /usr/bin/mysqld_safe
+user=frappe
+autostart=true
+autorestart=true
+startsecs=5
+startretries=3
+stderr_logfile=/var/log/supervisor/mariadb.stderr.log
+stdout_logfile=/var/log/supervisor/mariadb.stdout.log

press/agent.py

@@ -978,6 +978,7 @@ def create_agent_job(
 		bench=None,
 		site=None,
 		code_server=None,
+		devbox=None,
 		upstream=None,
 		host=None,
 		reference_doctype=None,
@@ -1009,6 +1010,7 @@ def create_agent_job(
 				"host": host,
 				"site": site,
 				"code_server": code_server,
+				"devbox": devbox,
 				"upstream": upstream,
 				"status": "Undelivered",
 				"request_method": method,

press/api/site.py

@@ -1581,9 +1581,10 @@
 
 @frappe.whitelist()
 def exists(subdomain, domain):
+	from press.press.doctype.devbox.devbox import Devbox
 	from press.press.doctype.site.site import Site
 
-	return Site.exists(subdomain, domain)
+	return Site.exists(subdomain, domain) or Devbox.exists(subdomain, domain)
 
 
 @frappe.whitelist()