Dockerize

.dockerignore

@@ -0,0 +1 @@
+node_modules

.github/workflows/ci.yaml

@@ -11,7 +11,7 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: install
         run: yarn install
       - name: format

.github/workflows/docker.yaml

@@ -0,0 +1,47 @@
+name: Create and publish Docker image
+
+on:
+  # release:
+  #   types: [published]
+  push:
+    branches:
+      - main
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+# https://docs.docker.com/build/ci/github-actions/multi-platform/
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          platforms: linux/amd64,linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/release.yaml

@@ -18,3 +18,4 @@ jobs:
       - run: yarn npm publish // for Yarn version 1, use `yarn publish` instead
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+

Dockerfile

@@ -0,0 +1,39 @@
+# syntax=docker/dockerfile:1.4
+FROM node:lts-slim AS development
+
+LABEL org.opencontainers.image.source=https://github.com/automerge/automerge-repo-sync-server
+LABEL org.opencontainers.image.description="A debugging/test instance of automerge-repo-sync-server"
+LABEL org.opencontainers.image.licenses=MIT
+
+# Create app directory
+WORKDIR /usr/src/app
+
+COPY package.json ./package.json
+RUN yarn install
+
+COPY . .
+
+EXPOSE 3030
+# NODE_ENV=dev DEBUG=* node ./src/index.js
+ENV NODE_ENV=dev
+ENV DEBUG=*
+CMD [ "node", "./src/index.js" ]
+
+FROM development as dev-envs
+RUN <<EOF
+apt-get update
+apt-get install -y --no-install-recommends git
+EOF
+
+RUN <<EOF
+useradd -s /bin/bash -m vscode
+groupadd docker
+usermod -aG docker vscode
+EOF
+
+HEALTHCHECK CMD curl --fail http://localhost:3030 || exit 1
+
+# install Docker tools (cli, buildx, compose)
+# COPY --from=gloursdocker/docker / /
+
+CMD [ "node", "./src/index.js" ]

README.md

@@ -17,6 +17,21 @@ The server is configured with environment variables. There are two options:
 - `PORT` - the port to listen for websocket connections on
 - `DATA_DIR` - the directory to store saved documents in
 
+## Running in Docker
+
+Run in docker using image hosted by GitHub container registry:
+
+```bash
+docker run -d --name syncserver -p 3030:3030 ghcr.io/automerge/automerge-repo-sync-server:main
+```
+
+cleanup after:
+
+```bash
+docker stop syncserver
+docker rm syncserver
+```
+
 ## Contributors
 
 Originally written by @pvh.