feat: add support for using env vars, add a few more configs, build docker image #44

anshuman852 · 2025-08-12T03:29:28Z

This pull request introduces Docker support for the project, enabling easy deployment using Docker and Docker Compose, and improves the release automation workflow. It adds a production-ready Dockerfile, a sample docker-compose.yml, and a comprehensive GitHub Actions workflow for building, testing, and publishing multi-platform Docker images and releases. Additionally, it updates documentation and configuration to reflect these new capabilities.

Docker Support and Deployment

Added a production-ready multi-stage Dockerfile that builds the frontend and serves it using nginx:alpine, with runtime configuration via environment variables and included setup scripts.
Introduced a sample docker-compose.yml for local or production deployment, supporting environment-based configuration and health checks.
Updated .dockerignore to exclude unnecessary files from Docker build context, improving build efficiency and security.

Release Automation and CI/CD

Replaced the old release workflow with a new GitHub Actions workflow (docker.yml) that builds, tests, and publishes multi-platform Docker images, generates changelogs, and creates GitHub Releases with attached static build artifacts. [1] [2]

Documentation Updates

Expanded README.md to include Docker deployment instructions, environment variable configuration, and security features of the Docker image.
Updated configuration documentation to include new options for hiding URLs and the footer.

Changelog Generation Improvements

Enhanced changelog configuration to support more granular categories and conventional commit parsing for better release notes.

…play - Add hideUrls boolean option to Config type - Update Status component to conditionally hide URLs based on config - Pass config through StatusGroup to Status components - Add example config.json demonstrating hideUrls feature - Update README.md with documentation for new hideUrls parameter - Maintains backward compatibility (URLs shown by default)

- Create multi-stage Dockerfile with Node.js build and nginx serve stages - Add runtime configuration generation via environment variables - Include nginx setup script with SPA routing and API proxy support - Add docker-compose.yml with comprehensive environment variable examples - Create .dockerignore for optimized build context - Update README.md with Docker deployment documentation and environment variables Docker features: - Uses secure 11notes/nginx base (rootless, distroless, 3.69MB) - Runtime config generation from environment variables - Security headers and optimizations - Health checks and read-only filesystem - Optional API proxying to Gatus backend - Support for all config options including hideUrls via CONFIG_HIDE_URLS

…latform Docker images

…paths

… feedback

…angelog generation; remove obsolete release workflow

…o PRs are found

…d update Docker workflow configuration

…handling

BluemediaDev

Thank you very much for this PR. I commented on a couple of changes that I would like you to revise before I can merge this.

BluemediaDev · 2025-08-15T19:15:35Z

.github/workflows/docker.yml

+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'


Please use Node.js 22.x

BluemediaDev · 2025-08-15T19:15:53Z

.github/workflows/docker.yml

+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'


Please use Node.js 22.x

BluemediaDev · 2025-08-15T19:22:29Z

.github/workflows/docker.yml

