System configuration and settings
Related Pages
Installations: Native, - Docker, - VirtualBox
Customizing mDIS
There are three places where system wide configurations can be applied.
- .env Files
- Backend Configuration Files
- the
app_settings
table in the database
.env file
An .env file can be found in the root directory of the application on the web server.
It contains the database settings, configuration of YII backend (development or production version), etc.
The settings in the .env file are incorporated into the backend configuration files in directory backend/config/
(see below).
They are mainly separated to use mDIS in a docker environment.
TODO: describe all options in .env file in detail
Backend configuration files
The backend configuration files are located in the directory backend/config/
.
There are only a few files that could be necessary to modify for an instance:
params.php
(several different settings)ldap.php
: Use this if an authentication using LDAP is required. Take "config template"ldap_example.php
, customize and edit this file, and save it asldap.php
in thebackend/config/
directory.igsn.php
: Must be renamed from config-templateigsn-example-fixed-prefix.php
and edited to configure the methods and parameters to create IGSNs .
Usually the files console.php
and web.php
must not be modified for an instance.
Customizations of the frontend
Several App-settings are stored in a database table and requested from the frontend. At both compile-time and at runtime, these settings are substituted into various .vue
and .php
files. This makes it easier to maintain customizations of the user interface, such as icons, the footer, the appearance of the application name in the header, etc.
The settings values are stored in serialized form in database tables, and should not be edited directly in the database. Rather use the command line. On the web server, change into the base directory and enter:
./yii help config
To list the existing values:
./yii config/list
To set a value:
./yii config/set AppShortName mDIS
TBC
There are even more database tables that influence the look and feel of the app.
TBC