Weitere Anpassung und Erweiterung
Tiefgreifendere Anpassungen benötigen aktuell noch das Anpassen von Komponenten im Quellcode von SecDoc. Neue oder verbesserte Funktionen können auf diese Art ebenfalls realisiert werden, wenn in der Umgebung spezielle Wünsche bestehen. Sollten vorgenommene Anpassungen oder Erweiterungen möglicherweise auch für andere Nutzer von Interesse sein, können diese gerne mit Hilfe eines Merge Requests eingereicht werden.
Sollten viele Änderungen am Quellcode vorgenommen werden, bietet es sich eventuell an, einen Fork des Repositories anzulegen und die eigenen Anpassungen dort vorzunehmen und zu committen. Aktualisierungen in der öffenntlichen Version können mit Git regelmäßig in die eigene Version integriert werden. Weitere Informationen zum Vorgehen können beispielsweise hier gefunden werden: Forking Workflow.
Zur weiteren Anpassung des Systems sollten die Dokumentationen der JS- und PHP-Skripte eingesehen werden. Die Dokumentation des JS-Codes ist zu finden in JSDoc und die des PHP-Backends in phpDoc.
Links, Logos und Texte
Hierbei können die HTML-Dateien bearbeitet werden. Der Grundaufbau ist in der index.html Datei zu finden. Die verschiedenen Unterseiten, die je nach Modus geladen werden, und die Titelseite für die PDF-Generierung können im Ordner /assets/html/ gefunden und angepasst werden.
Zukünftig sollen einige Texte und Verlinkungen über den Installationswizard angepasst werden können.
Textvorschläge
Für einige Eingabefelder stellt das Tool Vorschläge für den Nutzer zur Verfügung. Diese werden, bis auf die aktuellen Nutzergruppen und Systeme, alle aus der SQLite Datenbank ausgelesen. Zu diesen Daten zählen Personen, Organisationseinheiten, IVVen und CPE-Einträge. Die benötigten Tabellen werden beim ersten Start der Anwendung angelegt und müssen nur befüllt werden. Die Tabellendefinitionen können in DBCon.class.php gefunden werden. Diese können dafür genutzt werden, um die Tabelle z.B. mittels einer SQL-Importdatei über das CLI von SQLite zu befüllen und regelmäßig aktuell zu halten.
Backend
Für Anpassungen im Backend, die über die möglichen Konfigurationen in der secdoc.conf.php Datei hinausgehen, können die PHP Dateien direkt angepasst werden. Hier sind vor allem die folgenden Dateien interessant:
- verwaltung.php - Beantwortet alle API Aufrufe der SecDoc Oberfläche; zuständig für E-Mail Versand und PDF-Generierung
- Utils.class.php - Enthält diverse Funktionen für verschiedene Abfragen (z.B. AD/LDAP)
- DBCon.class.php - Verwaltet die Datenbank-Aufrufe zur internen SQLite Datenbank