... | ... | @@ -4,18 +4,42 @@ |
|
|
|
|
|
## Konfigurationsdateien
|
|
|
|
|
|
## Authentifizierung
|
|
|
Zur lokalen Konfiguration (außer den Basispfaden, siehe [Installation](installation/Installation)) sollte die [secdoc.conf.php](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/ajax/secdoc.conf.php) Datei genutzt werden. Diese liegt je nach Installation an einem anderen Ort, standardmäßig aber unter dem Pfad `/var/www/secdoc`.
|
|
|
|
|
|
### Demo
|
|
|
Die Basispfade müssen hingegen in der [config.inc.php](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/ajax/config.inc.php#L61-71) im Hauptverzeichnis von SecDoc unter `assets/ajax/config.inc.php` angepasst werden, sofern ein anderer Pfad als `/var/www/secdoc` genutzt wird!
|
|
|
|
|
|
### LDAP
|
|
|
## Allgemeine Konfiguration ([L14-19](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/ajax/secdoc.conf.php#L14-19))
|
|
|
`$prog_name` setzt den Namen der Instanz für verschiedene Stellen (z.B. bei der PDF-Erzeugung).
|
|
|
|
|
|
### OpenID
|
|
|
`$prog_url` muss auf den Pfad zur SecDoc Instanz gesetzt werden, welche auch zur Benutzung im Browser aufgerufen wird. Dies wird für Links in E-Mail Benachrichtigungen verwendet.
|
|
|
|
|
|
### SSO
|
|
|
## E-Mail-Konfiguration ([L21-43](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/ajax/secdoc.conf.php#L21-43))
|
|
|
Für den Versand von E-Mails nach dem Abschlluss von Dokumentationen mit PHPMailer müssen hier die passenden Einstellungen vorgenommen werden. Wenn kein SMTP Server (`$eMail_config['smtp']`) angegeben ist, wird die E-Mail über die `mail()` Funktion in PHP verschickt.
|
|
|
|
|
|
Ausgehende E-Mails können mit einem passenden Zertifikat signiert werden, wenn gewünscht.
|
|
|
|
|
|
Genauere Informationen zur Konfiguration können in der [PHPMailer Dokumentation](https://github.com/PHPMailer/PHPMailer/wiki) gefunden werden.
|
|
|
|
|
|
## Authentifizierung ([L45-67](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/ajax/secdoc.conf.php#L45-67))
|
|
|
Die Methode zur Authentifizierung kann über `$auth_method` gewählt werden. Zur Authentifizierung stehen bisher die vier folgenden Möglichkeiten zur Verfügung:
|
|
|
* `demo` - Bietet **keine** Authentifizierung, alle Nutzer haben DSB-Berechtigungen. Nur für Demo-Instanzen!
|
|
|
* `ldap` - Authentifizierung über einen AD/LDAP Server mit Nutzername und Passwort. Es wird eine interne Session-Verwaltung genutzt. Weitere Konfigurationen müssen über `$auth_ldap_config` vorgenommen werden.
|
|
|
* `openid` - Authentifizierung mittels OpenID über Apache Umgebungsvariablen.
|
|
|
* `sso` - Bietet Authentifizierung über SSO-Systeme an (beispielsweise mittles `.htaccess` bei Apache).
|
|
|
|
|
|
An dieser Stellen können auch Berechtigungen für den Zugriff auf Admin-, Debug- und DSB-Funktionen anhand von Nutzergruppen (oder teilweise Nutzerkennungen) festgelegt werden. Die Abfrage von Nutzergruppen zu eingeloggten erfolgt bisher über AD/LDAP und muss separat konfiguriert werden (siehe [Datenquellen](#Datenquellen)).
|
|
|
|
|
|
Sollte keine der vorhandenen Authentifizierungsmethoden verwendbar sein, kann auch eine eigene Klasse erstellt werden (siehe [Auth.class.php](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/ajax/auth/Auth.class.php)).
|
|
|
|
|
|
## Datenquellen
|
|
|
Bisher werden zwei Datenquellen in SecDoc verwendet.
|
|
|
|
|
|
### AD/LAP ([L79-105](https://zivgitlab.uni-muenster.de/secdoc/secdoc/-/blob/master/assets/ajax/secdoc.conf.php#L79-105))
|
|
|
AD/LDAP wird zur Abfrage von Nutzerinformationen, wie z.B. E-Mail Adressen oder Nutzergruppen, verwendet. Zur Abfrage muss ein gültiger Domänencontroller angegeben werden und gegebenenfalls ein Nutzer mit Passwort konfiguriert werden, um die notwendigen Daten abfragen zu können.
|
|
|
|
|
|
In `$ldap_configs` müssen die jeweiligen Anfragen an den eigenen Aufbau der Domänenstruktur angepasst werden. Es werden Platzhalter bei einigen Anfragen verwendet, um dynamische Anfragen zuzulassen, beispielsweise für die Personensuche.
|
|
|
|
|
|
### LDAP
|
|
|
Diese Einstellung ist zwingend notwendig, wenn Zugriffsberechtigungen über Nutzergruppen gesteuert werden sollen. SecDoc selbst enthält bisher keine eigene Gruppenverwaltung!
|
|
|
|
|
|
### SQLite |
|
|
\ No newline at end of file |
|
|
### SQLite
|
|
|
Die SQLite Datenbank wird automatisch angelegt und von SecDoc verwaltet. Hierfür sind keine Konfigurationen an dieser Stelle notwendig. Die Datenbank enthält die gespeicherten Dokumentationen, sowie die TOM-Listen und Vorschläge für die Eingabefelder. |
|
|
\ No newline at end of file |