Merge pull request #156 from raetha/main

Added support for docker and GHCR container building

Author: mrrfv

.env.example

@@ -15,3 +15,9 @@ BLOCK_BASED_ON_SNI=0
 
 # Optional Discord webhook URL to send a message to when a script is done running or if an error occurs.
 # DISCORD_WEBHOOK_URL=
+
+# Optional settings for the Docker container example (see docker-compose.yml.example)
+# TZ=UTC
+# CONTAINER_NAME=cgps
+# IMAGE_TAG=latest
+# CRON_SCHEDULE=0 3 * * 1

.github/workflows/build.yml

@@ -0,0 +1,67 @@
+name: Publish to container registry
+
+on:
+  push:
+    branches:
+      - v*
+  release:
+    types: [ "published" ]
+
+env:
+  # Use docker.io for Docker Hub if empty
+  REGISTRY: ghcr.io
+  # github.repository as <account>/<repo>
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Get Node Version
+        run: echo "NODE_VERSION=$(cat .node-version)" >> $GITHUB_ENV
+
+      # Login against a Docker registry except on PR
+      # https://github.com/docker/login-action
+      - name: Log into registry ${{ env.REGISTRY }}
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # 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@v3
+
+      # Extract metadata (tags, labels) for Docker
+      # https://github.com/docker/metadata-action
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        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@v6
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64
+          push: true
+          build-args: |
+            NODE_VERSION=${{ env.NODE_VERSION }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

Dockerfile

@@ -0,0 +1,14 @@
+ARG NODE_VERSION=lts
+
+FROM docker.io/node:${NODE_VERSION}-alpine
+
+WORKDIR /app
+
+# Add project source to image
+ADD . /app
+
+# Install project dependencies and set permissions
+RUN apk add --no-cache tzdata && npm ci && chmod +x /app/docker-entrypoint.sh
+
+# Run the entrypoint script on container startup
+ENTRYPOINT ["/app/docker-entrypoint.sh"]

docker-compose.yml.example

@@ -0,0 +1,21 @@
+services:
+  cgps:
+    container_name: ${CONTAINER_NAME:-cgps}
+    hostname: ${CONTAINER_NAME:-cgps}
+    image: ghcr.io/mrrfv/cloudflare-gateway-pihole-scripts:${IMAGE_TAG:-latest}
+    restart: unless-stopped
+    network_mode: bridge
+    #tty:true # Only needed if you want crond logs in the docker log (noisy)
+    environment:
+      TZ: "${TZ:-UTC}"
+      CRON_SCHEDULE: "${CRON_SCHEDULE:-0 3 * * 1}"
+      CLOUDFLARE_API_TOKEN: "${CLOUDFLARE_API_TOKEN}"
+      CLOUDFLARE_ACCOUNT_ID: "${CLOUDFLARE_ACCOUNT_ID}"
+      CLOUDFLARE_LIST_ITEM_LIMIT: "${CLOUDFLARE_LIST_ITEM_LIMIT:-300000}"
+      DRY_RUN: "${DRY_RUN:-0}"
+      BLOCK_PAGE_ENABLED: "${BLOCK_PAGE_ENABLED:-0}"
+      BLOCK_BASED_ON_SNI: "${BLOCK_BASED_ON_SNI:-0}"
+      ALLOWLIST_URLS: "${ALLOWLIST_URLS}"
+      BLOCKLIST_URLS: "${BLOCKLIST_URLS}"
+      #PING_URL: "${PING_URL}"
+      #DISCORD_WEBHOOK_URL: "${DISCORD_WEBHOOK_URL}"

docker-entrypoint.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+# Add cron entry
+echo "$CRON_SCHEDULE /usr/local/bin/npm start --prefix /app/" | crontab -
+
+# Start crond
+echo "Starting crond..."
+/usr/sbin/crond -l 2 -f