Configuration files

Configuration files are used to adjust the MinistraPRO administrator panel and the MinistraPRO end-user applications.

Information

You do not need to change anything in the configuration files as part of setting up MinistraPRO. The mandatory configuration files are configured for you.

Configuration file directories

Configuration files are stored in two directories:

/var/www/ministra_middleware/conf.d/default/

The configuration files that are provided by default. You must not change these files.
/var/www/ministra_middleware/conf.d/custom/

The configuration files in this directory override the settings in the default configuration files. The files here do not need to contain all of the available settings, only the settings that need to be overridden.

Mandatory configuration files

The settings in the following configuration files must be correctly set in order for MinistraPRO to work correctly:

database.ini
clickhouse.ini
cache.ini
global_search.ini
operator.ini

Summary of configuration files

File name	Description
database.ini	Configuration settings for the connection to the MySQL database, the main data storage for the system.
clickhouse.ini	Configuration settings for the connection to the ClickHouse database, used to store logs.
cache.ini	Configuration settings for the connection to the Redis database, used to store frequently used data, or data with a limited lifetime.
global_search.ini	Configuration settings for the connection to the ElasticSearch database, used to store search indexes of IPTV Internet Protocol Television channels and VOD Video on demand.
operator.ini	Unique credentials for each operator. These credentials are used for external control of the service.
billing.ini	The settings in billing.ini configure the behaviour of service packages. Read more billing.ini
l18n.ini	The settings in l18n.ini define localisation behaviour, including: Timezones WARNING The time zones in the l18n.ini file, the streaming server, and the MySQL database used for MinistraPRO should be the same. If the timezones are not the same then DVR playback may be affected, as well as authorization. Primary audio and subtitle language Secondary audio and subtitle language Languages available to choose as the default for audio and subtitles in MinistraPRO end-user applications
locales.ini	The settings in locale.ini define allowed locales. Locales are generated on the server but can also be set in the configuration file.
monitoring_server.ini	The settings in monitoring_server.ini configure collected metrics and the connection to the monitoring server. Prometheus Monitoring is used. Information The following cron tasks are used to retrieve metrics: `ministra php /var/www/ministra_middleware/admin/bin/console mtv:stream-server:monitoring:update-state --live-status=1` `ministra php /var/www/ministra_middleware/admin/bin/console mtv:stream-server:monitoring:update-state --clients-count=1` Read more To enable the collection of metrics
playback.ini	The settings in playback.ini configure the behaviour of playback in the MinistraPRO end-user applications. Read more playback.ini
playback_session.ini	The settings in playback_session.ini configure the behaviour of playback sessions in the MinistraPRO end-user applications. Read more playback_session.ini
server_api.ini	The settings in server_api.ini configure the Billing API. Tip You can access the Billing API documentation at the following URL: `<MinistraPRO backend>/docs/billing-api/` For example: `http://example_domain.name/docs/billing-api/`
statistic.ini	The settings in statistic.ini contol the collection of playback statistics for IPTV Internet Protocol Television channels from the MinistraPRO end-user applications. Read more Usage monitoring
system.ini	The settings in system.ini configure the behaviour of the MinistraPRO administrator panel. Read more system.ini
tv.ini	The settings in tv.ini configure the behaviour of IPTV Internet Protocol Television features. Read more tv.ini
tv_archive.ini	The settings in tv_archive.ini configure the behaviour of DVR Digital video recording features. Read more tv_archive.ini
vod.ini	The settings in vod.ini configure the behaviour of VOD Video on demand features. Read more vod.ini
otp_auth_phone.ini	The settings in otp_auth_phone.ini control the behaviour of one-time passwords (OTPs) authorization. Read more Configuring OTP authorization
screen.ini	The settings in screen.ini configure the connection to the Elasticsearch database, and for naming screens and sections. Read more Creating screens Read more Creating sections

billing.ini

The settings in billing.ini configure the behaviour of service packages.

Setting

