Merge pull request #19 from Cruzadera/develop

Closed #15
Closed #16

Author: Cruzadera

.dockerignore

@@ -0,0 +1,9 @@
+node_modules
+data
+.env
+npm-debug.log
+Dockerfile
+docker-compose.yml
+.git
+test
+README.md

.env.example

@@ -0,0 +1,11 @@
+PORT=8085
+# Cache TTL in seconds (default 86400 = 1 day)
+CACHE_TTL=86400
+JELLYFIN_URL=YOUR_JELLYFIN_URL
+JELLYFIN_API_KEY=YOUR_JELLYFIN_API_KEY
+# Optional: set a custom Puppeteer executable path if you provide system Chromium
+#PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium
+
+# Debug: set to true to persist debug screenshots inside the container `data/` folder
+# Useful for troubleshooting but should remain false in normal operation.
+DEBUG_SCREENSHOTS=false

.github/workflows/publish-ghcr.yml

@@ -0,0 +1,54 @@
+name: Publish Docker image to GHCR
+
+on:
+  push:
+    branches: ["main"]
+    tags:
+      - 'v*'
+  workflow_dispatch: {}
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  build-and-push:
+    name: Build and publish image
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Login to GHCR
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Determine image name and tags
+        id: meta
+        run: |
+          IMAGE="ghcr.io/${{ github.repository_owner }}/filmaffinity-scores"
+          TAGS="${IMAGE}:latest ${IMAGE}:${{ github.sha }}"
+          if [[ "${GITHUB_REF}" == refs/tags/* ]]; then
+            TAG_NAME=${GITHUB_REF#refs/tags/}
+            TAGS="${TAGS} ${IMAGE}:${TAG_NAME}"
+          fi
+          echo "image=${IMAGE}" >> $GITHUB_OUTPUT
+          echo "tags=${TAGS}" >> $GITHUB_OUTPUT
+
+      - name: Build and push
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          push: true
+          platforms: linux/amd64,linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}

DOCKER.md

@@ -0,0 +1,39 @@
+# Docker usage
+
+Requirements: Docker and Docker Compose installed.
+
+How to build the image
+
+```bash
+docker build -t filmaffinity-scores .
+```
+
+How to run with docker-compose
+
+1. Copy `.env.example` to `.env` and edit values if needed.
+2. Start the app:
+
+```bash
+docker compose up --build
+```
+
+This mounts the local `data/` folder into the container to persist cache between runs.
+
+Environment variables reference
+
+- `PORT` : port in container and host mapping (default `8085`).
+- `CACHE_TTL` : cache TTL seconds (default `86400`).
+- `JELLYFIN_URL`: your jellyfin url.
+- `JELLYFIN_API_KEY`: your jellyfin api key.
+- `PUPPETEER_EXECUTABLE_PATH` : optional — set only if you want to use a system-installed Chromium.
+- `DEBUG_SCREENSHOTS` : set to `true` to persist debug screenshots under the `data/` folder inside the container (disabled by default).
+
+Notes on Puppeteer
+
+- The image installs runtime libraries required by Chromium; Puppeteer will download a compatible Chromium during `npm install` inside the image.
+- If you encounter Chromium sandbox issues, try launching Puppeteer with `--no-sandbox --disable-setuid-sandbox` flags or set `PUPPETEER_EXECUTABLE_PATH` to a system Chromium binary.
+
+Validation
+
+- The compose service exposes the app on `http://localhost:PORT`.
+- Data is persisted in `./data/ratings.json`.

Dockerfile

@@ -1,17 +1,44 @@
-FROM node:20-alpine
-RUN apk add --no-cache \
-    chromium \
-    nss \
-    freetype \
-    harfbuzz \
-    ca-certificates \
-    ttf-freefont
+FROM node:20-slim
+
+# Install dependencies required by Chromium / Puppeteer
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends \
+        ca-certificates \
+        fonts-liberation \
+        libappindicator3-1 \
+        libasound2 \
+        libatk-bridge2.0-0 \
+        libatk1.0-0 \
+        libcups2 \
+        libdbus-1-3 \
+        libdrm2 \
+        libgbm1 \
+        libgdk-pixbuf2.0-0 \
+        libgtk-3-0 \
+        libnspr4 \
+        libnss3 \
+        libx11-xcb1 \
+        libxcomposite1 \
+        libxdamage1 \
+        libxrandr2 \
+        libxss1 \
+        lsb-release \
+        xdg-utils \
+        wget \
+    && rm -rf /var/lib/apt/lists/*
 
-ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
-ENV PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium-browser
 WORKDIR /app
+
+# Copy package files first for install caching
 COPY package*.json ./
-RUN npm install --omit=dev
+
+# Let Puppeteer download Chromium (bundled) and install only production deps
+ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=false
+ENV NODE_ENV=production
+RUN npm ci --only=production
+
+# Copy source
 COPY . .
+
 EXPOSE 8085
 CMD ["npm", "start"]

README.md

@@ -41,7 +41,7 @@ npm start
 The API will be available at:
 
 ```bash
-http://localhost:3000
+http://localhost:8085
 ```
 
 ---
@@ -83,9 +83,19 @@ curl "http://localhost:3000/movie?title=Inception&year=2010"
 
 ---
 
-## 🐳 Docker (coming soon)
+## 🐳 Docker
 
-Docker support is planned to simplify deployment in home server environments.
+See [DOCKER.md](DOCKER.md) for build and run instructions using Docker and Docker Compose.
+
+**Published image**
+
+Official images are published to GitHub Container Registry at `ghcr.io/Cruzadera/filmaffinity-scores` by CI. To pull:
+
+```bash
+docker pull ghcr.io/Cruzadera/filmaffinity-scores:latest
+```
+
+Replace `Cruzadera` with the GitHub user or organization that hosts the repository.
 
 ---
 

docker-compose.yml

@@ -0,0 +1,14 @@
+version: "3.8"
+
+services:
+  app:
+    build:
+      context: .
+    env_file:
+      - .env
+    ports:
+      - "${PORT:-8085}:8085"
+    volumes:
+      - ./data:/app/data
+    restart: unless-stopped
+    shm_size: '1gb'