Changes between Version 1 and Version 2 of TracIni
- Timestamp:
- Jul 17, 2018, 2:11:03 PM (6 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracIni
v1 v2 2 2 3 3 [[TracGuideToc]] 4 [[PageOutline ]]4 [[PageOutline(2-5,Contents,pullout)]] 5 5 6 Trac is configured by editingthe **`trac.ini`** file, located in the `<projectenv>/conf` directory. The `trac.ini` configuration file and its parent directory should be writable by the web server.6 Trac is configured through the **`trac.ini`** file, located in the `<projectenv>/conf` directory. The `trac.ini` configuration file and its parent directory should be writable by the web server. 7 7 8 Trac monitors the timestamp of the file to trigger a complete environment reload and flush its cacheswhen the timestamp changes. Most changes to the configuration will be reflected immediately, though changes to the `[components]` or `[logging]` sections will require restarting the web server. You may also need to restart the web server after creating a [#GlobalConfiguration global configuration] file when none was previously present.8 Trac monitors the timestamp of the file to trigger an environment reload when the timestamp changes. Most changes to the configuration will be reflected immediately, though changes to the `[components]` or `[logging]` sections will require restarting the web server. You may also need to restart the web server after creating a [#GlobalConfiguration global configuration] file when none was previously present. 9 9 10 10 == Global Configuration … … 17 17 Multiple files can be specified using a comma-separated list. 18 18 19 Note that you can also specify a global option file when creating a new project, by adding the option `--inherit=/path/to/global/trac.ini` to [TracAdmin#initenv trac-admin]'s `initenv` command. If you do not do this but nevertheless intend to use a global option file with your new environment, you will have to go through the newly generated `conf/trac.ini` file and delete the entries that will otherwise override those setin the global file.19 Note that you can also specify a global option file when creating a new project, by adding the option `--inherit=/path/to/global/trac.ini` to [TracAdmin#initenv trac-admin]'s `initenv` command. If you specify `--inherit` but nevertheless intend to use a global option file with your new environment, you will have to go through the newly generated `conf/trac.ini` file and delete the entries that will otherwise override those in the global file. 20 20 21 There are two more entries in the [[#inherit-section| [inherit] ]] section, `templates_dir` for sharing global templates and `plugins_dir`, for sharing plugins. Those entries can themselvesbe specified in the shared configuration file, and in fact, configuration files can even be chained if you specify another `[inherit] file` there.21 There are two more options in the [[#inherit-section| [inherit] ]] section, [#inherit-templates_dir-option templates_dir] for sharing global templates and [TracIni#inherit-plugins_dir-option plugins_dir], for sharing plugins. Those options can be specified in the shared configuration file, and in fact, configuration files can even be chained if you specify another `[inherit] file` there. 22 22 23 Note that the templates found in the `templates/` directory of the TracEnvironment have precedence over those found in `[inherit] templates_dir`. In turn, the latter have precedence over the installed templates, so be careful about what you put there. Notably, if you override a default template, refresh your modifications when you upgrade to a new version of Trac. The preferred way to perform TracInterfaceCustomization is stillto write a custom plugin doing an appropriate `ITemplateStreamFilter` transformation.23 Note that the templates found in the `templates/` directory of the TracEnvironment have precedence over those found in `[inherit] templates_dir`. In turn, the latter have precedence over the installed templates, so be careful about what you put there. Notably, if you override a default template, refresh your modifications when you upgrade to a new version of Trac. The preferred way to perform TracInterfaceCustomization is to write a custom plugin doing an appropriate `ITemplateStreamFilter` transformation. 24 24 25 25 == Reference for settings 26 26 27 This is a briefreference of available configuration options, and their default settings.27 This is a reference of available configuration options, and their default settings. 28 28 29 29 Documentation improvements should be discussed on the [trac:MailingList#Trac-dev trac-dev mailing list] or described in a [trac:NewTicket ticket]. Even better, [trac:TracDev/SubmittingPatches submit a patch] against the docstrings in the code. 30 {{{ #!comment 31 Please don't waste your time by editing the HTML code below, changes won't be picked up. Instead, follow the above guidance for suggesting documentation improvements. 32 }}} 30 33 31 [[TracIni]] 34 32 35 33 ---- 36 See also: Trac Guide, TracAdmin, TracEnvironment34 See also: TracAdmin, TracEnvironment