Allow any plugin system setting to be overwritten in the config file by tsteur · Pull Request #9521 · matomo-org/matomo · GitHub
Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow any plugin system setting to be overwritten in the config file #9521

Merged
merged 1 commit into from
Jan 17, 2016

Conversation

tsteur
Copy link
Member

@tsteur tsteur commented Jan 14, 2016

fixes matomo-org/plugin-QueuedTracking#21

Plugin settings are configured in the UI under "Administration => Plugin Settings". However, sometimes one might want to define a different config value on different servers (for example in a load balanced environment) see for example matomo-org/plugin-QueuedTracking#21

For example one might want to enabled QueuedTracking on one server, but disable it on another and use log importer instead on the other server.

To overwrite a plugin system setting specify the plugin name and plugin setting name in the config/config.ini.php file like this:

[PluginName]
pluginSettingName = pluginSettingValue

Actual example for plugin QueuedTracking:

[QueuedTracking]
processDuringTrackingRequest = 0
queueEnabled = 1

Important:

  • Setting names are case sensitive
  • Once a plugin setting is configured in the config file, the value can be no longer changed in the UI since we cannot modify the config file eg in a load balanced environment etc. A side effect of this is to being able to hide specific system settings for users by specifying them in the config
  • In another pull request we will offer the possibility to see a all configured config values, and also to see all available plugin names + plugin system setting names that can be configured including documentation

@sgiehl
Copy link
Member

sgiehl commented Jan 17, 2016

LGTM :shipit:

tsteur added a commit that referenced this pull request Jan 17, 2016
Allow any plugin system setting to be overwritten in the config file
@tsteur tsteur merged commit 4057467 into master Jan 17, 2016
@tsteur tsteur deleted the plugin_settings_override branch January 17, 2016 22:53
@mattab mattab added Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc. Major Indicates the severity or impact or benefit of an issue is much higher than normal but not critical. c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. labels Jan 29, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc. Major Indicates the severity or impact or benefit of an issue is much higher than normal but not critical. Needs Review PRs that need a code review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants