forked from berhsi/matrix-register
39 lines
1.4 KiB
Markdown
39 lines
1.4 KiB
Markdown
# matrix-register
|
|
|
|
Das Programm befindet sich noch in der Entwicklung! Es gibt keine Garantie
|
|
für eine korrekte Funktion.
|
|
|
|
matrix-register ist eine Webanwendung, welche die Möglichkeit der
|
|
Registrierung eines Accounts bei matrix.kraut.space anbietet. Der Nutzer
|
|
beantragt über ein Webformular die Registrierung, bekommt eine
|
|
Validierungsmail zugesand und nach Bestätigung der Mail den Account
|
|
aktiviert. Nach erfolgreicher Validierung wird ein temporäres Passwort
|
|
erzeugt und auf der Webseite angezeigt. Deshalb die Empfehlung https zu
|
|
benutzen. Auch wenn das Passwort als Hash gespeichert wird - bitte umgehend
|
|
per Client ändern.
|
|
|
|
## Installation
|
|
|
|
- Ein Verzeichnis /etc/matrix-register anlegen. Die Datei
|
|
register.ini.example in register.ini umbenennen und in das Verzeichnis
|
|
/etc/matrix-register verschieben. Die Datei muß für den Benutzer, unter
|
|
dem das Programm läuft, lesbar sein.
|
|
|
|
- Alle anderen Verzeichnisse und Dateien in das Document-Root des Webservers
|
|
kopieren und die Rechte anpassen.
|
|
|
|
## Konfiguration
|
|
|
|
Datenbank, Loglevel und einige Parameter der Mail werden in register.ini
|
|
konfiguriert. Mit einigen Anpassungen dürfte es auch auf andere Host
|
|
übertragbar sein. Einige Erläuterungen zu den Parametern befinden sich in
|
|
der Konfigurationsdatei.
|
|
|
|
## Abhängigkeiten
|
|
|
|
matrix-register benötigt zum Arbeiten folgende Programme:
|
|
|
|
* einen Webserver mit aktiviertem php-Support
|
|
* eine Datenbank (Postgres oder SQLite)
|
|
* matrix-synapse
|