+      - name: Generate commit-based changelog if no PRs found
+        id: commit_changelog
+        if: steps.changelog.outputs.changelog == '' || contains(steps.changelog.outputs.changelog, 'No pull requests found')
+        run: |
+          echo "changelog<<EOF" >> $GITHUB_OUTPUT
+          
+          # Get commits between tags
+          commits=$(git log --pretty=format:"%s (%h)" ${{ github.event.before }}..${{ github.sha }})
+          
+          # Categorize commits based on conventional commit prefixes
+          features=$(echo "$commits" | grep -E "^feat(\(.+\))?: " || true)
+          fixes=$(echo "$commits" | grep -E "^fix(\(.+\))?: " || true)
+          docs=$(echo "$commits" | grep -E "^docs(\(.+\))?: " || true)
+          style=$(echo "$commits" | grep -E "^style(\(.+\))?: " || true)
+          refactor=$(echo "$commits" | grep -E "^refactor(\(.+\))?: " || true)
+          perf=$(echo "$commits" | grep -E "^perf(\(.+\))?: " || true)
+          test=$(echo "$commits" | grep -E "^test(\(.+\))?: " || true)
+          build=$(echo "$commits" | grep -E "^(build|ci)(\(.+\))?: " || true)
+          chore=$(echo "$commits" | grep -E "^(chore|deps)(\(.+\))?: " || true)
+          other=$(echo "$commits" | grep -vE "^(feat|fix|docs|style|refactor|perf|test|build|ci|chore|deps)(\(.+\))?: " || true)
+          
+          # Generate categorized changelog
+          if [ -n "$features" ]; then
+            echo "## 🚀 Features" >> $GITHUB_OUTPUT
+            echo "$features" | sed 's/^feat[^:]*: /- /' | sed 's/ (/ (/' >> $GITHUB_OUTPUT
+            echo "" >> $GITHUB_OUTPUT
+          fi
+          
+          if [ -n "$fixes" ]; then
+            echo "## 🐛 Bug Fixes" >> $GITHUB_OUTPUT
+            echo "$fixes" | sed 's/^fix[^:]*: /- /' | sed 's/ (/ (/' >> $GITHUB_OUTPUT
+            echo "" >> $GITHUB_OUTPUT
+          fi
+          
+          if [ -n "$docs" ]; then
+            echo "## 📚 Documentation" >> $GITHUB_OUTPUT
+            echo "$docs" | sed 's/^docs[^:]*: /- /' | sed 's/ (/ (/' >> $GITHUB_OUTPUT
+            echo "" >> $GITHUB_OUTPUT
+          fi
+          
+          if [ -n "$style" ]; then
+            echo "## 🎨 Code Style" >> $GITHUB_OUTPUT
+            echo "$style" | sed 's/^style[^:]*: /- /' | sed 's/ (/ (/' >> $GITHUB_OUTPUT
+            echo "" >> $GITHUB_OUTPUT
+          fi
+          
+          if [ -n "$refactor" ]; then
+            echo "## ♻️ Refactoring" >> $GITHUB_OUTPUT
+            echo "$refactor" | sed 's/^refactor[^:]*: /- /' | sed 's/ (/ (/' >> $GITHUB_OUTPUT
+            echo "" >> $GITHUB_OUTPUT
+          fi
+          
+          if [ -n "$perf" ]; then
+            echo "## ⚡ Performance" >> $GITHUB_OUTPUT
+            echo "$perf" | sed 's/^perf[^:]*: /- /' | sed 's/ (/ (/' >> $GITHUB_OUTPUT
+            echo "" >> $GITHUB_OUTPUT
+          fi
+          
+          if [ -n "$test" ]; then
+            echo "## ✅ Tests" >> $GITHUB_OUTPUT
+            echo "$test" | sed 's/^test[^:]*: /- /' | sed 's/ (/ (/' >> $GITHUB_OUTPUT
+            echo "" >> $GITHUB_OUTPUT
+          fi
+          
+          if [ -n "$build" ]; then
+            echo "## 🔧 Build & CI" >> $GITHUB_OUTPUT
+            echo "$build" | sed 's/^(build|ci)[^:]*: /- /' | sed 's/ (/ (/' >> $GITHUB_OUTPUT
+            echo "" >> $GITHUB_OUTPUT
+          fi
+          
+          if [ -n "$chore" ]; then
+            echo "## ⤵️ Dependencies" >> $GITHUB_OUTPUT
+            echo "$chore" | sed 's/^(chore|deps)[^:]*: /- /' | sed 's/ (/ (/' >> $GITHUB_OUTPUT
+            echo "" >> $GITHUB_OUTPUT
+          fi
+          
+          if [ -n "$other" ]; then
+            echo "## 💭 Other Changes" >> $GITHUB_OUTPUT
+            echo "$other" | sed 's/^/- /' >> $GITHUB_OUTPUT
+            echo "" >> $GITHUB_OUTPUT
+          fi
+          
+          echo "EOF" >> $GITHUB_OUTPUT


Shouldn't mikepenz/release-changelog-builder-action already handle this with the new configuration in HYBRID mode?

BluemediaDev · 2025-08-15T19:25:16Z

.github/workflows/docker.yml

+            ## 🐳 Docker Images
+            
+            Multi-platform Docker images are available at:
+            ```bash
+            docker pull ${{ env.REGISTRY }}/${{ env.REGISTRY_IMAGE }}:${{ github.ref_name }}
+            docker pull ${{ env.REGISTRY }}/${{ env.REGISTRY_IMAGE }}:latest
+            ```
+            
+            ## 🚀 Quick Start
+            
+            ### Docker Run
+            ```bash
+            docker run -d -p 3000:80 \
+              -e CONFIG_TITLE="My Status Page" \
+              -e CONFIG_HIDE_URLS="true" \
+              -e CONFIG_HIDE_FOOTER="true" \
+              ${{ env.REGISTRY }}/${{ env.REGISTRY_IMAGE }}:${{ github.ref_name }}
+            ```
+            
+            ### Docker Compose
+            ```yaml
+            version: '3.8'
+            services:
+              fancy-gatus:
+                image: ${{ env.REGISTRY }}/${{ env.REGISTRY_IMAGE }}:${{ github.ref_name }}
+                ports:
+                  - "3000:80"
+                environment:
+                  CONFIG_TITLE: "My Infrastructure Status"
+                  CONFIG_GATUS_BASE_URL: "https://status.example.com"
+                  CONFIG_HIDE_URLS: "false"
+                  CONFIG_HIDE_FOOTER: "false"
+            ```
+            
+            ## 📦 Static Build
+            
+            Download the static build zip file from the assets below and serve with any web server.
+            
+            ## 🏗️ Supported Platforms
+            - linux/amd64
+            - linux/arm64


