Merge pull request #1703 from dodona-edu/fix/docker-web

Author: rien

.dockerignore

@@ -0,0 +1,4 @@
+*.tsbuildinfo
+dist/
+node_modules/
+*.iml

.github/workflows/ci-cd.yml

@@ -743,8 +743,8 @@ jobs:
 
       - name: Build the Dolos images
         run: |
-          docker build docker/ -t ghcr.io/dodona-edu/dolos-cli:${{ steps.parse_tag.outputs.version }}
-          docker build web/ -t ghcr.io/dodona-edu/dolos-web:${{ steps.parse_tag.outputs.version }}
+          docker build . -f Dockerfile.cli -t ghcr.io/dodona-edu/dolos-cli:${{ steps.parse_tag.outputs.version }}
+          docker build . -f Dockerfile.web -t ghcr.io/dodona-edu/dolos-web:${{ steps.parse_tag.outputs.version }}
           docker build api/ -t ghcr.io/dodona-edu/dolos-api:${{ steps.parse_tag.outputs.version }}
 
       - name: Login to the container registry

.github/workflows/validation.yml

@@ -15,13 +15,15 @@ jobs:
         uses: actions/checkout@v4
         with:
           submodules: true
+
       - name: Setup Nix 📚
         uses: cachix/install-nix-action@v30
         with:
           github_access_token: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Build & check 🧪
         run: nix build -L '.?submodules=1#checks.x86_64-linux.dolos-cli'
-        
+
   install-cli:
     name: "Install and run CLI on ${{ matrix.os }}"
     strategy:
@@ -93,17 +95,17 @@ jobs:
 
       - name: Build WEB container
         run: |
-          cd web
-          docker build .
+          docker build . -f Dockerfile.web
 
   docker-cli:
     name: "Build dolos-cli docker container"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
         uses: actions/checkout@v4
+        with:
+          submodules: true
 
-      - name: Build WEB container
+      - name: Build CLI container
         run: |
-          cd web
-          docker build .
+          docker build . -f Dockerfile.cli

Dockerfile.cli

@@ -0,0 +1,37 @@
+FROM node:22.17.1-alpine3.22
+
+WORKDIR /repo/
+
+RUN apk add --no-cache curl python3 build-base
+
+ADD package-lock.json package.json tsconfig.global.json /repo/
+
+ADD core/ /repo/core
+
+ADD parsers/ /repo/parsers
+
+ADD lib/package.json lib/tsconfig.json lib/
+ADD lib/src /repo/lib/src
+
+ADD web/index.d.ts web/index.js web/index.html web/package.json web/tsconfig.json web/vite.config.ts web/tsconfig.node.json /repo/web/
+ADD web/src /repo/web/src
+ADD web/public /repo/web/public
+
+ADD cli/tsconfig.json cli/package.json /repo/cli/
+ADD cli/src /repo/cli/src
+ADD cli/typings /repo/cli/typings
+
+RUN npm install
+
+RUN apk del --no-cache python3 build-base
+
+
+RUN npm run --workspace core build
+RUN npm run --workspace web build
+RUN npm run --workspace cli build
+RUN npm --workspace cli link
+
+WORKDIR /dolos
+USER node
+EXPOSE 3000/tcp
+ENTRYPOINT [ "dolos" ]

Dockerfile.web

@@ -0,0 +1,30 @@
+FROM node:22.17.1-alpine3.22
+
+WORKDIR /repo/
+
+RUN apk add --no-cache curl
+
+ADD package-lock.json package.json tsconfig.global.json /repo/
+ADD core/ /repo/core
+
+ADD web/index.d.ts web/index.js web/index.html web/package.json web/tsconfig.json web/vite.config.ts web/tsconfig.node.json /repo/web/
+ADD web/src /repo/web/src
+ADD web/public /repo/web/public
+
+RUN npm install
+RUN npm run build --workspace core
+
+ENV VITE_HOST=0.0.0.0
+ENV VITE_PORT=8080
+ENV VITE_MODE=server
+ENV DEFAULT_VITE_API_URL=http://localhost:3000
+EXPOSE 8080/tcp
+
+WORKDIR /repo/web
+
+RUN VITE_API_URL="$DEFAULT_VITE_API_URL" npm run build
+
+
+SHELL ["/bin/sh", "-c"]
+
+CMD (test "$VITE_API_URL" == "$DEFAULT_VITE_API_URL" || npm run build) && npm run preview -- --host "$VITE_HOST" --port "$VITE_PORT" --strictPort

README.md

@@ -90,6 +90,26 @@ This allows you to simultaneously develop the CLI, lib and the web project toget
 
 Each component has its own build instructions in its own directory.
 
+## Local installation using Docker
+
+The latest Dolos version comes pre-installed in a Docker container image that is available from GitHub's container registry. Use the following command to pull the image:
+
+```shell
+docker pull ghcr.io/dodona-edu/dolos-cli:latest
+```
+
+Next, you can run an analysis with Dolos and start a web server to view the results using the following docker command:
+
+```shell
+docker run --init --network host -v "$PWD:/dolos" dodona/dolos -l javascript -f web *.js
+```
+
+The arguments passed to docker serve the following purpose:
+- `--init` will make sure stopping the container with Control-C works
+- `--network host` allows Dolos's webserver to bind to <http://localhost:3000>
+- `-v "$PWD:/dolos"` gives Dolos acces to your current directory
+
+
 ## Components
 
 - [CLI](https://github.com/dodona-edu/dolos/tree/main/cli): the command-line interface

docker-compose.yml

@@ -19,7 +19,9 @@ services:
 
   web:
     image: ghcr.io/dodona-edu/dolos-web
-    # build: ./web/
+    #build:
+    #  dockerfile: ./Dockerfile.web
+    #  context: .
     ports:
       # This renders to "host:port:8080", so traffic from the provided hosts on the specified
       # port is available to port 8080 inside the container. By default, this will be

docker/Dockerfile

@@ -80,4 +80,4 @@ You can change the following environment variables to alter how the UI works:
 - `VITE_API_URL` (default: http://localhost:3000) points to the Dolos API url
 - `VITE_MODE` changes the mode (`server` or empty)
 
-Note that `VITE_HOST` and `VITE_PORT` can be used to change where the [Docker container](./Dockerfile) will be hosted.
+Note that `VITE_HOST` and `VITE_PORT` can be used to change where the [Docker container](../Dockerfile.web) will be hosted.