diff --git a/.github/workflows/build-publish.yaml b/.github/workflows/build-publish.yaml index 59c7338..5df5355 100644 --- a/.github/workflows/build-publish.yaml +++ b/.github/workflows/build-publish.yaml @@ -16,13 +16,13 @@ jobs: steps: - name: Checkout - uses: actions/checkout@v4 + uses: actions/checkout@v6 - name: Enable corepack run: corepack enable - name: Set up Node.js - uses: actions/setup-node@v4 + uses: actions/setup-node@v5 with: node-version: 24 cache: pnpm @@ -43,17 +43,17 @@ jobs: steps: - name: Checkout - uses: actions/checkout@v4 + uses: actions/checkout@v6 - name: Set up QEMU - uses: docker/setup-qemu-action@v3 + uses: docker/setup-qemu-action@v4 - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v3 + uses: docker/setup-buildx-action@v4 - name: Login to DockerHub if: github.event_name == 'push' - uses: docker/login-action@v3 + uses: docker/login-action@v4 with: username: ${{ secrets.DOCKERHUB_USERNAME }} password: ${{ secrets.DOCKERHUB_TOKEN }} @@ -73,7 +73,7 @@ jobs: release - name: Build & push container image - uses: docker/build-push-action@v6 + uses: docker/build-push-action@v7 with: context: . platforms: linux/amd64,linux/arm64 diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 170df58..0e4b4dd 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -22,11 +22,11 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v4 + uses: actions/checkout@v6 # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL - uses: github/codeql-action/init@v3 + uses: github/codeql-action/init@v4 # Override language selection by uncommenting this and choosing your languages # with: # languages: go, javascript, csharp, python, cpp, java, ruby @@ -34,7 +34,7 @@ jobs: # Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java). # If this step fails, then you should remove it and run the build manually (see below). - name: Autobuild - uses: github/codeql-action/autobuild@v3 + uses: github/codeql-action/autobuild@v4 # â„šī¸ Command-line programs to run using the OS shell. # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun @@ -48,4 +48,4 @@ jobs: # make release - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v3 + uses: github/codeql-action/analyze@v4 diff --git a/README.md b/README.md index e2d78e4..1eb0596 100644 --- a/README.md +++ b/README.md @@ -158,6 +158,8 @@ docker run --rm -p 3000:3000 readability-js The image is based on `node:24-alpine`, installs production dependencies only, and runs the service as a non-root user. +For Docker Compose setup, see [`examples/compose.yaml`](examples/compose.yaml). + ## Security posture - Only absolute `http:` and `https:` URLs are accepted. diff --git a/examples/compose.yaml b/examples/compose.yaml new file mode 100644 index 0000000..7b9a52d --- /dev/null +++ b/examples/compose.yaml @@ -0,0 +1,15 @@ +services: + readability-js-server: + image: phpdockerio/readability-js-server:latest + ports: + - "3000:3000" + # Uncomment and set any of the following environment variables to override defaults: + # environment: + # PORT: 3000 + # REQUEST_BODY_LIMIT: 16kb + # FETCH_TIMEOUT_MS: 10000 + # FETCH_MAX_BYTES: 5242880 + # FETCH_MAX_REDIRECTS: 5 + # BLOCK_PRIVATE_NETWORKS: "true" + # READABILITY_MAX_ELEMS: "" + # MAX_CONCURRENT_REQUESTS: 10