I would like to avoid including all this information with every release. In my opinion, this information should be included in the README instead.

BluemediaDev · 2025-08-15T19:32:46Z

Dockerfile

@@ -0,0 +1,37 @@
+# Build stage
+FROM node:18-alpine AS builder


Please also use Node.js 22 here.

BluemediaDev · 2025-08-15T19:35:25Z

README.md

+docker build -t fancy-gatus .
+docker run -d -p 3000:80 \
+  -e CONFIG_TITLE="My Status Page" \
+  -e CONFIG_HIDE_URLS="true" \
+  fancy-gatus


I would rather use the latest image from the registry than build the container again.

BluemediaDev · 2025-08-15T19:36:42Z

README.md

+#### Security Features
+
+The Docker image includes several security features:
+- Lightweight nginx:alpine base image
+- Read-only filesystem
+- Automatic security scanning
+- Minimal attack surface
+- Efficient Alpine Linux base


I would leave that part out, as some of this is not true.

BluemediaDev · 2025-08-15T19:37:26Z

docker-compose.yml

+
+services:
+  fancy-gatus:
+    build: .


Again, I would rather use the latest image from the registry.

BluemediaDev · 2025-08-15T19:46:50Z

docker-compose.yml

+      NGINX_PORT: "80"
+
+      # Timezone
+      TZ: "UTC"


The time zone isn't used anywhere, is it?

BluemediaDev · 2025-08-15T20:09:37Z

scripts/setup-nginx.sh

+    server_tokens off;
+    
+    # Access logs
+    access_log /var/log/nginx/access.log;


I would write the access log to stdout or disable it completely.

anshuman852 added 13 commits August 6, 2025 02:20

feat: add GitHub Actions workflow for building and publishing multi-p…

5bc285d

…latform Docker images

fix: update workflow triggers to only respond to version tags

4b752c2

refactor: switch to nginx:alpine base image and update configuration …

05564a3

…paths

fix: update Docker metadata tags to fix build errors

d3adfc8

feat: add ErrorDisplay component for improved error handling and user…

b6e8f81

… feedback

feat: add CONFIG_HIDE_FOOTER option to control footer visibility

f63e461

feat: enhance Docker workflow with Node.js setup, build steps, and ch…

cea7348

…angelog generation; remove obsolete release workflow

feat: update changelog generation to include commit-based logs when n…

11cecbc

…o PRs are found

feat: enhance changelog generation with categorized commit logging an…

3dc536c

…d update Docker workflow configuration

fix: clean up docker-compose.yml by removing unused security options

b305a34

feat: enhance Docker manifest creation with platform-specific digest …

13a0877

…handling

BluemediaDev requested changes Aug 15, 2025

View reviewed changes

BluemediaDev self-assigned this Aug 15, 2025

BluemediaDev added the enhancement New feature or request label Aug 15, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add support for using env vars, add a few more configs, build docker image #44

feat: add support for using env vars, add a few more configs, build docker image #44

Uh oh!

anshuman852 commented Aug 12, 2025

Uh oh!

BluemediaDev left a comment

Uh oh!

BluemediaDev Aug 15, 2025

Uh oh!

BluemediaDev Aug 15, 2025

Uh oh!

BluemediaDev Aug 15, 2025

Uh oh!

BluemediaDev Aug 15, 2025

Uh oh!

BluemediaDev Aug 15, 2025

Uh oh!

BluemediaDev Aug 15, 2025

Uh oh!

BluemediaDev Aug 15, 2025

Uh oh!

BluemediaDev Aug 15, 2025

Uh oh!

BluemediaDev Aug 15, 2025

Uh oh!

BluemediaDev Aug 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feat: add support for using env vars, add a few more configs, build docker image #44

Are you sure you want to change the base?

feat: add support for using env vars, add a few more configs, build docker image #44

Uh oh!

Conversation

anshuman852 commented Aug 12, 2025

Uh oh!

BluemediaDev left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants