Charm-managed configuration settings

The LocalSettings.php file provides basic configuration settings for MediaWiki. Though the MediaWiki charm allows for users to configure their own settings, some settings are managed by the charm itself to provide sensible defaults and to ensure proper operation and integration with other services.

Setting

Overridable

Notes

$wgAWSBucketName

Partially

This is only set when the s3-parameters relation is in use.

$wgAWSCredentials

Partially

This is only set when the s3-parameters relation is in use.

$wgAWSRegion

Partially

This is only set when the s3-parameters relation is in use.

$wgAllowSchemaUpdates

No

This is always set to false other than when the charm is performing a database update.

$wgAntivirus

Yes

Defaults to clamavd.

$wgAntivirusSetup[‘clamavd’]

Yes

Configuration for antivirus scans using clamdscan.

$wgArticlePath

Yes

$wgDBname

No

This is based on the relation data from the database relation.

$wgDBservers

No

This is based on the relation data from the database relation.

$wgDebugLogGroups

Yes

Logs written to /var/log/mediawiki/logs.log will be forwarded to Loki using the logging relation.

$wgDiff3

No

$wgEnableUploads

Partially

When the s3-parameters relation is not in use, this setting is forced to be false to prevent uploads when S3-backed object storage is not available.

$wgEnableEmail

Partially

This is set to false when the smtp relation data is incomplete or malformed.

$wgFileBackends[‘s3’][‘endpoint’]

Partially

This is only set when the s3-parameters relation is in use.

$wgFileBackends[‘s3’][‘use_path_style_endpoint’]

Partially

This is sometimes set when the s3-parameters relation is in use.

$wgHTTPProxy

No

This is based on the model configuration key juju-http-proxy.

$wgImageMagickConvertCommand

No

$wgInternalServer

No

$wgJobRunRate

Partially

This is set to 0 when the redis relation is in use, disabling web request triggered job runs. Instead, jobs are handled by an asynchronous job runner.

$wgJobTypeConf[‘default’]

Partially

This is only set when the redis relation is in use.

$wgLogos

Yes

$wgMainCacheType

No

$wgObjectCaches[‘redis’]

Partially

This is only set when the redis relation is in use.

$wgPasswordSender

Partially

This is set when the smtp relation includes a sender address.

$wgPluggableAuth_Config[‘OpenIDConnect’]

Partially

This is only set when the oauth relation is in use. The charm configures plugin, data.providerURL, data.clientID, data.clientSecret, data.scope, and data.proxy. User modifications are otherwise merged in where possible.

$wgPluggableAuth_Config[‘SimpleSAMLphp’]

Partially

This is only set when the saml relation is in use. The charm configures plugin and data.authSourceId. User modifications are otherwise merged in where possible.

$wgReadOnly

Partially

In certain situations such as when performing a database update, the charm may set this variable.

$wgResourceBasePath

Yes

$wgScriptPath

Yes

$wgSecretKey

No

This is generated by the charm. Refer to the security overview for more information.

$wgServer

Yes

The default is based on the charm configuration key url-origin but it may still be overridden.

$wgSessionCacheType

No

$wgSessionSecret

No

This is generated by the charm. Refer to the security overview for more information.

$wgSMTP

Partially

This is only set when the smtp relation is in use.

$wgSimpleSAMLphp_InstallDir

No

$wgSitename

Yes