MrUnknownDE/utools
1
0
Fork 0
mirror of https://github.com/MrUnknownDE/utools.git synced 2026-04-19 06:03:45 +02:00
Code Issues Packages Projects Releases Wiki Activity

seperate docker-build compose

Browse Source
This commit is contained in:
MrUnknownDE
2025-09-23 19:19:28 +02:00
parent 9693238eb0
commit b93b91d352
5 changed files with 108 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files

115
.github/workflows/docker-build-push.yml vendored
View File

@@ -1,97 +1,58 @@
name: Build and Push Docker Images name: Docker Build and Push
# Trigger: Wann soll der Workflow laufen?
on: on:
workflow_dispatch: # Ermöglicht manuelles Starten über die GitHub UI push:
branches:
- main # Löst den Workflow bei jedem Push auf den main-Branch aus
jobs: jobs:
build-and-push: build-and-push:
runs-on: ubuntu-latest # Verwendet den neuesten Ubuntu-Runner von GitHub runs-on: ubuntu-latest
# Berechtigungen für den GITHUB_TOKEN, um nach GHCR pushen zu können
permissions: permissions:
contents: read # Zum Auschecken des Codes contents: read
packages: write # Zum Pushen nach GitHub Packages (GHCR) packages: write # Notwendig, um in die GHCR zu pushen
steps: steps:
# 1. Code auschecken
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@v4 uses: actions/checkout@v4
# 2. Docker Metadaten extrahieren (Tags, Labels)
# Wir definieren hier die Namen für beide Images
- name: Extract Docker metadata
id: meta
uses: docker/metadata-action@v5
with: with:
images: | fetch-depth: 0 # Notwendig, um den Git-Hash zu bekommen
ghcr.io/${{ github.repository_owner }}/utools-backend
ghcr.io/${{ github.repository_owner }}/utools-frontend
# Tags generieren:
# - Typ 'sha' -> Kurzer Commit-Hash (z.B. sha-a1b2c3d)
# - Typ 'ref' für Events 'branch' -> Branch-Name (z.B. 'main' wird zu 'latest')
# - Typ 'ref' für Events 'tag' -> Git-Tag-Name (z.B. v1.0.0)
tags: |
type=sha,prefix=sha-
type=ref,event=branch
type=ref,event=tag
type=ref,event=pr # Nur für PR-Events
# 3. QEMU für Multi-Plattform Builds (optional, aber gute Praxis)
- name: Set up QEMU
uses: docker/setup-qemu-action@v3
# 4. Docker Buildx einrichten (verbesserter Builder)
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
# 5. Login bei GitHub Container Registry (GHCR)
# Verwendet den automatisch generierten GITHUB_TOKEN
- name: Log in to GitHub Container Registry - name: Log in to GitHub Container Registry
uses: docker/login-action@v3 uses: docker/login-action@v3
with: with:
registry: ghcr.io registry: ghcr.io
username: ${{ github.actor }} # Benutzer oder Organisation, dem das Repo gehört username: ${{ github.actor }}
password: ${{ secrets.GHCR_PUSH_TOKEN }} password: ${{ secrets.GITHUB_TOKEN }}
# 6. Backend Image bauen und pushen - name: Set up Docker Buildx
- name: Build and push Backend image uses: docker/setup-buildx-action@v3
id: build-backend
uses: docker/build-push-action@v5
with:
context: ./backend # Pfad zum Backend-Dockerfile
# Nur pushen, wenn es ein Push zum main-Branch oder ein Git-Tag ist
push: ${{ github.event_name == 'push' || github.event_name == 'create' && startsWith(github.ref, 'refs/tags/') }}
# Tags und Labels aus dem Metadaten-Schritt verwenden (gefiltert für Backend)
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
# Filter für das spezifische Backend-Image (Index 0 in der 'images'-Liste oben)
# Wichtig: Passe den Index an, falls du die Reihenfolge änderst!
image-name-index: 0 # Index des Backend-Images in der 'images'-Liste
cache-from: type=gha # GitHub Actions Cache verwenden (Lesen)
cache-to: type=gha,mode=max # GitHub Actions Cache verwenden (Schreiben)
# 7. Frontend Image bauen und pushen - name: Get Git commit SHA
- name: Build and push Frontend image id: git_sha
id: build-frontend run: echo "sha=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
uses: docker/build-push-action@v5
with:
context: ./frontend # Pfad zum Frontend-Dockerfile
# Nur pushen, wenn es ein Push zum main-Branch oder ein Git-Tag ist
push: ${{ github.event_name == 'push' || github.event_name == 'create' && startsWith(github.ref, 'refs/tags/') }}
# Tags und Labels aus dem Metadaten-Schritt verwenden (gefiltert für Frontend)
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
# Filter für das spezifische Frontend-Image (Index 1 in der 'images'-Liste oben)
image-name-index: 1 # Index des Frontend-Images in der 'images'-Liste
cache-from: type=gha
cache-to: type=gha,mode=max
# 8. (Optional) Output der Image-Namen und Tags - name: Define Image Names
- name: Print image names and tags id: image_names
if: always() # Auch ausführen, wenn vorherige Schritte fehlschlagen (zum Debuggen)
run: | run: |
echo "Backend Image Tags: ${{ steps.meta.outputs.tags }}" echo "backend_image=ghcr.io/${{ github.repository_owner }}/utools-backend" >> $GITHUB_OUTPUT
echo "Frontend Image Tags: ${{ steps.meta.outputs.tags }}" echo "frontend_image=ghcr.io/${{ github.repository_owner }}/utools-frontend" >> $GITHUB_OUTPUT
echo "Backend Image Digest: ${{ steps.build-backend.outputs.digest }}"
echo "Frontend Image Digest: ${{ steps.build-frontend.outputs.digest }}" - name: Build images using compose.build.yml
env:
GIT_COMMIT_SHA: ${{ steps.git_sha.outputs.sha }}
SENTRY_DSN: ${{ secrets.SENTRY_DSN }} # Sentry DSN als Secret übergeben
run: |
docker compose -f compose.build.yml build
- name: Tag images with Git SHA
run: |
docker tag ${{ steps.image_names.outputs.backend_image }}:latest ${{ steps.image_names.outputs.backend_image }}:${{ steps.git_sha.outputs.sha }}
docker tag ${{ steps.image_names.outputs.frontend_image }}:latest ${{ steps.image_names.outputs.frontend_image }}:${{ steps.git_sha.outputs.sha }}
- name: Push images to GHCR (both tags)
run: |
docker push ${{ steps.image_names.outputs.backend_image }}:latest
docker push ${{ steps.image_names.outputs.backend_image }}:${{ steps.git_sha.outputs.sha }}
docker push ${{ steps.image_names.outputs.frontend_image }}:latest
docker push ${{ steps.image_names.outputs.frontend_image }}:${{ steps.git_sha.outputs.sha }}

