forked from berhsi/matrix-register
38 lines
1.5 KiB
Markdown
38 lines
1.5 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
|
|
|
|
- Für die Datei register.ini in /etc ein Verzeichnis matrix-register/
|
|
anlegen. Dort die Datei register.ini hineinkopieren. Die Datei muß für
|
|
den Benutzer, welcher php ausführt, lesbar sein. Bei einem anderen Ort muß
|
|
die Variable $config_path in base.php angepaßt werde.
|
|
|
|
- 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
|