Setting	Description
option_services[]	Defines the options that are available to add to service packages. Read more Creating service packages
order_itv_channel_as_adding	Defines the ordering of channels in service packages when channels are added. This setting is ignored unless `keep_order_itv_channel_in_service_package` is set to `true`. If `true`, new channels are added to the bottom of the channel list in service packages, regardless of the channel number. If `false` or not set, channels are ordered by channel number.
keep_order_itv_channel_in_service_package	Defines the ordering of channels within service packages. If `true`, channels are listed in the service packages based on the value of `order_itv_channel_as_adding`. If `false` or not set, the channels are organized alphabetically by channel name.

Description

option_services[]

Defines the options that are available to add to service packages.

playback.ini

The settings in playback.ini configure the behaviour of playback in the MinistraPRO end-user applications.

Setting

Setting	Description
enable_playback_limit	Defines the device inactivity time (in seconds) after which playback is stopped in the MinistraPRO end-user applications. To disable the playback limit, set to `false`.

Description

enable_playback_limit

Defines the device inactivity time (in seconds) after which playback is stopped in the MinistraPRO end-user applications.

To disable the playback limit, set to false.

playback_session.ini

The settings in playback_session.ini configure the behaviour of playback sessions in the MinistraPRO end-user applications.

Setting

Setting	Description
playback_session_enabled	Defines the maximum number of playback sessions an account can stream at the same time. To enable playback session limitations, set to `true`. To disable playback session limitations, set to `false`.
playback_session_auth_lifetime	Defines the amount of time (in seconds) a session is classed as active on a device, and no additional session requests are made. The default value is 36000 seconds. Any attempt to reopen a banned session during this time period is rejected by the Flussonic server.

Description

playback_session_enabled

Defines the maximum number of playback sessions an account can stream at the same time.

To enable playback session limitations, set to true.

To disable playback session limitations, set to false.

playback_session_auth_lifetime

Defines the amount of time (in seconds) a session is classed as active on a device, and no additional session requests are made.

The default value is 36000 seconds. Any attempt to reopen a banned session during this time period is rejected by the Flussonic server.

system.ini

The settings in system.ini configure the behaviour of the MinistraPRO administrator panel.

Setting	Description
portal_url	Defines the URL path to your MinistraPRO administrator panel.
screenshots_url	Defines the URL path to uploaded screenshots, relative to your MinistraPRO administrator panel.
screenshots_path	Defines the directory used to store screenshots, relative to the MinistraPRO backend installation.
public_dir_path	Defines the directory used to store public files, relative to the MinistraPRO backend installation.
launcher_apps_path	Defines the directory for MinistraPRO end-user application launchers, relative to the MinistraPRO backend installation.
npm_registry	Defines the NPM registry of NPM packages for the Linux STB Set-top box MinistraPRO end-user applications.
display_menu_after_loading	Defines the startup behaviour of the MinistraPRO end-user application. If `true`, displays the main menu. If `false`, displays the option configured in `show_after_loading_default_app`. Information End users can change this setting manually in their MinistraPRO end-user application by selecting Settings > Interface > Home page > Startup.
show_after_loading_default_app	Defines the startup behaviour of the MinistraPRO end-user application if `display_menu_after_loading` is set to `false`. The default value is `last_channel`.
show_after_loading_apps[]	Defines the options that are available to add to `show_after_loading_default_app`. If `main_menu` displays the main menu. If `last_channel`the application displays the most recently watched channel. If `tv_guide` the application displays the TV Guide.
update_url	Defines the URL of the firmware location for Infomir Linux STB Set-top box updates.
watchdog_timeout	Defines the timeout (in seconds) of the ping requests from the MinistraPRO end-user applications to the MinistraPRO backend.
refresh_token_lifetime	Defines the lifetime (in seconds) of an authorization refresh token (OAuth2) for MinistraPRO end-user applications.
access_token_lifetime	Defines the lifetime (in seconds) of an authorization access token (OAuth2) for MinistraPRO end-user applications.
enable_device_auth_logger	If `true`, enables logging of device logins.
ministra_enable_log	If `true`, enables logging for MinistraPRO.
admin_panel_debug	If `true`, debugging information is collected for the MinistraPRO administrator panel.
admin_panel_debug_log	If `true`, a debugging log is generated for the MinistraPRO administrator panel.

tv.ini

