slide.ng docker

A Docker image that runs slide.ng decks: live dev server, static build, PDF/PNG/PPTX export, and a small static server. It follows the idea of Slidev's container repository, with fewer moving parts: one Dockerfile, one entrypoint.sh, one static server (serve.mjs).

Status

Check	Result
shellcheck on entrypoint.sh and the test	passed
hadolint on Dockerfile	passed (one rule off, see .hadolint.yaml)
bash tests/entrypoint.test.sh (fake slide-ng, real serve.mjs)	59 passed
entrypoint.sh against the real slide.ng core, outside Docker (build --base /talk/, serve --dist, export --format pdf, dev)	worked
docker compose config	parses
Image build and serve	passed on Docker Desktop 29.8.2 for Mac (2026-10-16)
Base image tag exists; Debian chromium, fonts-*, tini install; Chromium starts inside the container	passed (2026-10-16)
Export from inside the container with --shm-size=1g and the deck mounted :ro	passed (PDF written). --cap-drop ALL, --read-only and dev mode are NOT VERIFIED. On Docker Desktop for Mac a deck mounted read-write fails, so mount it :ro
GitHub Actions workflow runs	NOT VERIFIED (YAML parses only)

The commands marked NOT VERIFIED above are untested.

Build the image

By default the image installs @slide-ng/core@0.1.0 from npm (a pinned release, so builds are reproducible). The build argument SLIDE_NG_SOURCE picks another version (anything npm install accepts, such as @slide-ng/core@latest) or a tarball inside the build context, for example one packed from a slide.ng checkout:

docker build -t slide-ng .
docker build --build-arg SLIDE_NG_SOURCE=@slide-ng/core@latest -t slide-ng .
npm pack /path/to/slide.ng --pack-destination packages
docker build --build-arg SLIDE_NG_SOURCE=packages/slide-ng-core-0.1.0.tgz -t slide-ng .

Other build arguments: NODE_VERSION (default 22.23.3; slide.ng needs 22.22.3 or newer) and EXTRA_FONTS (extra Debian font packages, for example fonts-noto-cjk).

Run

docker run [options] slide-ng <mode> [flags]. Flags after the mode go to slide.ng unchanged. The deck is /slides/slides.md (another name: SLIDES_FILE=my.md). Modes: dev (default, port 4230), build, export, export-notes, serve and watch (port 8080), help. Any other first word is run as a command. Run help for the variables; docker-compose.yml has one profile per mode (copy .env.example to .env).

# dev: live server, password protected (random one in the log if you set none), no HTTPS
docker run --rm -it -p 127.0.0.1:4230:4230 -e SLIDES_PASSWORD='a-long-password' -v "$PWD:/slides" slide-ng dev

# build: static site into ./out (create it first)
docker run --rm --user "$(id -u):$(id -g)" -v "$PWD:/slides" -v "$PWD/out:/out" slide-ng build --base /talk/ --download

# export: pdf, png, pptx or md into ./out
docker run --rm --user "$(id -u):$(id -g)" --shm-size=1g -v "$PWD:/slides" -v "$PWD/out:/out" slide-ng export --format pdf

# serve: build, then serve; watch also rebuilds on change
docker run --rm -p 127.0.0.1:8080:8080 -v "$PWD:/slides" slide-ng serve
docker run --rm -p 127.0.0.1:8080:8080 -v "$PWD:/slides" slide-ng watch

• dev saves edits into /slides, so it cannot be mounted :ro. Open the "private slide show" address it prints and use localhost or an IP address as the host.
• serve --dist /site serves a folder you built earlier. serve.mjs has no compression and no TLS; for a public site put the build output behind a real web server.
• The container runs as node (uid 1000). On Linux pass --user "$(id -u):$(id -g)" and create out yourself, or it belongs to root. Docker Desktop maps ownership for you.

Chromium and the sandbox

The image sets SLIDE_NG_NO_SANDBOX=1, so slide.ng starts Chromium with --no-sandbox (a normal container cannot run Chromium's own sandbox). No --privileged, SYS_ADMIN or custom seccomp profile is needed. The image runs as a non-root user, and the compose file drops all capabilities and sets no-new-privileges.

• Use --shm-size=1g for export. Docker's default 64 MB makes Chromium crash on big slides.
• Export only decks you trust. Add fonts with EXTRA_FONTS; a missing font silently falls back.

Development

bash tests/entrypoint.test.sh      # no Docker needed; needs bash, node 22, curl

The tests use a fake slide-ng, so they cannot catch problems inside the image. See CONTRIBUTING.md.

Contributing

Read CONTRIBUTING.md. Changes follow the Code of Conduct; security reports go through SECURITY.md. Changes are listed in CHANGELOG.md.

License

MIT License © 2026 Erkam Yaman (LICENSE).

Credits and disclaimer

The idea comes from slidevjs/container (MIT) for Slidev. No code from those projects is copied here.

slide.ng is an independent open-source project. It is not affiliated with or endorsed by the Angular team or Google, or by Slidev. Angular is a trademark of Google LLC.

Related repositories: slide.ng, themes, starter, docs, vscode. These addresses are placeholders until the repositories are published.

Maintainers

Erkam Yaman Maintainer

Contributors

Thanks to everyone who has helped. This project follows the all-contributors specification. Contributions of any kind welcome!

Erkam Yaman 💻 📖 🚇 🚧

Sponsors

The slide.ng Docker image is free and open source. If it helps your work, please consider sponsoring it. Your support keeps development going.