DAW/furt
2
0
Fork 0
Code Issues 11 Pull requests Projects Releases 3 Packages 1 Wiki Activity Actions
Low-Tech API-Gateway für digitale Souveränität
83 commits 2 branches 5 tags 346 KiB
Find a file
michael 8b7806670c docs: simplify README and remove FreeBSD support 
- Strip README to essentials with wiki references only
- Remove non-existent API docs and troubleshooting links
- Focus on quick start and actual integrations (merkwerk)
- Remove FreeBSD support from all installation scripts
- Clean up platform detection logic in scripts
- Maintain OpenBSD and Linux support only

Reduces maintenance burden and aligns with actual project scope.
2025-09-10 12:20:41 +02:00
config feat(config): integrate rate limiting and CORS configuration from furt.conf 2025-08-29 20:01:47 +02:00
deployment feat(deployment): add systemd security hardening 2025-09-07 18:40:32 +02:00
docs docs: simplify README and remove FreeBSD support 2025-09-10 12:20:41 +02:00
integrations feat(integration): add universal merkwerk binary detection 2025-08-28 17:34:36 +02:00
scripts docs: simplify README and remove FreeBSD support 2025-09-10 12:20:41 +02:00
src docs: simplify README and remove FreeBSD support 2025-09-10 12:20:41 +02:00
tests refactor: clean repository structure for v0.1.0 open source release 2025-08-14 09:36:55 +02:00
.gitignore security: sanitize internal infrastructure details from open source package 2025-09-07 21:25:25 +02:00
.version_history chore: merkwerk auto-update 2025-09-07 21:25:38 +02:00
install.sh docs: simplify README and remove FreeBSD support 2025-09-10 12:20:41 +02:00
LICENSE chore(license): switch to ISC license 2025-09-03 11:02:32 +02:00
README.md docs: simplify README and remove FreeBSD support 2025-09-10 12:20:41 +02:00
VERSION feat(core): implement file-based API versioning system (DAW/furt#83) 2025-08-15 16:57:33 +02:00

README.md

Furt API Gateway

Pure Lua HTTP-Server für digitale Souveränität

Überblick

Furt ist ein minimalistisches HTTP-Server in Lua 5.1 für Mail-Versendung über SMTP. Es bietet eine einfache JSON-API für Web-Integration und Multi-Tenant-Unterstützung über API-Keys.

Features

  • HTTP-Server mit JSON-APIs
  • Multi-Tenant Mail-Routing über SMTP
  • API-Key-basierte Authentifizierung
  • Health-Check-Endpoints
  • Rate-Limiting pro API-Key
  • CORS-Support für Frontend-Integration

Quick Start

Dependencies installieren:

# OpenBSD
doas pkg_add lua lua-socket lua-cjson luasec

# Debian/Ubuntu
sudo apt install lua5.1 lua-socket lua-cjson lua-sec

# Arch Linux
sudo pacman -S lua51 lua51-socket lua51-dkjson lua51-sec

Installation:

git clone https://smida.dragons-at-work.de/DAW/furt.git
cd furt
sudo ./install.sh

Server läuft auf: http://127.0.0.1:7811

API-Endpoints

Health Check:

curl http://127.0.0.1:7811/health

Mail senden:

curl -X POST http://127.0.0.1:7811/v1/mail/send \
     -H "X-API-Key: your-api-key" \
     -H "Content-Type: application/json" \
     -d '{"name":"Test","email":"test@example.com","subject":"Test","message":"Test-Nachricht"}'

Dokumentation

Installation & Konfiguration: Furt Wiki

Projektstruktur

furt/
├── src/                    # Lua-Source-Code
├── config/                 # Konfiguration
├── scripts/                # Installation & Management
└── deployment/             # System-Integration

Integration

merkwerk: Versionierte Furt-Deployment über merkwerk

License

ISC - Siehe LICENSE für Details.

Links