Add automatic docker build via Github Action

.github/workflows/docker-publish.yml

@@ -0,0 +1,60 @@
+name: Docker
+
+on:
+  push:
+    branches: ["main"]
+    tags: ["v*.*.*"]
+  pull_request:
+    branches: ["main"]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Set up BuildKit Docker container builder to be able to build
+      # multi-platform images and export cache
+      # https://github.com/docker/setup-buildx-action
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226 # v3.0.0
+
+      # Login against a Docker registry except on PR
+      # https://github.com/docker/login-action
+      - name: Log into registry ${{ env.REGISTRY }}
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # Extract metadata (tags, labels) for Docker
+      # https://github.com/docker/metadata-action
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 # v5.0.0
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      # Build and push Docker image with Buildx (don't push on PR)
+      # https://github.com/docker/build-push-action
+      - name: Build and push Docker image
+        id: build-and-push
+        uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # v5.0.0
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

README.md

@@ -17,13 +17,13 @@ The docker container uses the same environmental variable as described in the [o
 To start the Anki sync server in a Docker container:
 
 ```sh
-docker run -d --name anki-syncserver -p 8080:8080 -v /your/local/data:/data anki-syncserver
+docker run -d --name anki-syncserver -p 8080:8080 -v ./data:/data ghcr.io/lorenzschmid/anki-syncserver
 ```
 
 - `-d`: Runs the container in detached mode.
 - `--name`: Assigns a name to the container (`anki-syncserver`).
 - `-p 8080:8080`: Maps port `8080` on the host to port `8080` in the container.
-- `-v /your/local/data:/data`: Mounts the host directory `/your/local/data` to the container’s `/data` directory for data persistence.
+- `-v ./data:/data`: Mounts the host directory `./data` to the container’s `/data` directory for data persistence.
 
 or via docker compose:
 
@@ -32,7 +32,7 @@ version: '3.8'
 
 services:
   anki-syncserver:
-    image: anki-syncserver:latest
+    image: ghcr.io/lorenzschmid/anki-syncserver
     container_name: anki-syncserver
     environment:
       - SYNC_USER1=user:pass