Docker

orbitdocs deploy --target docker builds the site and writes a Dockerfile and an nginx.conf that serve it. You get an image that runs anywhere containers run: Kubernetes, ECS, Fly.io, Cloud Run or a single VM.

Build the imageCopy Anchor Link

npx orbitdocs deploy --target docker

node_modules
.next

docker build -t acme-docs docs
docker run -p 8080:80 acme-docs

What gets writtenCopy Anchor Link

FROM nginx:1.29-alpine
COPY nginx.conf /etc/nginx/conf.d/default.conf
COPY out/ /usr/share/nginx/html/
EXPOSE 80

server {
  listen 80;
  root /usr/share/nginx/html;
  location / {
    try_files $uri $uri/ $uri.html =404;
  }
  error_page 404 /404.html;
}

With output.basePath: '/docs', the location becomes /docs with an alias to the same folder, and the error page becomes /docs/404.html.

Rebuild on every releaseCopy Anchor Link

The image copies out/, so rebuild the site before each image build:

cd docs
npx orbitdocs deploy --target docker   # rebuilds out/
docker build -t registry.acme.com/acme-docs:1.4.0 .
docker push registry.acme.com/acme-docs:1.4.0

--skip-build reuses the current out/ when you only changed the image.

LimitsCopy Anchor Link

• Static only. The command needs output.mode: 'static'. For a container that runs private docs or Ask AI, see Run it in a container on the server mode page.
• No private docs, no Ask AI. nginx serves every file to everyone. The build warns when the config has access.
• Redirects without * work (they are HTML pages). nginx ignores _redirects, so add rewrite rules to nginx.conf for wildcard redirects.

Next stepsCopy Anchor Link