Skip to content

Open-source LLM knowledge platform: turn raw documents into a queryable RAG, an autonomous reasoning agent, and a self-maintaining Wiki.

10.4 KB
Raw Blame
# WeKnora Sandbox Image
# Pre-built environment for executing agent skill scripts in Docker sandbox
# Multi-stage build, minimal dependencies
#
# Targets that ship from this file:
#   runtime          - the plain environment. Used by the Docker backend and
#                      as the base image of E2B templates, whose builder
#                      injects its own envd.
#   cube             - the same environment plus Cube's envd daemon. Cube
#                      builds templates straight from the image and probes
#                      :49983/health, so an image without envd can only ever
#                      fail. See website-docs/06-development/04-sandbox-deployment.md.
#   desktop-runtime  - runtime plus XFCE / x11vnc / websockify. Not a published
#                      tag; the desktop and desktop-cube targets sit on it.
#   desktop          - desktop-runtime, tagged for E2B (and a future Docker
#                      desktop path). The Docker backend does not use this yet.
#   desktop-cube     - desktop-runtime plus Cube envd.
#
# Pin every FROM to TARGETPLATFORM. BuildKit already honours --platform; the
# pin is for the legacy builder (DOCKER_BUILDKIT=0), which ignores --platform
# whenever the host's arm64 python/node is already cached. The cube target
# can then COPY envd of one architecture onto a runtime of the other — Cube
# probes the mixed image as READY and Exec fails with "exec format error".
#
# Do not give this ARG a default. A declared default beats the value BuildKit
# injects per platform, so a multi-platform build would run every platform on
# the amd64 rootfs and only relabel the config. The legacy builder injects
# nothing and rejects an empty --platform, hence the amd64 fallback in FROM:
# under that builder an arm64 image needs --build-arg TARGETPLATFORM.
ARG TARGETPLATFORM

# Stage 1: Get Node.js binaries
FROM --platform=${TARGETPLATFORM:-linux/amd64} node:20-slim AS node-base

FROM --platform=${TARGETPLATFORM:-linux/amd64} ghcr.io/astral-sh/uv:0.12.4 AS uv-base

# Stage 2: Runtime image
#
# 3.12 is the floor because skill sources commonly use PEP 701 nested quotes
# in f-strings (f"x={d["k"]}"). Install-time ast.parse runs this interpreter;
# 3.11 rejects that syntax and the whole skill install fails.
FROM --platform=${TARGETPLATFORM:-linux/amd64} python:3.12-slim AS runtime

# Fail the build when the rootfs is not the platform being built. No default:
# BuildKit sets TARGETARCH per platform; the legacy builder leaves it empty.
ARG TARGETARCH
RUN arch="$(dpkg --print-architecture)"; \
    if [ -n "$TARGETARCH" ] && [ "$arch" != "$TARGETARCH" ]; then \
        echo "runtime rootfs is $arch but TARGETARCH=$TARGETARCH" >&2; \
        exit 1; \
    fi

# Copy Node.js from node image (avoids NodeSource install overhead)
COPY --from=node-base /usr/local/bin/node /usr/local/bin/
COPY --from=node-base /usr/local/lib/node_modules /usr/local/lib/node_modules
RUN ln -s /usr/local/lib/node_modules/npm/bin/npm-cli.js /usr/local/bin/npm && \
    ln -s /usr/local/lib/node_modules/npm/bin/npx-cli.js /usr/local/bin/npx

# Python package manager: uv (fast pip replacement). Preinstalled because each
# skill gets its own venv at install time, and building that from a cold pip is
# what dominates an install's wall clock.
COPY --from=uv-base /uv /usr/local/bin/uv
RUN ln -s /usr/local/bin/uv /usr/local/bin/uvx

# Node package manager: pnpm
RUN npm install -g pnpm

