Merge pull request #2 from CodeShellDev/migrate/golang

migrate: to golang

Author: CodeShellDev

.dockerignore

@@ -1 +1,16 @@
-!app.py
+# env file
+*.env
+
+# Exclude git folders
+.git*
+!.github
+
+# Ignore yml files
+*.yaml
+*.yml
+
+# Markdown files
+*.md
+
+# Include data/
+!data/*

.github/templates/README.template.md

@@ -1,68 +1,113 @@
+<div align="center">
+  <a href="https://github.com/codeshelldev/servdiscovery/releases">
+    <img 
+      src="https://img.shields.io/github/v/release/codeshelldev/servdiscovery?sort=semver&logo=github&label=Release" 
+      alt="GitHub release"
+    >
+  </a>
+  <a href="https://github.com/codeshelldev/servdiscovery/stargazers">
+    <img 
+      src="https://img.shields.io/github/stars/codeshelldev/servdiscovery?style=flat&logo=github&label=Stars" 
+      alt="GitHub stars"
+    >
+  </a>
+  <a href="https://github.com/codeshelldev/servdiscovery/pkgs/container/servdiscovery">
+    <img 
+      src="https://ghcr-badge.egpl.dev/codeshelldev/servdiscovery/size?color=%2344cc11&tag=latest&label=Image+Size&trim="
+      alt="Docker image size"
+    >
+  </a>
+  <a href="https://github.com/codeshelldev/servdiscovery/pkgs/container/servdiscovery">
+    <img 
+      src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fghcr-badge.elias.eu.org%2Fapi%2Fcodeshelldev%2Fservdiscovery%2Fservdiscovery&query=downloadCount&label=Downloads&color=2344cc11"
+      alt="Docker image Pulls"
+    >
+  </a>
+  <a href="./LICENSE">
+    <img 
+      src="https://img.shields.io/badge/License-MIT-green.svg"
+      alt="License: MIT"
+    >
+  </a>
+</div>
+
 # ServDiscovery
 
-ServDiscovery is a Discovery Service that keeps an Endpoint updated with active Hosts (of Services).
+**ServDiscovery** is a dynamic **Discovery Service** that keeps your endpoints in sync with active hosts of your services — perfect for modern, containerized environments. Think of it as the bridge between your services and your reverse proxy, ensuring traffic always finds the right destination.
 
 ## Installation
 
-> [!NOTE]
-> ServDiscovery only works with Traefik and not with **any** other Reverse Proxy due to `traefik.http.routers.router.rule` label
+> [!IMPORTANT]
+> ServDiscovery works **only with Traefik**. It will **not** work with other reverse proxies due to using traefik labels to determine routes.
 
-Get the latest `docker-compose.yaml` file:
+Get the latest `docker-compose.yaml`:
 
 ```yaml
 {{{ #://docker-compose.yaml }}}
 ```
 
+Then spin it up:
+
 ```bash
 docker compose up -d
 ```
 
+Your discovery service is now live! 🎉
+
 ## Usage
 
-Take this little `whoami` Container as an Example:
+Let's take a simple `whoami` container as an example:
 
 ```yaml
 {{{ #://examples/whoami.docker-compose.yaml }}}
 ```
 
-Whenever a new **Host-Rule** gets added / modified ServDiscovery will update the set Endpoint to notify of any new changes.
-This way the Endpoint can correctly route to different Hosts based on **SNI / Hostnames**.
+Whenever a new **Host-Rule** is added or updated, ServDiscovery will **automatically notify the configured endpoint**.  
+This ensures the endpoint can correctly route traffic based on **SNI / Hostnames**.
 
-## Endpoint
+## Endpoint Integration
 
-ServDiscovery sends requests to the Endpoint as a **JSON HTTP Request**:
+ServDiscovery communicates with your endpoint via **JSON HTTP Requests**:
 
 ```json
 {{{ #://examples/payload.json }}}
 ```
 
-This example tell the Endpoint that...
+Example explanation:
 
-| Available            | Unavailable                 |
+| ✅ Available         | ❌ Unavailable              |
 | -------------------- | --------------------------- |
 | whoami.mydomain.com  | whoami-backup.mydomain.com  |
 | website.mydomain.com | website-backup.mydomain.com |
 | auth.mydomain.com    | auth-backup.mydomain.com    |
 
-This way (if the Endpoint is used by a LoadBalancer) the Owner of the Endpoint can now delete the `*-backup.mydomain.com` records from a Registry,
-thus updating the list of routable Containers / Services.
+This allows the endpoint (e.g., a load balancer) to remove `\*-backup` records from your registry and **update routable containers/services automatically**.
+
+### Integrations
+
+You can find example integrations inside of [examples/](./examples).
 
 ## Configuration
 
-### ENDPOINT_KEY
+### `ENDPOINT_KEY`
+
+The endpoint key is used in the `Authorization` header (Bearer token) when ServDiscovery sends POST requests.  
+If no key is provided, the header is omitted.
+
+### `DISCOVERY_INTERVAL`
 
-The Endpoint Key is provided in the Authorization Header (via Bearer) during the POST request between the Endpoint and ServDiscovery.
-If no Key is provided ServDiscovery will leave out the Authorization Header.
+Time (in seconds) between updates to your endpoint.  
+**Default:** `60` seconds
 
-### DISCOVERY_INTERVAL
+### `ALIVE_INTERVAL`
 
-The Discovery Interval sets the Interval of which ServDiscovery will update the Endpoint, etc.
+Time (in seconds) between full alive discoveries. ServDiscovery sends a **complete update** of all active containers in the `added` JSON key.  
+**Default:** `120` seconds
 
 ## Contributing
 
-Found a bug or have new ideas or enhancements for this Project?
-Feel free to open up an issue or create a Pull Request!
+Found a bug or have a brilliant idea? Contributions are welcome! Open an **issue** or create a **pull request** — your help makes this project better.
 
 ## License
 
-[MIT](https://choosealicense.com/licenses/mit/)
+This project is licensed under the [MIT License](./LICENSE).

.github/workflows/docker-image-dev.yml

@@ -4,12 +4,13 @@ on:
   push:
     branches:
       - dev
-    paths-ignore:
-      - ".**"
+    paths:
+      - "**/*.go"
 
 jobs:
   update:
