From 891730d13b324fad916572a82f0bd610c5de9aad Mon Sep 17 00:00:00 2001 From: Rob Austein Date: Sun, 13 Sep 2020 23:06:24 +0000 Subject: Rename for conversion --- raw-wiki-dump/TracIni.trac | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 raw-wiki-dump/TracIni.trac (limited to 'raw-wiki-dump/TracIni.trac') diff --git a/raw-wiki-dump/TracIni.trac b/raw-wiki-dump/TracIni.trac new file mode 100644 index 0000000..bb752c9 --- /dev/null +++ b/raw-wiki-dump/TracIni.trac @@ -0,0 +1,36 @@ += The Trac Configuration File + +[[TracGuideToc]] +[[PageOutline(2-5,Contents,pullout)]] + +Trac is configured through the **`trac.ini`** file, located in the `/conf` directory. The `trac.ini` configuration file and its parent directory should be writable by the web server. + +Trac monitors the timestamp of the file to trigger a complete environment reload and flush its caches 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. + +== Global Configuration + +Configuration can be shared among environments using one or more global configuration files. Options in the global configuration will be merged with the environment-specific options, with local options overriding global options. The global configuration file is specified as follows: +{{{#!ini +[inherit] +file = /path/to/global/trac.ini +}}} +Multiple files can be specified using a comma-separated list. + +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 set in the global file. + +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 themselves be specified in the shared configuration file, and in fact, configuration files can even be chained if you specify another `[inherit] file` there. + +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 still to write a custom plugin doing an appropriate `ITemplateStreamFilter` transformation. + +== Reference for settings + +This is a brief reference of available configuration options, and their default settings. + +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. +{{{ #!comment +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. +}}} +[[TracIni]] + +---- +See also: TracGuide, TracAdmin, TracEnvironment -- cgit v1.2.3