# Install minimal CLI tools (bash/grep/sed/coreutils/findutils already in slim
# image). `file` is not in slim; models reach for it after a script-type error.
# curl is not optional: the sandbox connectivity check probes egress with it,
# and skills that fetch a URL expect it to be there. The compression tools are
# here because skill bundles and their assets arrive archived. git backs
# per-turn workspace checkpoints (object store at /var/lib/weknora/workspace.git,
# work tree /workspace) that session fork and rewind roll back to.
RUN apt-get update && apt-get install -y --no-install-recommends \
    jq \
    curl \
    ca-certificates \
    file \
    zip \
    unzip \
    bzip2 \
    xz-utils \
    zstd \
    git \
    && rm -rf /var/lib/apt/lists/* /var/cache/apt/*

# Add packages here when installed skills actually need them:

# Sandbox scripts run as root by default: each chat session owns its own
# sandbox, so the in-container account is not a tenant boundary, and agents are
# expected to install packages and write wherever they need. A non-root
# "user" account (UID 1000) is still created and named for interop — E2B
# templates expose it and some tooling still addresses it by name — and it
# gives something for `sudo` and E2B/Cube requests that target a named account
# to land on. The Docker backend can also address it numerically as 1000:1000.
RUN groupadd -g 1000 user && \
    useradd -u 1000 -g user -m -s /bin/bash user

# Pre-create the two directories every backend writes to. Root can create them
# at exec time too. Ownership stays with the compatibility account so tools
# explicitly selecting user can also write here; default root execs do not
# rely on that ownership.
RUN mkdir -p /workspace/input /workspace/output && \
    chown -R user:user /workspace

# Classic user@host:path prompt (colored). E2B's provisioner later appends
# `PS1='\w $ '`; the script reapplies this prompt via PROMPT_COMMAND so
# Cube, Docker, and E2B all show the same Debian-style line.
COPY docker/sandbox-pty-prompt.sh /etc/weknora/pty-prompt.sh
RUN echo '. /etc/weknora/pty-prompt.sh' > /etc/profile.d/zz-weknora-prompt.sh && \
    echo '. /etc/weknora/pty-prompt.sh' >> /root/.bashrc && \
    echo '. /etc/weknora/pty-prompt.sh' >> /home/user/.bashrc

WORKDIR /workspace
USER root

# Stage 3: Cube template image
#
# envd is what Cube talks to for everything — the readiness probe that decides
# whether a template build succeeds, plus every later exec and file call. It
# runs as root and selects the account named in each request. WeKnora names
# root by default, matching the runtime stage.
#
# Built for amd64 and arm64: cubesandbox-base ships both, and Cube runs on
# x86_64 (PVM or bare-metal KVM) and on arm64 bare-metal KVM. PVM itself is
# x86_64-only, so an arm64 Cube host needs native KVM.
FROM --platform=${TARGETPLATFORM:-linux/amd64} ghcr.io/tencentcloud/cubesandbox-base:2026.16 AS cube-base

FROM runtime AS cube

USER root
COPY --from=cube-base /usr/bin/envd /usr/bin/envd
COPY --from=cube-base /usr/local/bin/cube-entrypoint.sh /usr/local/bin/cube-entrypoint.sh
# Compare envd with the rootfs rather than trusting TARGETARCH: the legacy
# builder leaves TARGETARCH empty, and a mixed image is exactly what this
# guard exists to stop.
RUN arch="$(dpkg --print-architecture)"; \
    case "$arch" in amd64) elf=x86-64 ;; arm64) elf=aarch64 ;; *) elf="$arch" ;; esac; \
    if ! file -bL /usr/bin/envd | grep -q "$elf"; then \
        echo "envd is$(file -bL /usr/bin/envd | cut -d, -f2) but rootfs is $arch" >&2; \
        exit 1; \
    fi

EXPOSE 49983
# The entrypoint backgrounds envd and then waits on it, since this image
# defines no CMD of its own.
ENTRYPOINT ["/usr/local/bin/cube-entrypoint.sh"]

# Stage 4: desktop environment on top of runtime.
#
# Debian package names (runtime is python:3.12-slim, not Ubuntu). Do not run
# `yes | unminimize` — Debian has no such command. Do not clone noVNC; the
# WeKnora frontend uses @novnc/novnc and the sandbox only needs websockify.
# procps supplies pgrep for the start script; util-linux supplies flock.
FROM runtime AS desktop-runtime

USER root
# DISPLAY is exported by start-desktop.sh when the desktop actually starts.
# Do not bake it into the image ENV: Cube copies image ENV onto the cubebox
# and a preset DISPLAY=:0 is the only env the working main-cube templates
# do not have.
ENV DEBIAN_FRONTEND=noninteractive
# XFCE apps (mousepad, xfce4-terminal) decode files with the process locale.
# python:slim defaults to POSIX/C, which is why the desktop shows mojibake
# while the WeKnora terminal tab does not: that tab is xterm.js in the
# browser, and Cube/E2B already stamp LANG/LC_ALL on the envd PTY.
# C.UTF-8 is built into glibc; do not pull locales-all.
ENV LANG=C.UTF-8
ENV LC_ALL=C.UTF-8

RUN apt-get update && apt-get install -y --no-install-recommends \
    procps \
    util-linux \
    xvfb \
    x11-utils \
    x11-xserver-utils \
    xauth \
    dbus \
    dbus-x11 \
    xfce4 \
    xfce4-goodies \
    x11vnc \
    websockify \
    xdotool \
    scrot \
    fonts-dejavu-core \
    fonts-noto-cjk \
    desktop-base \
    && rm -rf /var/lib/apt/lists/* /var/cache/apt/* \
    && rm -f /etc/rcS.d/S??procps /etc/rcS.d/S??x11-common \
          /etc/rc2.d/S??dbus /etc/rc3.d/S??dbus \
          /etc/rc4.d/S??dbus /etc/rc5.d/S??dbus

COPY docker/scripts/start-desktop.sh /usr/local/bin/start-desktop.sh
COPY docker/desktop/xfce4-desktop.xml /etc/xdg/xfce4/xfconf/xfce-perchannel-xml/xfce4-desktop.xml
RUN chmod 0755 /usr/local/bin/start-desktop.sh \
    && mkdir -p /root/.config/xfce4/xfconf/xfce-perchannel-xml \
    && cp /etc/xdg/xfce4/xfconf/xfce-perchannel-xml/xfce4-desktop.xml \
          /root/.config/xfce4/xfconf/xfce-perchannel-xml/xfce4-desktop.xml

# Stage 5: published desktop image (E2B / future Docker desktop).
FROM desktop-runtime AS desktop
EXPOSE 6080

# Stage 6: desktop + Cube envd. Same platforms and envd check as cube.
FROM desktop-runtime AS desktop-cube

USER root
COPY --from=cube-base /usr/bin/envd /usr/bin/envd
COPY --from=cube-base /usr/local/bin/cube-entrypoint.sh /usr/local/bin/cube-entrypoint.sh
RUN arch="$(dpkg --print-architecture)"; \
    case "$arch" in amd64) elf=x86-64 ;; arm64) elf=aarch64 ;; *) elf="$arch" ;; esac; \
    if ! file -bL /usr/bin/envd | grep -q "$elf"; then \
        echo "envd is$(file -bL /usr/bin/envd | cut -d, -f2) but rootfs is $arch" >&2; \
        exit 1; \
    fi

# cube-entrypoint.sh redirects envd to /var/log/envd.log. Cube packs this
# ~1.5GiB image into a 1.5GiB ext4 with no spare blocks; mkdir/write of that
# log fails under `set -eu`, envd never binds 49983, and the template probe
# is connection refused. envd as PID 1 (stdio) succeeds on the same rootfs.
# "-" is the entrypoint's documented "inherit container stdio" value.
ENV ENVD_LOG_FILE=-

EXPOSE 49983 6080
ENTRYPOINT ["/usr/local/bin/cube-entrypoint.sh"]

# Stage 7: default target
#
# Docker builds the last stage when none is named, and that must stay the plain
# runtime: a bare `docker build -f docker/Dockerfile.sandbox .` is expected to
# produce the image the Docker backend runs, not a Cube or desktop variant.
FROM runtime AS sandbox