Java-basierte Mailinglisten-Anwendung, die auf IMAP+SMTP aufsetzt, und damit (fast) jede Mailbox in eine Mailingliste verwandeln kann.

3.0 KiB

Raw Permalink Blame History

Installation

Docker

Die einfachste Art, Widerhall einzusetzen, ist Docker zu verwenden.

Wenn du Docker schon am Laufen hast musst du nur noch folgendes tun:

Dockerfile herunterladen
Image erstellen: docker build -t widerhall /path-to-dockerfile/
Container starten:

docker run \
    --name widerhall \
    -d widerhall

Danach solltest du zu http:/// navigieren können.

Konfiguration, Daten-Persistenz

Um Daten über Computer/Docker-Neustarts hinaus zu erhalten, muss ein Volume in den Container eingebunden werden:

docker run \
    --name widerhall \
    -v /some/directory:/data
    -d widerhall

Widerhall wird alle zu speichernden Daten in /data, also dem eingebundenen Speicher, ablegen.

widerhall.sqlite3 – dies ist die Haupt-Datenbank-Datei. Passen Sie gut darauf auf!
widerhall.config.json – dies ist die Haupt-Konfigurations-Datei. Dort können Sie die vorgegebenen Einstellungen überschreiben.
archive – Hier werden gespeicherte Emails abgelegt.

Diese Dateien/Verzeichnisse werden beim ersten Start (oder wenn Sie zwischenzeitlich gelöscht wurden) angelegt.

Die Konfiguration ist wie folgt aufgebaut:

{
  "port":80,
  "base_url":"https://widerhall.srsoftware.de",
  "locations":{
    "database":"/data/widerhall.sqlite3",
    "configuration":"/data/widerhall.config.json",
    "archive":"/data/archive",
    "base":"/Widerhall"
  }
}

Die base_url sollte so angepasst werden, dass sie Ihren Server-Einstellungen entspricht.
Falls Sie die Datenbankdatei an einem anderen Ort speichern wollen, ändern Sie den database-Eintrag.
Wenn Sie die configuration-Einstellung überschreiben, wird Widerhall seine Konfiguration ersetzen mit der Datei, die an der angegebenen Stelle gefunden wird.
Falls das Mail-Archiv an einem anderen Ort gespeichert werden soll, kann der archive-Eintrag angepasst werden.
base sollte auf das Installations-Verzeichnis von Widerhall zeigen. Standardmäßig ist das /Widerhall.

SSL termination

Widerhall versucht alles einfach zu halten. Der eingebaute Webserver hat keine Ahnung von SSL. Wenn Sie die Website sicher betreiben wollen, lassen Sie Widerhall hintereinem reverse proxy, wie z.B. nginx_proxy laufen.

Maven

Widerhall ist ein Java-Project, welches mit Apache Maven gebaut werden kann. Fall Sie eine aktuelle Java-Installation (Java 17+) und Maven auf Ihrem System haben, sollten Sie Widerhall wie folgt compilieren können:

Holen Sie sich den Programm-Code: git clone https://git.srsoftware.de/StephanRichter/Widerhall.git
Wechseln Sie ins heruntergeladene Verzeichnis: cd Widerhall
Erzeugen Sie das ausführbare JAR-Archiv: mvn clean test compile assembly:single
Starten Sie das JAR: java -jar target/*.jar

Übersetzungen

Die Übersetzungen von Widerhall werden als Branches des Quellcodes gepflegt:

main-Branch: english
lang_de-Branch: deutsch

Einfach die Sprache Ihrer Wahl auschecken.

3.0 KiB Raw Permalink Blame History