63
README.md
View File

@@ -58,57 +58,56 @@ You can run this application easily using Docker and Docker Compose.
This method uses the Docker images automatically built and pushed to GitHub Container Registry (GHCR) by the GitHub Actions workflow. This method uses the Docker images automatically built and pushed to GitHub Container Registry (GHCR) by the GitHub Actions workflow.
1. **Create `docker-compose.yml`:** 1. **Create `compose.yml`:**
Save the following content as `docker-compose.yml` in a new directory on your machine: Save the following content as `compose.yml` in a new directory on your machine:
```yaml ```yaml
version: '3.8'
services: services:
# Backend Service (Node.js App)
backend: backend:
# Use the pre-built image from GHCR # Verwendet ein bereits gebautes Image
image: ghcr.io/mrunknownde/utools-backend:latest # Or specify a specific tag/sha image: ghcr.io/mrunknownde/utools-backend:latest
container_name: utools_backend container_name: utools_backend
restart: unless-stopped restart: unless-stopped
environment: environment:
# Production environment settings # Setze Umgebungsvariablen für das Backend
NODE_ENV: production NODE_ENV: production # Wichtig für Performance und Logging
PORT: 3000 PORT: 3000 # Port innerhalb des Containers
LOG_LEVEL: info # Adjust log level if needed (e.g., 'debug', 'warn') LOG_LEVEL: info # Oder 'warn' für weniger Logs in Produktion
PING_COUNT: 4 PING_COUNT: 4
# Optional: Set Sentry DSN for error tracking if you use Sentry # Sentry DSN aus der Umgebung/ .env Datei übernehmen
# SENTRY_DSN: "YOUR_SENTRY_DSN" SENTRY_DSN: "https://7ea70caba68f548fb96482a573006a7b@o447623.ingest.us.sentry.io/4509062020333568" # Wichtig für die Laufzeit
dns: dns:
# Explicitly set reliable public DNS servers for rDNS lookups inside the container
- 1.1.1.1 # Cloudflare DNS - 1.1.1.1 # Cloudflare DNS
- 1.0.0.1 # Cloudflare DNS - 1.0.0.1 # Cloudflare DNS
- 8.8.8.8 # Google DNS - 8.8.8.8 # Google DNS
- 8.8.4.4 # Google DNS - 8.8.4.4 # Google DNS
networks: networks:
- utools_network - utools_network # Verbinde mit unserem benutzerdefinierten Netzwerk
# Note: No ports exposed directly, access is via frontend proxy
# Frontend Service (Nginx)
frontend: frontend:
# Use the pre-built image from GHCR # Verwendet ein bereits gebautes Image
image: ghcr.io/mrunknownde/utools-frontend:latest # Or specify a specific tag/sha image: ghcr.io/mrunknownde/utools-frontend:latest
container_name: utools_frontend container_name: utools_frontend
restart: unless-stopped restart: unless-stopped
ports: ports:
# Expose port 8080 on the host, mapping to port 80 in the container (Nginx) # Mappe Port 8080 vom Host auf Port 80 im Container (wo Nginx lauscht)
# Zugriff von außen (Browser) erfolgt über localhost:8080
- "8080:80" - "8080:80"
depends_on: depends_on:
- backend # Ensures backend service is started first - backend # Stellt sicher, dass Backend gestartet wird (aber nicht unbedingt bereit ist)
networks: networks:
- utools_network - utools_network # Verbinde mit unserem benutzerdefinierten Netzwerk
# Definiere ein benutzerdefiniertes Netzwerk (gute Praxis)
networks: networks:
utools_network: utools_network:
driver: bridge driver: bridge
name: utools_network # Give the network a specific name
``` ```
2. **Start the Application:** 2. **Start the Application:**
Open a terminal in the directory where you saved the `docker-compose.yml` file and run: Open a terminal in the directory where you saved the `compose.yml` file and run:
```bash ```bash
docker compose up -d docker compose up -d
``` ```
@@ -120,7 +119,7 @@ This method uses the Docker images automatically built and pushed to GitHub Cont
### Option 2: Building Images from Source ### Option 2: Building Images from Source
If you want to modify the code or build the images yourself: If you want to modify the code or build the images yourself, the project is now split into a build and a run configuration.
1. **Clone the Repository:** 1. **Clone the Repository:**
```bash ```bash
@@ -128,20 +127,26 @@ If you want to modify the code or build the images yourself:
cd utools cd utools
``` ```
2. **Build and Start:** 2. **Build and Start:**
Use Docker Compose to build the images based on the `Dockerfile`s in the `backend` and `frontend` directories and then start the containers: First, you build the images using `compose.build.yml`. Then, you start the services using the main `compose.yml`.
```bash ```bash
# Optional: Set GIT_COMMIT_SHA for build args if needed # Set GIT_COMMIT_SHA for the build process
# export GIT_COMMIT_SHA=$(git rev-parse --short HEAD) export GIT_COMMIT_SHA=$(git rev-parse --short HEAD)
docker compose -f compose.yml up -d --build
# 1. Build the images
docker compose -f compose.build.yml build
# 2. Run the services using the newly built images
docker compose -f compose.yml up -d
``` ```
*(Note: Use `docker-compose` (with hyphen) if you have an older version. The `compose.yml` in the repository correctly uses `build:` directives)* You can also use the provided `build.sh` script which does these steps for you.
3. **Access the Webapp:** 3. **Access the Webapp:**
Open your web browser and navigate to `http://localhost:8080`. Open your web browser and navigate to `http://localhost:8080`.
## ⚙️ Configuration ## ⚙️ Configuration
The application is configured mainly through environment variables set in the `docker-compose.yml` file for the `backend` service: The application is configured mainly through environment variables set in the `compose.yml` file for the `backend` service:
* `NODE_ENV`: Set to `production` for optimal performance and JSON logging. * `NODE_ENV`: Set to `production` for optimal performance and JSON logging.
* `PORT`: The internal port the Node.js application listens on (default: `3000`). * `PORT`: The internal port the Node.js application listens on (default: `3000`).

12
build.sh
View File

@@ -1,3 +1,13 @@
docker compose down docker compose down
# Setzt die Git-Commit-Variable für den Build-Prozess
export GIT_COMMIT_SHA=$(git rev-parse --short HEAD) export GIT_COMMIT_SHA=$(git rev-parse --short HEAD)
docker compose -f compose.yml up -d --build export SENTRY_DSN="https://7ea70caba68f548fb96482a573006a7b@o447623.ingest.us.sentry.io/4509062020333568"
# Schritt 1: Baue die Images mit der compose.build.yml
echo "--- Building Docker images ---"
docker compose -f compose.build.yml build
# Schritt 2: Starte die Container mit der compose.yml, die die gebauten Images verwendet
echo "--- Starting containers ---"
docker compose -f compose.yml up -d

18
compose.build.yml Normal file
View File

@@ -0,0 +1,18 @@
# compose.build.yml
services:
backend:
# Definiert, wie das Image gebaut wird
build:
context: ./backend
args:
- GIT_COMMIT_SHA=${GIT_COMMIT_SHA:-unknown}
- SENTRY_DSN=${SENTRY_DSN:-}
# Legt den Namen für das gebaute Image fest
image: ghcr.io/mrunknownde/utools-backend:latest
frontend:
# Definiert, wie das Image gebaut wird
build:
context: ./frontend
# Legt den Namen für das gebaute Image fest
image: ghcr.io/mrunknownde/utools-frontend:latest

17
compose.yml
View File

@@ -1,15 +1,9 @@
services: services:
# Backend Service (Node.js App) # Backend Service (Node.js App)
backend: backend:
build: # Verwendet ein bereits gebautes Image
context: ./backend # Pfad zum Verzeichnis mit dem Backend-Dockerfile image: ghcr.io/mrunknownde/utools-backend:latest
args: container_name: utools_backend
# Übergibt den Git Commit Hash als Build-Argument.
# Erwartet, dass GIT_COMMIT_SHA in der Shell-Umgebung gesetzt ist (z.B. export GIT_COMMIT_SHA=$(git rev-parse --short HEAD))
- GIT_COMMIT_SHA=${GIT_COMMIT_SHA:-unknown}
# Übergibt den Sentry DSN als Build-Argument (optional, falls im Code benötigt)
- SENTRY_DSN="https://7ea70caba68f548fb96482a573006a7b@o447623.ingest.us.sentry.io/4509062020333568"
container_name: utools_backend # Eindeutiger Name für den Container
restart: unless-stopped restart: unless-stopped
environment: environment:
# Setze Umgebungsvariablen für das Backend # Setze Umgebungsvariablen für das Backend
@@ -33,7 +27,8 @@ services:
# Frontend Service (Nginx) # Frontend Service (Nginx)
frontend: frontend:
build: ./frontend # Pfad zum Verzeichnis mit dem Frontend-Dockerfile # Verwendet ein bereits gebautes Image
image: ghcr.io/mrunknownde/utools-frontend:latest
container_name: utools_frontend container_name: utools_frontend
restart: unless-stopped restart: unless-stopped
ports: ports:
@@ -48,4 +43,4 @@ services:
# Definiere ein benutzerdefiniertes Netzwerk (gute Praxis) # Definiere ein benutzerdefiniertes Netzwerk (gute Praxis)
networks: networks:
utools_network: utools_network:
driver: bridge # Standard-Netzwerktreiber driver: bridge