update api.dragons-at-work.de to api.example.com

michael 2025-09-10 14:12:26 +02:00
parent ec1b44ad7c
commit d33bd17ccd
14 changed files with 90 additions and 76 deletions

@ -9,7 +9,7 @@ Furt bietet eine REST-API für die Integration mit Websites und Anwendungen. Die
## Base URL ## Base URL
``` ```
Production: https://api.dragons-at-work.de Production: https://api.example.com
Development: http://localhost:7811 Development: http://localhost:7811
``` ```
@ -157,7 +157,7 @@ async function sendContactForm(formData) {
### curl (Testing) ### curl (Testing)
```bash ```bash
curl -X POST https://api.dragons-at-work.de/v1/mail/send \ curl -X POST https://api.example.com/v1/mail/send \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-H "X-API-Key: your-api-key" \ -H "X-API-Key: your-api-key" \
-d '{"name":"Test","email":"test@example.com","message":"Test message"}' -d '{"name":"Test","email":"test@example.com","message":"Test message"}'
@ -200,3 +200,4 @@ curl -H "X-API-Key: test" http://localhost:7811/auth/status
``` ```
**Development-Endpoint:** Der `/test` Endpoint ist nur verfügbar wenn in der Konfiguration aktiviert. Er dient zum Testen der Request-Verarbeitung ohne Side-Effects. **Development-Endpoint:** Der `/test` Endpoint ist nur verfügbar wenn in der Konfiguration aktiviert. Er dient zum Testen der Request-Verarbeitung ohne Side-Effects.

@ -241,7 +241,7 @@ scrape_configs:
- job_name: 'furt-gateway' - job_name: 'furt-gateway'
metrics_path: '/health' metrics_path: '/health'
static_configs: static_configs:
- targets: ['api.dragons-at-work.de:443'] - targets: ['api.example.com:443']
``` ```
**Health-to-Metrics Mapping:** **Health-to-Metrics Mapping:**
@ -364,3 +364,4 @@ Health-Endpoint-Aufrufe erscheinen in den Server-Logs:
``` ```
**Request-ID:** Health-Checks erhalten keine Request-ID da sie stateless sind. **Request-ID:** Health-Checks erhalten keine Request-ID da sie stateless sind.

@ -194,3 +194,4 @@ Furt ist aktuell ein integrierter HTTP-Server mit eingebautem Mail-Service (form
**Projekt:** [Dragons@Work Digital Sovereignty](https://dragons-at-work.de) **Projekt:** [Dragons@Work Digital Sovereignty](https://dragons-at-work.de)
**Repository:** [Forgejo](https://smida.dragons-at-work.de/DAW/furt) **Repository:** [Forgejo](https://smida.dragons-at-work.de/DAW/furt)
**License:** ISC **License:** ISC

@ -154,3 +154,4 @@ Das Script-System ist für Erweiterungen designt. Neue Scripts können einfach i
Diese Konsistenz macht es einfach das System zu verstehen und zu erweitern ohne bestehende Funktionalität zu beeinträchtigen. Diese Konsistenz macht es einfach das System zu verstehen und zu erweitern ohne bestehende Funktionalität zu beeinträchtigen.
Die Helper Scripts transformieren die manuelle furt-Installation von einem fehleranfälligen, wiederholenden Prozess zu einem robusten, automatisierten Workflow der bei Bedarf fein-granular gesteuert werden kann. Die Helper Scripts transformieren die manuelle furt-Installation von einem fehleranfälligen, wiederholenden Prozess zu einem robusten, automatisierten Workflow der bei Bedarf fein-granular gesteuert werden kann.

@ -186,3 +186,4 @@ Häufige Probleme sind fehlende Berechtigungen, bereits existierende Benutzer od
Bei komplexeren Problemen kannst du zur manuellen Installation zurückkehren um jeden Schritt einzeln zu kontrollieren und zu verstehen wo der Fehler auftritt. Bei komplexeren Problemen kannst du zur manuellen Installation zurückkehren um jeden Schritt einzeln zu kontrollieren und zu verstehen wo der Fehler auftritt.
Die automatisierte Installation beschleunigt wiederkehrende furt-Deployments erheblich und reduziert die Wahrscheinlichkeit von Tippfehlern bei der manuellen Installation. Die automatisierte Installation beschleunigt wiederkehrende furt-Deployments erheblich und reduziert die Wahrscheinlichkeit von Tippfehlern bei der manuellen Installation.

@ -242,3 +242,4 @@ curl -X POST http://127.0.0.1:7811/v1/mail/send \
``` ```
Eine erfolgreiche Response bestätigt dass SMTP-Konfiguration und API-Key korrekt funktionieren. Die Test-Mail sollte an die in der Konfiguration angegebene Adresse ankommen. Eine erfolgreiche Response bestätigt dass SMTP-Konfiguration und API-Key korrekt funktionieren. Die Test-Mail sollte an die in der Konfiguration angegebene Adresse ankommen.

@ -240,3 +240,4 @@ curl -X POST http://127.0.0.1:7811/v1/mail/send \
Der Auth-Status-Endpunkt zeigt welche Permissions der verwendete API-Key hat. Der Mail-Test sendet eine echte E-Mail an die konfigurierte Adresse und bestätigt dass SMTP-Routing funktioniert. Der Auth-Status-Endpunkt zeigt welche Permissions der verwendete API-Key hat. Der Mail-Test sendet eine echte E-Mail an die konfigurierte Adresse und bestätigt dass SMTP-Routing funktioniert.
Diese flexible Konfigurationsarchitektur ermöglicht es furt als zentraler Mail-Gateway für komplexe Multi-Website-Umgebungen zu fungieren, während jede Website ihre spezifischen Routing- und Sicherheitsanforderungen erfüllen kann. Diese flexible Konfigurationsarchitektur ermöglicht es furt als zentraler Mail-Gateway für komplexe Multi-Website-Umgebungen zu fungieren, während jede Website ihre spezifischen Routing- und Sicherheitsanforderungen erfüllen kann.

@ -291,7 +291,7 @@ document.getElementById('contact-form').addEventListener('submit', async (e) =>
```go ```go
{{< furt-contact-form {{< furt-contact-form
api-endpoint="https://api.dragons-at-work.de/v1/mail/send" api-endpoint="https://api.example.com/v1/mail/send"
api-key="your-api-key" api-key="your-api-key"
success-url="/contact/thanks/" success-url="/contact/thanks/"
fields="name,email,subject,message" fields="name,email,subject,message"
@ -302,7 +302,7 @@ document.getElementById('contact-form').addEventListener('submit', async (e) =>
```bash ```bash
# Valid request # Valid request
curl -X POST https://api.dragons-at-work.de/v1/mail/send \ curl -X POST https://api.example.com/v1/mail/send \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-H "X-API-Key: your-api-key" \ -H "X-API-Key: your-api-key" \
-d '{ -d '{
@ -313,7 +313,7 @@ curl -X POST https://api.dragons-at-work.de/v1/mail/send \
}' }'
# Test validation error # Test validation error
curl -X POST https://api.dragons-at-work.de/v1/mail/send \ curl -X POST https://api.example.com/v1/mail/send \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-H "X-API-Key: your-api-key" \ -H "X-API-Key: your-api-key" \
-d '{ -d '{
@ -378,3 +378,4 @@ Sending mail for tenant: your-website
From: noreply@your-website.com From: noreply@your-website.com
SMTP: mail.your-provider.com:587 SMTP: mail.your-provider.com:587
``` ```

@ -255,3 +255,4 @@ sed -i "s|/usr/local|$PREFIX|g" /etc/rc.d/furt
``` ```
Das `create-service.sh` Script abstrahiert die Komplexität verschiedener Service-Management-Systeme und macht furt zu einem echten System-Service der automatisch startet, überwacht wird und in die Betriebssystem-Verwaltung integriert ist. Das `create-service.sh` Script abstrahiert die Komplexität verschiedener Service-Management-Systeme und macht furt zu einem echten System-Service der automatisch startet, überwacht wird und in die Betriebssystem-Verwaltung integriert ist.

@ -257,3 +257,4 @@ fi
``` ```
Das `health-check.sh` Script ist der Schlussstein des modularen furt-Installationssystems und stellt sicher dass alle vorherigen Installationsschritte erfolgreich waren und der Service vollständig betriebsbereit ist. Das `health-check.sh` Script ist der Schlussstein des modularen furt-Installationssystems und stellt sicher dass alle vorherigen Installationsschritte erfolgreich waren und der Service vollständig betriebsbereit ist.

@ -198,3 +198,4 @@ SHARE_DIR="$PREFIX/share/furt"
``` ```
Das `setup-directories.sh` Script schafft eine konsistente, sichere Verzeichnisstruktur die sich nahtlos in verschiedene Betriebssysteme integriert und dabei bewährte Admin-Praktiken respektiert. Das `setup-directories.sh` Script schafft eine konsistente, sichere Verzeichnisstruktur die sich nahtlos in verschiedene Betriebssysteme integriert und dabei bewährte Admin-Praktiken respektiert.

@ -174,3 +174,4 @@ useradd -u 1100 -g _furt -s /bin/false -d /var/empty _furt 2>/dev/null || true
``` ```
Das `setup-user.sh` Script reduziert die komplexen Unterschiede zwischen Betriebssystemen auf ein einfaches, einheitliches Interface. Es ist der erste Baustein des modularen Installationssystems und demonstriert wie kleine, spezialisierte Scripts robuste Automatisierung ermöglichen können. Das `setup-user.sh` Script reduziert die komplexen Unterschiede zwischen Betriebssystemen auf ein einfaches, einheitliches Interface. Es ist der erste Baustein des modularen Installationssystems und demonstriert wie kleine, spezialisierte Scripts robuste Automatisierung ermöglichen können.

@ -209,3 +209,4 @@ fi
``` ```
Das `sync-files.sh` Script schließt die Lücke zwischen Development und Installation durch automatisierte, sichere Synchronisation aller furt-Komponenten mit betriebssystem-angemessenen Berechtigungen. Das `sync-files.sh` Script schließt die Lücke zwischen Development und Installation durch automatisierte, sichere Synchronisation aller furt-Komponenten mit betriebssystem-angemessenen Berechtigungen.

@ -247,3 +247,4 @@ fi
``` ```
Das `validate-config.sh` Script ist ein kritischer Sicherheits-Checkpoint der verhindert dass furt mit defekter Konfiguration startet und dadurch unvorhersagbare Fehler oder Sicherheitslücken entstehen. Es balanciert gründliche Validierung mit praktischer Nutzbarkeit. Das `validate-config.sh` Script ist ein kritischer Sicherheits-Checkpoint der verhindert dass furt mit defekter Konfiguration startet und dadurch unvorhersagbare Fehler oder Sicherheitslücken entstehen. Es balanciert gründliche Validierung mit praktischer Nutzbarkeit.