michael
8b7806670c
- 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.
83 lines
2 KiB
Markdown
83 lines
2 KiB
Markdown
# 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:**
|
|
```bash
|
|
# 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:**
|
|
```bash
|
|
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:**
|
|
```bash
|
|
curl http://127.0.0.1:7811/health
|
|
```
|
|
|
|
**Mail senden:**
|
|
```bash
|
|
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](https://smida.dragons-at-work.de/DAW/furt/wiki)
|
|
|
|
## Projektstruktur
|
|
|
|
```
|
|
furt/
|
|
├── src/ # Lua-Source-Code
|
|
├── config/ # Konfiguration
|
|
├── scripts/ # Installation & Management
|
|
└── deployment/ # System-Integration
|
|
```
|
|
|
|
## Integration
|
|
|
|
**merkwerk:** Versionierte Furt-Deployment über [merkwerk](https://smida.dragons-at-work.de/DAW/merkwerk)
|
|
|
|
## License
|
|
|
|
ISC - Siehe [LICENSE](LICENSE) für Details.
|
|
|
|
## Links
|
|
|
|
- **Repository:** [Forgejo](https://smida.dragons-at-work.de/DAW/furt)
|
|
- **Dokumentation:** [Wiki](https://smida.dragons-at-work.de/DAW/furt/wiki)
|
|
- **Projekt:** [Dragons@Work](https://dragons-at-work.de)
|
|
|