The settings in tv.ini configure the behaviour of IPTV Internet Protocol Television features.

Setting	Description
play_in_preview_only_by_ok	Defines the preview play behaviour in the MinistraPRO end-user applications. If `true`, a channel preview in the MinistraPRO end-user applications begins playing only after the user selects OK. If `false`, a channel preview in the MinistraPRO end-user applications begins playing when it is in focus.
tv_tmp_link_ttl	Defines the lifetime (in minutes) of the temporary link for an IPTV Internet Protocol Television channel.
tv_preview_cache_server	Defines the URL for a cache server of thumbnails for IPTV Internet Protocol Television channels. Using a cache reduces the request count to the streaming server. For more information about cache URLs, refer to https://flussonic.com/doc/jpeg-thumbnails/.
tv_logo_resolution	Defines how a TV channel logo is displayed. Read more Creating IPTV channels

tv_archive.ini

The settings in tv_archive.ini configure the behaviour of DVR Digital video recording features.

Setting	Description
tv_archive_tmp_link_ttl	Defines the lifetime (in minutes) of a temporary link for an IPTV Internet Protocol Television Archive URL.
timeshift_tmp_link_ttl	Defines the lifetime (in minutes) of a temporary link for an IPTV Internet Protocol Television Timeshift URL.

vod.ini

The settings in vod.ini configure the behaviour of VOD Video on demand features.

Setting

Setting	Description
link_generation_enabled	Defines the rules used to generate VOD Video on demand URLs automatically. Rules use regular expressions. Caution You must define a separator character for rules that include multiple values. You can define this using the `multi_value_rules_separator` setting. Tip You can only provide a single stream for VOD Video on demand. The stream link is in HLS protocol which means you must provide an M3U8 link. Some Samsung Tizen (except TVs manufactured in 2018) and LG WebOS TVs need MPEG Moving picture experts group-DASH Dynamic Adaptive Streaming over HTTP formats rather than M3U8. Streaming servers can stream HLS HTTP live streaming and MPEG Moving picture experts group-DASH Dynamic Adaptive Streaming over HTTP at the same time and you can use a rule to automatically generate MPEG links for these devices. [vod] link_generation_enabled=true multi_value_rules_separator='\|' rule1[os_name]='webos\|tizen' rule1[user_agent]='/^((?!Tizen\s4\.0).)$/' rule1[link_find_pattern]='/^(.)\.m3u8(\?.*)?/' rule1[link_replace_pattern]='$1.mpd$2' link_generation_rules[]=rule1
multi_value_rules_separator	Defines the character used as a separator in rules when `link_generation_enabled` is `true`. For example: multi_value_rules_separator = \| If `link_generation_enabled` is `false`, this value is ignored. If no value is set for this then link generation rules treat each rule value as a single value.

Description

link_generation_enabled

Defines the rules used to generate VOD Video on demand URLs automatically. Rules use regular expressions.

Caution

You must define a separator character for rules that include multiple values. You can define this using the multi_value_rules_separator setting.

Tip

You can only provide a single stream for VOD Video on demand. The stream link is in HLS protocol which means you must provide an M3U8 link. Some Samsung Tizen (except TVs manufactured in 2018) and LG WebOS TVs need MPEG Moving picture experts group-DASH Dynamic Adaptive Streaming over HTTP formats rather than M3U8. Streaming servers can stream HLS HTTP live streaming and MPEG Moving picture experts group-DASH Dynamic Adaptive Streaming over HTTP at the same time and you can use a rule to automatically generate MPEG links for these devices.

[vod]
link_generation_enabled=true
multi_value_rules_separator='|'
rule1[os_name]='webos|tizen'
rule1[user_agent]='/^((?!Tizen\s4\.0).)*$/'
rule1[link_find_pattern]='/^(.*)\.m3u8(\?.*)?/'
rule1[link_replace_pattern]='$1.mpd$2'
link_generation_rules[]=rule1

multi_value_rules_separator

Defines the character used as a separator in rules when link_generation_enabled is true. For example:

multi_value_rules_separator = |

If link_generation_enabled is false, this value is ignored.

If no value is set for this then link generation rules treat each rule value as a single value.