-    uses: codeshelldev/gh-actions/.github/workflows/docker-image.yml@main
+    uses: codeshelldev/gh-actions/.github/workflows/docker-image-go.yml@main
+    name: Development Image
     with:
       registry: ghcr.io
       flavor: |

.github/workflows/docker-image.yml

@@ -6,7 +6,8 @@ on:
 
 jobs:
   update:
-    uses: codeshelldev/gh-actions/.github/workflows/docker-image.yml@main
+    uses: codeshelldev/gh-actions/.github/workflows/docker-image-go.yml@main
+    name: Stable Image
     with:
       registry: ghcr.io
     secrets:

.github/workflows/readme-update.yml

@@ -10,5 +10,6 @@ on:
 jobs:
   update:
     uses: codeshelldev/gh-actions/.github/workflows/readme-update.yml@main
+    name: Update
     secrets:
       GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,2 +1,33 @@
-.env
-.venv
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Code coverage profiles and other test artifacts
+*.out
+coverage.*
+*.coverprofile
+profile.cov
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
+# env file
+*.env
+
+# Editor/IDE
+# .idea/
+.vscode/
+
+# Exclude git folders
+.git*
+!.github

Dockerfile

@@ -1,13 +1,19 @@
-FROM python:3.12-alpine
+FROM alpine:3.22
+RUN apk --no-cache add ca-certificates
 
-WORKDIR /app
+ARG IMAGE_TAG
+ENV IMAGE_TAG=$IMAGE_TAG
+LABEL org.opencontainers.image.version=$IMAGE_TAG
+
+ARG TARGETOS
+ARG TARGETARCH
 
-RUN pip install docker
+WORKDIR /app
 
 COPY . .
 
-ENV PORT=4531
+COPY dist/${TARGETOS}/${TARGETARCH}/app .
 
-EXPOSE ${PORT}
+RUN rm dist/ -r
 
-CMD ["python", "app.py"]
+CMD ["./app"]