build for arm

Author: andreitere

.github/workflows/build-image.yml

@@ -2,9 +2,8 @@ name: Create and publish a Docker image
 
 # Configures this workflow to run every time a tag is pushed.
 on:
-  push:
-    tags:
-      - '*'
+  release:
+    types: [published]
 
 # 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:
@@ -25,6 +24,11 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+        with:
+          platforms: linux/amd64,linux/arm64
+
       - name: Log in to the Container registry
         uses: docker/login-action@v2
         with:
@@ -36,9 +40,9 @@ jobs:
         id: meta
         uses: docker/metadata-action@v4
         with:
-          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ github.event.release.tag_name }}
           tags: |
-            type=ref,event=tag
+            ${{ github.event.release.tag_name }}
           labels: |
             type=ref,event=tag
 
@@ -50,6 +54,7 @@ jobs:
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          platforms: linux/amd64,linux/arm64
 
       - name: Generate artifact attestation
         uses: actions/attest-build-provenance@v1

README.md

@@ -1,14 +1,33 @@
 # coolify-nginx-reverse-proxy
 
-# running on coolify
+A lightweight, flexible NGINX reverse proxy designed for seamless deployment with [Coolify](https://coolify.io/) or standalone Docker environments. Effortlessly proxy traffic to your internal services with minimal configuration.
 
-- Create a resource under a project
-- Docker Image: `ghcr.io/andreitere/coolify-nginx-reverse-proxy` Tag: `latest`
-- Env Var `PROXY_HOST` set to something like: `http://192.168.1.21:8123`
-- Set the domain you want to proxy, e.g. `https://test001.mydomain.com`
-- Save and redeploy
+> **Perfect for exposing services running on the same network but outside your Coolify instance!**
 
-# running locally
+---
+
+## 🚀 Features
+
+- **Plug-and-play**: Deploy instantly with Coolify or Docker
+- **Dynamic proxying**: Easily set your backend target via environment variables
+- **Multiple config templates**: Choose from prebuilt NGINX configs (default, basic, authentik, immich)
+- **SSL/TLS ready**: Works with your domain and Coolify's SSL automation
+- **Minimal footprint**: Small, efficient Docker image
+
+---
+
+## ⚡ Quick Start
+
+### Deploy on Coolify
+
+1. **Create a resource** under your project in Coolify
+2. **Docker Image**: `ghcr.io/andreitere/coolify-nginx-reverse-proxy`  
+   **Tag**: `latest`
+3. **Set Env Var**: `PROXY_HOST` (e.g. `http://192.168.1.21:8123`)
+4. **Set Domain**: The domain you want to proxy (e.g. `https://test001.mydomain.com`)
+5. **Save and redeploy**
+
+### Run Locally with Docker
 
 ```shell
 docker run \
@@ -18,3 +37,47 @@ docker run \
   --build-arg CONF_TYPE=${CONF_TYPE:-default} \
   ghcr.io/andreitere/coolify-nginx-reverse-proxy:latest
 ```
+
+---
+
+## ⚙️ Configuration
+
+- **PROXY_HOST** (required): The backend service URL to proxy to (e.g. `http://192.168.1.21:8123`)
+- **CONF_TYPE** (optional, build-arg): Selects the NGINX config template. Options:
+  - `default` (default)
+  - `basic`
+  - `authentik`
+  - `immich`
+- **Domain**: Set in Coolify to match your public-facing domain
+
+### Example: Custom Config
+To use a different config, set the build arg:
+```shell
+--build-arg CONF_TYPE=authentik
+```
+
+---
+
+## 💡 Example Use Cases
+- Expose a Home Assistant instance securely to the internet
+- Proxy an internal dashboard with authentication
+- Use as a simple gateway for self-hosted apps
+- **Expose services running on the same network but outside your Coolify instance**
+
+---
+
+## 🤝 Contributing
+Pull requests and issues are welcome! For major changes, please open an issue first to discuss what you’d like to change.
+
+---
+
+## 📄 License
+MIT License. See [LICENSE](LICENSE) for details.
+
+---
+
+## 🔗 Links
+- [Coolify Documentation](https://coolify.io/docs)
+- [NGINX Documentation](https://nginx.org/en/docs/)
+- [Docker Hub](https://hub.docker.com/)
+- [Project Repository](https://github.com/andreitere/coolify-nginx-reverse-proxy)