Konfigurationsdatei config.php [Admidio-Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Konfigurationsdatei config.php ======
Wie viele andere Programme auch besitzt Admidio eine zentrale Konfigurationsdatei, in der die wichtigsten Einstellungen gespeichert sind. Die Datei findest du im Ordner **adm_my_files** (bis einschließlich Admidio 2.4 lag die Datei direkt im Admidio Hauptordner). Sie wird während der Installation automatisch erzeugt und dort abgelegt. Normalerweise ist es dann nicht mehr nötig, diese zu öffnen und zu bearbeiten. In seltenen Fällen kann dies aber dennoch nötig sein z.B. beim Verschieben des Admidio-Ordners oder zur Aktivierung eines ausführlicheren Logs. Aus diesem Grund wollen wir euch hier eine Übersicht über die vorhandenen und möglichen Einstellungen geben, sowie eine kurze Erklärung zu jeder Einstellung.

==== $g_adm_srv ====
Der Name des Datenbankservers. Dieser wird vom Hoster vorgegeben. Bei einer lokalen Einrichtung kann dies ''localhost'' oder ''127.0.0.1'' sein.

Mögliche Werte: Vorgabe vom Hoster\\ 
Notwendige Version: ''**ab 1.0**''

==== $g_adm_usr ====
Name des Benutzers, der sich an der Datenbank anmelden kann. Dieser wird vom Hoster vorgegeben.

Mögliche Werte: Vorgabe vom Hoster\\ 
Notwendige Version: ''**ab 1.0**''

==== $g_adm_pw ====
Passwort des Benutzers, der sich an der Datenbank anmelden kann. Dieser wird vom Hoster vorgegeben.

Mögliche Werte: Vorgabe vom Hoster\\ 
Notwendige Version: ''**ab 1.0**''

==== $g_adm_db ====
Name der Datenbank, in der die Admidio Tabellen eingerichtet wurden. Dieser wird vom Hoster vorgegeben.

Mögliche Werte: Vorgabe vom Hoster\\ 
Notwendige Version: ''**ab 1.0**''

==== $g_adm_port ====
Optional kann hier der Port zur Datenbank angegeben werden. Wird dieser Parameter nicht gesetzt, so wird der Standardport der Datenbank (MySQL/MariaDB: 3306, PostgreSQL: 5432) verwendet.

Mögliche Werte: Vorgabe vom Hoster\\ 
Notwendige Version: ''**ab 3.2**''

==== $g_organization ====
Die Kurzbezeichnung der Standard-Organisation. Werden über Admidio mehrere Organisationen verwaltet, so könnte jede Organisation einen eigenen Webspace besitzen und diese Variable steuert, welche Organisation über diesen Webspace verwaltet wird. Werden mehrere Organisationen über einen Webspace gesteuert, so gibt diese Variable die Organisation an, die beim Login vorausgewählt ist.

Mögliche Werte: Wert aus Tabellenfeld adm_organizations::org_shortname\\ 
Notwendige Version: ''**ab 1.0**''

==== $g_root_path ====
URL zur aktuellen Admidio-Installation. Die URL darf nicht mit einem Slash oder Backslash enden. Wird der Admidio-Ordner verschoben, so muss auch diese Variable entsprechend angepasst werden.


Mögliche Werte: https://www.admidio.org/demo bzw. die URL zu deiner Admidio-Installation\\ 
Notwendige Version: ''**ab 1.0**''

==== $g_tbl_praefix ====
Alle Tabellen von Admidio in der Datenbank bekommen ein einheitliches Präfix, welches hier festgelegt ist. Möchte man in derselben Datenbank eine weitere Admidio-Installation einrichten, so muss jede Admidio-Installation ein eigenes Präfix besitzen. Über die hier hinterlegte Angabe weiß Admidio, welche Tabellen zu dieser Installation mit dieser Konfigurationsdatei gehören.

Mögliche Werte: ''**adm**'' bzw. jede beliebige Kombination\\ 
Notwendige Version: ''**ab 1.0**''

==== $gCheckIpAddress ====
Jeder Benutzer bzw. jede Benutzerin, ob ausgeloggt oder eingeloggt, wird über eine eindeutige Session-ID 
identifiziert. Diese ID wird bei jedem Seitenaufruf mit übergeben. Überwacht nun ein
Dritter den Datenverkehr von dem Rechner zu dem Server und bekommt diese ID zu sehen, 
so kann er sich mit dieser Session-ID als derjenige Nutzer ausgeben, dem diese ID eigentlich gehört. Er hat somit alle Rechte in dem System, die der ursprüngliche Nutzer auch besitzt.
Um diesem Missbrauch vorzubeugen, vergleicht Admidio zusätzlich bei jedem Seitenaufruf die
zugehörige IP-Adresse zu dieser Session. Ändert sich die IP-Adresse zwischendurch, so 
erkennt Admidio dies als ungültige Verbindung und schließt die entsprechende Session.

Diese Einstellung ist im Standard deaktiviert, da es bei Benutzer:innen zu Problemen kommen kann. Manche Benutzer:innen nutzen z.B. absichtlich Dienste, die die IP-Adresse regelmäßig ändern. Auch kann es vorkommen, dass manche Provider absichtlich nach einem bestimmten Zeitraum die IP-Adresse ändern.

Möglicher Wert: ''true'', ''false''\\ 
Notwendige Version: ''**ab 3.1**''

==== $gDbType ====
Admidio unterstützt als Datenbank neben MySQL, MariaDB auch PostgreSQL. Diese Variable gibt an, welche Datenbank-Engine genutzt werden soll.

Mögliche Werte: ''**mysql**'' bzw. ''**pgsql**''\\ 
Notwendige Version: ''**ab 2.3**''

==== $gDebug ====
Flag über das eine umfangreichere Protokollierung aktiviert wird. Diese sollte nur in Testsystemen genutzt werden, da die Logdatei schnell anwachsen kann. In einer produktiven Umgebung sollte diese Einstellung nur gezielt zur Fehlersuche aktiviert werden.
Folgende Dinge werden zusätzlich protokolliert:
  * Alle SQL-Statements
  * Anzahl der gefundenen Datensätze bei SELECT-Statements
  * Name und Pfad der aufgerufenen Scripte
  * Parameterübergaben an aufgerufene Scripte
  * Debug-Ausgabe beim Email-Versand über SMTP
  * Nicht komprimierte Javascript und CSS-Dateien werden eingebunden

Möglicher Wert: ''true'', ''false''\\ 
Notwendige Version: ''**ab 2.0**''

==== $gImportDemoData ====
Dieser Parameter ist **ausschließlich** für Testsysteme gedacht und ermöglicht es [[en:entwickler:testumgebung_einrichten#upload_test_data|Testdaten einzuspielen]]. In einer produktiven Umgebung kann dies zu einem kompletten Datenverlust führen.

Möglicher Wert: ''true'', ''false''\\ 
Notwendige Version: ''**ab 3.0**''

==== $gLoginForUpdate ====
Dieses Flag sorgt dafür, dass ein Datenbankupdate auf eine neue Admidio-Version nur durchgeführt werden kann, wenn ein Administrator seine Zugangsdaten im Updatescript angegeben hat. Diese Funktion ist im Standard immer aktiv und kann in der config.php über diesen Parameter deaktiviert werden. Aus Sicherheitsgründen empfehlen wir diese Funktion immer aktiviert zu lassen. Nur in Testsystemen ist es sinnvoll die Funktion abzuschalten.

Möglicher Wert: ''true'', ''false''\\ 
Notwendige Version: ''**ab 3.0**''

==== $gSetCookieForDomain ====
Dieses Flag sorgt dafür, dass das Cookie für die gesamte Domain, auf der Admidio installiert ist, gültig ist. Ist Admidio im Ordner ''www.meine-domain.org/admidio'' installiert, so ist das Cookie aus Sicherheitsgründen nur für Scripte verfügbar, die im Ordner ''www.meine-domain.org/admidio'' oder darunter liegen. Scripte unter ''www.meine-domain.org'' oder ''www.meine-domain.org/test'' können das Cookie nicht auslesen. Wollt ihr allerdings mit einem Script die Anmeldung bei Admidio in einem anderen Ordner nutzen, so müsst ihr dieses Flag aktivieren.

Möglicher Wert: ''true'', ''false''\\ 
Notwendige Version: ''**ab 3.2.11**''

==== $gPasswordHashAlgorithm ====
Optional kann hier der Verschlüsselungsalgorithmus für die Benutzerpasswörter hinterlegt werden. Dieser sollte i.d.R. immer auf ''DEFAULT'' stehen. Dann wird der zur Zeit beste Algorithmus genommen, der von allen gängigen PHP-Installationen unterstützt wird. ''SHA512'' steht nicht automatisch auf allen Servern zur Verfügung, so dass diese Option nur gewählt werden sollte, wenn sichergestellt ist, dass die Admidio-Version immer auf einem Server laufen wird, der diese Verschlüsselung unterstützt. Die Verschlüsselungen ''ARGON2ID'' und ''ARGON2I'' stehen erst ab Admidio 4 zur Verfügung.

Möglicher Wert: ''DEFAULT'', ''BCRYPT'', ''SHA512'', ''ARGON2ID'', ''ARGON2I''\\ 
Notwendige Version: ''**ab 3.2**''

==== $gForceHTTPS ====
Admidio erkennt automatisch, ob eine verschlüsselte Kommunikation mit https stattfindet oder nicht. In seltenen Fällen funktioniert diese Erkennung  nicht. In diesem Fall kannst du Admidio vorgeben, dass die Verbindung immer verschlüsselt laufen soll. Setze diesen Parameter auf ''true''. Die Standardeinstellung ist bei Nichtsetzung ''false''.

Möglicher Wert: ''true'', ''false''\\ 
Notwendige Version: ''**ab 3.2**''

==== $gDisableEmailSending ====
Verhindert den Versand von sämtlichen E-Mails über das System. Das sind sowohl Systembenachrichtigungen, als auch von Benutzer:innen erstelle E-Mails. Dieser Parameter sollte nur in Demo-Systemen gesetzt werden, bei denen die E-Mail-Oberfläche weiterhin sichtbar sein soll, aber der missbräuchliche Versand von E-Mails verhindert werden soll. Setze diesen Parameter auf ''true''. Die Standardeinstellung ist bei Nichtsetzung ''false''.

Möglicher Wert: ''true'', ''false''\\ 
Notwendige Version: ''**ab 4.3.8**''

==== $gTimezone ====
Angabe der Zeitzone, die für diese Organisation genutzt werden soll. Der Wert entspricht einer von [[http://www.php.net/manual/en/timezones.php|PHP unterstützen Zeitzone]]. Die Zeitzone wird einmalig bei der Installation festgelegt und sollte danach nicht mehr verändert werden. Muss die Zeitzone dennoch später angepasst werden, so werden die bereits erfassten Zeiten nicht an die neue Zeitzone angepasst.

Möglicher Wert: ''Europe/Berlin''\\ 
Notwendige Version: ''**ab 3.1**''