Erste Schritte

Formrelay

Ein selbst hostbares Formular-Backend für statische Seiten (Astro, Hugo, plain HTML). Kein SaaS: Ein Betreiber installiert einmal und bedient damit mehrere eigene Sites.

Stand: 1.0.0.

Was es tut

  • Nimmt Formulare an — jedes mit eigener Adresse, nur von den Domains, die dafür eingetragen sind. HTML-Formular oder fetch mit JSON.
  • Stellt per Mail zu — an jeden bestätigten Empfänger, mit Wiederholung, wenn der Mailserver vorübergehend ablehnt.
  • Speichert nur auf Zeit — verschlüsselt, bis zur Zustellung und für eine einstellbare Frist danach. Dann wird gelöscht.
  • Wehrt Spam ohne fremde Dienste ab — unsichtbares Feld, Bindung an die Domains, Drosselung, Größengrenzen. Kein Captcha.
  • Speichert von Einsendern keine IP-Adresse und schreibt keine Inhalte ins Protokoll.

Nicht enthalten: Dateiuploads, Webhooks, Slack/Discord, automatische Antworten an den Einsender, ein Formular-Baukasten (siehe Grenzen).

Der Zuschnitt

  • Keine öffentliche Registrierung. Konten legt ausschließlich ein Administrator an.
  • Zwei Rollen: Nutzer und Administrator — siehe Konten und Rollen. Administratoren haben zusätzlich die Aufsicht über alle Formulare.
  • Die Oberfläche ist deutschsprachig, die Kommandozeile englisch.

Installieren

curl -fLO https://gitlab.com/mankeldor/formrelay/-/raw/main/formrelay-setup.sh
sh formrelay-setup.sh /pfad/zur/installation
cd /pfad/zur/installation
php artisan formrelay:install

Der ganze Weg: Systemanforderungen → Installation → Cron einrichten → Nach der Installation.

Wo was steht

Häufige Fragen Was Formrelay ist, was es kostet, wie es mit Daten umgeht
Erste Schritte Anforderungen, Installation, Cron, Aktualisierung
Benutzen Formulare anlegen, in die Website einbauen, Einsendungen
Betrieb Konfiguration, Einstellungen, Konten, Aufsicht, Zustellbarkeit, Datenschutz, Backup, Wartung, Störungssuche
Lizenz Wer was darf, kostenlos oder lizenzpflichtig
Änderungen Was sich zuletzt geändert hat

Für Entwicklung und Konventionen: CONVENTIONS.md, CONTRIBUTING.md, DOCS-CONVENTIONS.md.

Quelle dieser Seite: docs/uebersicht.md im Repository. Sie wird beim Bauen daraus erzeugt — Änderungen gehören in die Markdown-Datei, nicht in diese Seite.