System configuration allows for system administrators to set some preferences using the filesystem rather than the Tiki database. By providing an INI file, administrators can have a central configuration for all of their Tiki installations.
Preferences set via system configuration files cannot be set via Tiki. Preferences will not show in Tiki when they are set via system configuration, unless the "Unavailable" filter is checked.
New in Tiki11: A file db/preconfiguration.php can contain database credentials which are suggested at first Tiki installation. This allows providers of Virtual Servers to preconfigure mysql with different random passwords and usernames before the customers access the Tiki installer.
Table of contents
- Connect to other services, such as BigBlueButton, without intervention from the users
- Configure advanced settings such as Memcache
- Disable features that are not part of the support plan
- Respond to security advisories by globally disabling a feature
- provide tiki_p_admin but make some features inaccessible
- Hosting company may want to offer all-in-one hosting, but restrict usage of
- experimental features
- feature that can be used to gain server access (which is OK for most setups, but not cool for a WikiFarm)
- Consulting company wants to make simpler admin panels for a customer
- Using Tiki as an application builder (framework)
The system configuration must be enabled from the db/local.php file. Installations created from Tiki8 and beyond contain samples in the file created by default.
$system_configuration_file = '/etc/tiki.ini'; $system_configuration_identifier = 'client1';
$system_configuration_file = 'db/tiki.ini'; $system_configuration_identifier = 'client1';
If you do this example, make sure .htaccess is active so the tiki.ini can't be read.
When enabled, Tiki will read additional directives from the configuration file based on the selected identifier. The identifier is arbitrary, but can be used either to specify the site or the plan. In the configuration file, multiple configurations can be defined and inheritance can be used.
Configuration files are INI files. The following example file defines the browser title to be "Test".
preference.browsertitle = Test
Values can be quoted using double quotes. Quoted values can span several lines. Backslashes in values escape double quotes and backslashes.
[global] preference.feature_wysiwyg = "n" preference.feature_sefurl = "y" preference.helpurl = "http://support.example.com/" ; ... more settings ... [basic : global] ; ... this hierarchical block no longer works from Tiki 15 onwards preference.feature_wiki = "y" preference.feature_forums = "n" preference.feature_trackers = "n" ; ... more settings ... [pro : global] ; ... this hierarchical block no longer works from Tiki 15 onwards preference.feature_wiki = "y" ; BBB configured, but user can still toggle on/off preference.bigbluebutton_server_location = "bbb.example.com" preference.bigbluebutton_server_salt = "1234abcd1234abcd" ; ... more settings ... [client1 : pro] ; ... this hierarchical block no longer works from Tiki 15 onwards, but [client1] will preference.browsertitle = "Client #1 Intranet" preference.sender_email = firstname.lastname@example.org
In the example above, the following preferences would be set for using the identifier client1:
- feature_wysiwyg = n
- feature_sefurl = y
- helpurl = http://support.example.com/
- feature_wiki = y
- bigbluebutton_server_location = bbb.example.com
- bigbluebutton_server_salt = 1234abcd1234abcd
- browsertitle = Client #1 Intranet
- sender_email = client1 at example.com
Lines starting with semi-colons (";") are comments.
Preferences can be disabled by setting a value to each of them individually. However, this process may be long and will require maintenance with the evolutions of Tiki.
Tiki allows to set multiple rule priorities, each verification priority can allow or deny a preference. Rules can be specified at various levels, just like the preference overrides above.
[global] rules.0 = deny experimental new [pro : global] ; ... this hierarchical block no longer works from Tiki 15 onwards rules.5 = allow new rules.10 = allow feature_wysiwyg
In the previous example, sites using the pro identifier would be allowed to use new features and wysiwyg (which is tagged as experimental), including new experimental features, but still be denied old experimental features. Higher priorities are evaluated first and the lookup stops once there is a match.
A draconian provider could use something like this:
[global] rules.0 = deny all rules.1 = allow basic
The preferences need to be tagged in the definitions using the 'tags' key containing an array. Unless specified otherwise, all preferences are considered 'advanced'.
preference.flaggedrev_approval_categories = "40;41;97;231"
…the syntax to define preference.flaggedrev_approval_categories as an array of 4 elements would be…
preference.flaggedrev_approval_categories.0 = "40" preference.flaggedrev_approval_categories.1 = "41" preference.flaggedrev_approval_categories.2 = "97" preference.flaggedrev_approval_categories.3 = "231"
preference.flaggedrev_approval_categories = "40" preference.flaggedrev_approval_categories = "41" preference.flaggedrev_approval_categories = "97" preference.flaggedrev_approval_categories = "231"
When providing on-demand Virtual Machines with Tiki pre-loaded, hosting companies can provide mysql with a database and connection credentials which are different for each customer.
When accessing stage Set the Database Connection of the installer, these values will be prefilled for the customer. This is more efficient than providing them by mail or other means.
These information can obviously not be contained in db/local.php since local.php does not yet exist.
All there is to do is uncomment the appropriate lines in file db/preconfiguration.php and fill the appropriate values:
<?php // This is Tiki's preconfiguration file. // This holds values which can provide preconfiguration values in the installer, when local.php does not yet exist // Uncomment and change values as appropriate $host_tiki_preconfig='localhost'; $user_tiki_preconfig='tiki'; $pass_tiki_preconfig='password'; $dbs_tiki_preconfig='tiki_db';
Tiki will also read information about the database connection and system configuration through environment variables. These can be set through the web server's configuration.
fastcgi_pass unix:/var/run/php5-fpm.sock; fastcgi_index route.php; include fastcgi_params; fastcgi_param MYSQLCONNSTR_Tiki "Database=client1;Data Source=localhost;User Id=client1;Password=secret"; fastcgi_param TIKI_INI_FILE "/etc/tiki.ini"; fastcgi_param TIKI_INI_IDENTIFIER "client1";