Skip to main content

Configuration files

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

info

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

Read about mandatory configuration files

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 Ministra Pro to work correctly:

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

Summary of configuration files

File nameDescription

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 channels and VOD.

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 about billing.ini settings

l18n.ini

The settings in l18n.ini define localisation behaviour, including:

  • Timezones
  • Primary audio and subtitle language
  • Secondary audio and subtitle language
  • Languages available to choose as the default for audio and subtitles in Ministra Pro end-user applications
warning

The time zones in the l18n.ini file, the streaming server, and the MySQL database used for Ministra Pro should be the same. If the timezones are not the same then DVR playback may be affected, as well as authorization.

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.

info

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 about to enable the collection of metrics

playback.ini

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

Read about playback.ini settings

playback_session.ini

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

Read about playback_session.ini settings

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: <Ministra Pro backend>/docs/billing-api/

For example: http://example_domain.name/docs/billing-api/

statistic.ini

The settings in statistic.ini control the collection of playback statistics for IPTV channels from the Ministra Pro end-user applications.

Read about usage monitoring

system.ini

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

Read about system.ini settings

tv.ini

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

Read about tv.ini settings

tv_archive.ini

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

Read about tv_archive.ini settings

vod.ini

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

Read about vod.ini settings

otp_auth_phone.ini

The settings in otp_auth_phone.ini control the behaviour of one-time passwords (OTPs) authorization.

Read about configuring OTP authorization

screen.ini

The settings in screen.ini configure the connection to the Elasticsearch database, and for naming screens and sections.

Read about creating screens

Read about creating sections

billing.ini settings

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

SettingDescription
option_services[]Defines the options that are available to add to service packages.
Read about creating service packages
order_itv_channel_as_addingDefines 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_packageDefines 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.

playback.ini settings

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

SettingDescription
enable_playback_limitDefines the device inactivity time (in seconds) after which playback is stopped in the Ministra Pro end-user applications.
To disable the playback limit, set to false.

playback_session.ini settings

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

SettingDescription
playback_session_enabledDefines 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_lifetimeDefines 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 settings

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

SettingDescription

portal_url

Defines the URL path to your Ministra Pro administrator panel.

screenshots_url

Defines the URL path to uploaded screenshots, relative to your Ministra Pro administrator panel.

screenshots_path

Defines the directory used to store screenshots, relative to the Ministra Pro backend installation.

public_dir_path

Defines the directory used to store public files, relative to the Ministra Pro backend installation.

launcher_apps_path

Defines the directory for Ministra Pro end-user application launchers, relative to the Ministra Pro backend installation.

npm_registry

Defines the NPM registry of NPM packages for the Linux STB Ministra Pro end-user applications.

display_menu_after_loading

Defines the startup behaviour of the Ministra Pro end-user application.

  • If true, displays the main menu.
  • If false, displays the option configured in show_after_loading_default_app.
info

End users can change this setting manually in their Ministra Pro end-user application by selecting Settings > Interface > Home page > Startup.

show_after_loading_default_app

Defines the startup behaviour of the Ministra Pro 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 updates.

watchdog_timeout

Defines the timeout (in seconds) of the ping requests from the Ministra Pro end-user applications to the Ministra Pro backend.

refresh_token_lifetime

Defines the lifetime (in seconds) of an authorization refresh token (OAuth2) for Ministra Pro end-user applications.

access_token_lifetime

Defines the lifetime (in seconds) of an authorization access token (OAuth2) for Ministra Pro end-user applications.

enable_device_auth_logger

If true, enables logging of device logins.

ministra_enable_log

If true, enables logging for Ministra Pro.

admin_panel_debug

If true, debugging information is collected for the Ministra Pro administrator panel.

admin_panel_debug_log

If true, a debugging log is generated for the Ministra Pro administrator panel.

events_messages_ttl

Defines the time period during which events messages are stored in the Ministra Pro administrator panel database.

The default value is 14 days.

tv.ini settings

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

SettingDescription
play_in_preview_only_by_okDefines the preview play behaviour in the Ministra Pro end-user applications.
If true, a channel preview in the Ministra Pro end-user applications begins playing only after the user selects OK.
If false, a channel preview in the Ministra Pro end-user applications begins playing when it is in focus.
tv_tmp_link_ttlDefines the lifetime (in minutes) of the temporary link for an IPTV channel.
tv_preview_cache_serverDefines the URL for a cache server of thumbnails for IPTV 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_resolutionDefines how a TV channel logo is displayed.
Read about creating IPTV channels
enable_tv_channels_list_updated_eventDefines what happens when the TV channels included in a tariff plan are updated.
If true, an event is triggered that updates the TV Channels list.

tv_archive.ini settings

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

SettingDescription
tv_archive_tmp_link_ttlDefines the lifetime (in minutes) of a temporary link for an IPTV Archive URL.
timeshift_tmp_link_ttlDefines the lifetime (in minutes) of a temporary link for an IPTV Timeshift URL.

vod.ini settings

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

SettingDescription

link_generation_enabled

Defines the rules used to generate VOD 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. 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-DASH formats rather than M3U8. Streaming servers can stream HLS and MPEG-DASH 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.