🐳 🆕 add Dockerfile.docs and update docker-compose

marcellodesales · marcellodesales · commit d65f7f0da7d6 · 2025-01-02T21:12:07.000-08:00
Since the docs dependend on the files from packages, we have to include the Dockerfile.docs in the root directory because of the build context. Adding a new docker-compose-docs.yaml to always build the docs from the file directly. Just adding a new service for the docs: $ docker compose up --build [+] Building 55.5s (20/20) FINISHED docker:desktop-linux => [docs internal] load build definition from Dockerfile.docs 0.0s => => transferring dockerfile: 1.88kB 0.0s => [docs] resolve image config for docker.io/docker/dockerfile:1 1.7s => CACHED [docs] docker-image://docker.io/docker/dockerfile:1@sha256:93bfd3b68c109427185cd78b4779fc82b484b0b7618e36d0f104d4d801e66d25 0.0s => [docs internal] load build definition from Dockerfile.docs 0.0s => [docs internal] load metadata for docker.io/library/node:23.3.0-slim 1.3s => [docs internal] load .dockerignore 0.0s => => transferring context: 2B 0.0s => [docs base 1/4] FROM docker.io/library/node:23.3.0-slim@sha256:8b30809f66a6ea8896b9a5d004b4fe2cc0e8061d981d3784fb0e80a19b86ab9d 0.0s => [docs internal] load build context 0.1s => => transferring context: 409.46kB 0.1s => CACHED [docs base 2/4] RUN corepack enable 0.0s => CACHED [docs base 3/4] WORKDIR /opt/docusaurus 0.0s => CACHED [docs base 4/4] RUN apt-get update && apt-get install -y git 0.0s => CACHED [docs prod 1/8] WORKDIR /opt/docusaurus 0.0s => CACHED [docs prod 2/8] COPY docs/package.json /opt/docusaurus/package.json 0.0s => CACHED [docs prod 3/8] COPY docs/package-lock.json /opt/docusaurus/package-lock.json 0.0s => CACHED [docs prod 4/8] RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install 0.0s => CACHED [docs prod 5/8] COPY docs/ /opt/docusaurus/ 0.0s => CACHED [docs prod 6/8] COPY packages/ /opt/packages/ 0.0s => [docs prod 7/8] COPY .git/ /opt/.git/ 0.1s => [docs prod 8/8] RUN pnpm run build 51.4s => [docs] exporting to image 0.8s => => exporting layers 0.8s => => writing image sha256:0a580f2889191121880df85b8951563386f838f7e5f8723dec750ce292334498 0.0s => => naming to docker.io/library/eliza-docs 0.0s [+] Running 1/0 ✔ Container eliza-docs-1 Recreated 0.0s Attaching to docs-1 docs-1 | (node:1) ExperimentalWarning: CommonJS module /usr/local/lib/node_modules/npm/node_modules/debug/src/node.js is loading ES Module /usr/local/lib/node_modules/npm/node_modules/supports-color/index.js using require(). docs-1 | Support for loading ES Module in require() is an experimental feature and might change at any time docs-1 | (Use `node --trace-warnings ...` to show where the warning was created) docs-1 | docs-1 | > eliza-docs@0.1.7-alpha.2 serve docs-1 | > docusaurus serve --host 0.0.0.0 --no-open docs-1 | docs-1 | [SUCCESS] Serving "build" directory at: http://0.0.0.0:3000/eliza/
diff --git a/Dockerfile.docs b/Dockerfile.docs
@@ -0,0 +1,58 @@
+# syntax=docker/dockerfile:1
+
+## Modified version of https://docusaurus.community/knowledge/deployment/docker/
+
+# Stage 1: Base image.
+## Start with a base image containing NodeJS so we can build Docusaurus.
+FROM node:23.3.0-slim AS base
+## Disable colour output from yarn to make logs easier to read.
+
+## https://pnpm.io/docker
+ENV PNPM_HOME="/pnpm"
+ENV PATH="$PNPM_HOME:$PATH"
+
+ENV FORCE_COLOR=0
+## Enable corepack.
+RUN corepack enable
+## Set the working directory to `/opt/docusaurus`.
+WORKDIR /opt/docusaurus
+
+## Required by docusaurus: [ERROR] Loading of version failed for version current
+RUN apt-get update && apt-get install -y git 
+
+FROM base AS dev
+## Set the working directory to `/opt/docusaurus`.
+WORKDIR /opt/docusaurus
+## Expose the port that Docusaurus will run on.
+EXPOSE 3000
+## Run the development server.
+CMD [ -d "node_modules" ] && npm run start -- --host 0.0.0.0 --poll 1000 || pnpm install && pnpm run start -- --host 0.0.0.0 --poll 1000
+
+# Stage 2b: Production build mode.
+FROM base AS prod
+## Set the working directory to `/opt/docusaurus`.
+WORKDIR /opt/docusaurus
+
+COPY docs/package.json /opt/docusaurus/package.json
+COPY docs/package-lock.json /opt/docusaurus/package-lock.json
+
+## Install dependencies with `--immutable` to ensure reproducibility.
+RUN --mount=type=cache,id=pnpm,target=/pnpm/store pnpm install 
+
+## Copy over the source code.
+COPY docs/ /opt/docusaurus/
+COPY packages/ /opt/packages/
+
+## Required buy docusaurus [ERROR] Loading of version failed for version current
+COPY .git/ /opt/.git/
+
+# Build from sources
+RUN pnpm run build
+
+# Stage 3a: Serve with `docusaurus serve`.
+FROM prod AS serve
+## Expose the port that Docusaurus will run on.
+EXPOSE 3000
+## Run the production server.
+CMD ["npm", "run", "serve", "--", "--host", "0.0.0.0", "--no-open"]
+
diff --git a/docker-compose-docs.yaml b/docker-compose-docs.yaml
@@ -0,0 +1,9 @@
+services:
+    docs:
+        build:
+            dockerfile: Dockerfile.docs
+            context: .
+            target: serve
+        ports:
+            - 3000:3000
+
