First release

Author: jcatertychnyi

.github/workflows/docker-publis.yml

@@ -0,0 +1,66 @@
+#
+name: Create and publish a Docker image with tags
+
+# Configures this workflow to run every time a change is pushed and have tags
+on:
+  push:
+    tags:
+      - '*' 
+
+# Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+  #IMAGE_NAME:  ghcr.io/justcoded/plopjs
+
+# There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu.
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job.
+    permissions:
+      contents: read
+      packages: write
+      # 
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
+      - name: Log in to the Container registry
+        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels.
+
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+
+
+      - name: Set Versions
+        uses: actions/github-script@v4
+        id: set_version
+        with:
+          script: |
+            const tag = context.ref.substring(10)
+            const no_v = tag.replace('v', '')
+            const dash_index = no_v.lastIndexOf('-')
+            const no_dash = (dash_index > -1) ?  no_v.substring(0, dash_index) : no_v
+            core.setOutput('tag', tag)
+            core.setOutput('no-v', no_v)
+            core.setOutput('no-dash', no_dash)
+
+      - name: Build and Push
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          push: true
+          tags: |
+            ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
+            ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}::${{steps.set_version.outputs.no-dash}}

Dockerfile

@@ -0,0 +1,49 @@
+FROM node:20-bullseye-slim
+
+RUN apt-get update && apt-get install -y \
+    ca-certificates \
+    fonts-liberation \
+    libasound2 \
+    libatk-bridge2.0-0 \
+    libatk1.0-0 \
+    libc6 \
+    libcairo2 \
+    libcups2 \
+    libdbus-1-3 \
+    libexpat1 \
+    libfontconfig1 \
+    libgbm1 \
+    libgcc1 \
+    libglib2.0-0 \
+    libgtk-3-0 \
+    libnspr4 \
+    libnss3 \
+    libpango-1.0-0 \
+    libpangocairo-1.0-0 \
+    libstdc++6 \
+    libx11-6 \
+    libx11-xcb1 \
+    libxcb1 \
+    libxcomposite1 \
+    libxcursor1 \
+    libxdamage1 \
+    libxext6 \
+    libxfixes3 \
+    libxi6 \
+    libxrandr2 \
+    libxrender1 \
+    libxshmfence1 \
+    libxtst6 \
+    lsb-release \
+    wget \
+    xdg-utils \
+    chromium \
+    --no-install-recommends && rm -rf /var/lib/apt/lists/*
+
+
+WORKDIR /app
+RUN npm install prerender prerender-memory-cache
+
+COPY server.js .
+
+CMD ["node", "server.js"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 JustCoded
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,105 @@
+# Prerender Service (Dockerized)
+
+This project provides a **Dockerized prerender service** based on `prerender` with an in-memory cache. It is designed to render JavaScript-heavy pages (e.g., for SEO or bots) using headless Chromium.
+
+## 🚀 Features
+
+- Headless Chromium rendering
+- In-memory caching (`prerender-memory-cache`)
+- Configurable cache TTL and size
+- Lightweight Docker image (`node:20-bullseye-slim`)
+- Ready to use with Docker Compose
+
+
+## 📦 Project Structure
+
+├── Dockerfile
+
+├── server.js
+
+└── docker-compose.yml
+
+## ⚙️ Configuration
+
+### Environment Variables
+
+| Variable         | Default | Description                      |
+|------------------|--------|-----------------------------------|
+| `PORT`           | `3000` | Port the service listens on       |
+| `CACHE_MAXSIZE`  | `1000` | Maximum number of cached entries  |
+| `CACHE_TTL`      | `86400`| Cache lifetime in seconds (1 day) |
+
+---
+
+## 🐳 Docker
+
+### Build Image
+
+```bash
+docker build -t prerender-service .
+```
+or check our repository
+
+```
+path to docker image*****
+```
+
+
+## 🧩 Docker Compose
+
+Example docker-compose.yml:
+
+```
+services:
+  webapp-prerender:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    ports:
+      - "3000:3000"
+    shm_size: 512mb
+    restart: unless-stopped
+    environment:
+      - PORT=3000
+```
+
+or
+
+```
+services:
+  image: prerender-image:latest
+    ports:
+      - "3000:3000"
+    shm_size: 512mb
+    restart: unless-stopped
+    environment:
+      - PORT=3000
+```
+
+
+Run:
+
+```bash
+docker-compose up -d
+```
+
+### 🧠 How It Works
+The service runs a prerender server using headless Chromium.
+Incoming requests are rendered as fully loaded HTML pages.
+Responses are cached in memory using prerender-memory-cache.
+Cache settings are controlled via environment variables.
+
+### 🔧 Chromium Notes
+Uses system-installed Chromium (/usr/bin/chromium)
+Required dependencies are installed in the Docker image
+--no-sandbox is enabled for compatibility inside containers
+
+### 📈 Use Cases
+SEO for SPA (React, Vue, Angular)
+Social media previews (Open Graph rendering)
+Rendering pages for bots/crawlers
+
+### 🛠 Tips
+Increase shm_size if Chromium crashes
+Tune CACHE_MAXSIZE based on memory limits
+Use a reverse proxy (e.g., Nginx) in production

docker-compose.example.yml

@@ -0,0 +1,12 @@
+services:
+
+  webapp-prerender:
+    ports:
+      - '3000:3000'
+    build: 
+      context: .
+      dockerfile: Dockerfile
+    restart: unless-stopped  
+    shm_size: 512mb
+    environment:
+      - PORT=3000

server.js

@@ -0,0 +1,14 @@
+const prerender = require('prerender');
+process.env.CACHE_MAXSIZE = process.env.CACHE_MAXSIZE || 1000;
+process.env.CACHE_TTL = process.env.CACHE_TTL || 86400;
+
+const server = prerender({
+    chromeLocation: '/usr/bin/chromium',
+    chromeFlags: ['--no-sandbox', '--headless', '--disable-gpu', '--remote-debugging-port=9222', '--hide-scrollbars']
+});
+
+server.use(require('prerender-memory-cache'))
+
+console.log(`Prerender start`);
+
+server.start();