Changes between Version 1 and Version 2 of TracIni


Ignore:
Timestamp:
Feb 25, 2025, 12:53:26 PM (4 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracIni

    v1 v2  
    1 = trac.ini Reference =
     1= The Trac Configuration File
     2
    23[[TracGuideToc]]
     4[[PageOutline(2-5,Contents,pullout)]]
    35
    4 Trac configuration is done by editing the ''trac.ini'' config file, located in {{{<projectenv>/conf/trac.ini}}}.
     6Trac 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.
    57
    6 This is a brief reference of available configuration options.
     8Trac 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.
    79
    8 == [project] ==
    9 || name   || Project name ||
    10 || descr  || Short project description ||
    11 || url    || URL to the main project website ||
    12 || icon   || URL to icon file to use as shortcut icon (favicon) ||
    13 || footer || Page footer text (right-aligned) ||
     10== Global Configuration
    1411
    15 == [trac] ==
    16 || repository_dir  || Path to local Subversion repository ||
    17 || htdocs_location || Base URL for static Trac graphics and CSS files ||
    18 || database        || Database to use for this project ||
    19 || templates_dir   || Path of Clearsilver templates ||
    20 || default_charset || Source files uses this charset ||
     12Configuration 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:
     13{{{#!ini
     14[inherit]
     15file = /path/to/global/trac.ini
     16}}}
     17Multiple files can be specified using a comma-separated list.
    2118
    22 == [logging] ==
    23 || log_type  || Logging facility to use. (none, file, stderr, syslog, winlog) ||
    24 || log_file  || If ''log_type'' is ''file'', this should be a path to the log-file ||
    25 || log_level || Level of verbosity in log (CRITICAL, ERROR, WARN, INFO, DEBUG) ||
     19Note 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.
    2620
    27 See also: TracLogging
     21There 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.
    2822
    29 == [ticket] ==
    30 || default_version   || Default version for newly created tickets ||
    31 || default_severity  || Default severity for newly created tickets ||
    32 || default_priority  || Default priority for newly created tickets ||
    33 || default_milestone || Default milestone for newly created tickets ||
    34 || default_component || Default component for newly created tickets ||
     23Note 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.
    3524
    36 See also: TracTicketsCustomFields
     25== Reference for settings
    3726
    38 == [attachment] ==
    39 || max_size || Maximum allowed file size for ticket and wiki attachments ||
     27This is a brief reference of available configuration options, and their default settings.
    4028
    41 == [notification] ==
    42 || smtp_enabled   || Enable SMTP (email) notification (true, false) ||
    43 || smtp_server    || SMTP server to use for email notifications ||
    44 || smtp_from      || Sender address to use in notification emails ||
    45 || smtp_replyto   || Reply-To address to use in notification emails ||
    46 || smtp_always_cc || Email address(es) to always send notifications to ||
    47 || always_notify_reporter || Always send notifications to any address in the ''reporter'' field ||
     29Documentation 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
     31Please 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}}}
     33[[TracIni]]
    4834
    49 See also: TracNotification
    50 
    51 == [header_logo] ==
    52 || src    || URL to image to use as header logo ||
    53 || link   || Destination URL to link to from header logo ||
    54 || alt    || ''alt'' text for header logo ||
    55 || width  || Header logo width in pixels ||
    56 || height || Header logo height in pixels ||
    57 
    58 == [mimeviewer] ==
    59 || enscript_path || Path to Enscript program ||
    60 
    61 == [timeline] ==
    62 || changeset_show_files || Number of files to show (-1 for unlimited, 0 to disable) ||
    63 
    64 == [diff] ==
    65 || tab_width || Displayed tab width in changeset diffs ||
    66 
    67 [[BR]]
    6835----
    69 See also: TracGuide, TracAdmin
     36See also: TracGuide, TracAdmin, TracEnvironment