Skip to main content

System configuration and settings

System configuration and settings

Installations: Native, Docker, VirtualBox

Customizing mDIS

There are three places where system-wide configurations can be applied.

  • the app_settings table in the database
  • .env Files
  • Backend Configuration Files
Customizations of the frontend

Several app settings and configuration variables are stored in a database table app_settings, 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 login screen, the page 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

.env file

An .env file can be found in the document root directory of the application on the web server. It is essential for correct operation of the application, and it must be present. It is not included in the code repository, but an example file .env.example is provided. The .env file is used to set environment variables that are used by the application, such as database connection settings, debug mode, and other configuration options. It is important to keep this file secure and not to share it publicly, as it may contain sensitive information such as database credentials.

The settings in the .env file are loaded by PHP code in the directory backend/config/ (see below).

TODO: describe all options in .env file in detail, and the .env.example, .env.test files.

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 authentication using LDAP is required. Take the "config template" ldap_example.php, customize and edit this file, and save it as ldap.php in the backend/config/ directory.
  • igsn.php: Must be renamed from the config template igsn-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.