TracShortcutIconPlugin

The TracShortcutIconPlugin is a useful Trac plug-in that supplies a request handler capable of handling the shortcut icon URL path, '/favicon.ico'. This path is widely used, especially by MS Internet Explorer, and the plug-in can even place (X)HTML link tags that direct standard compatible browsers to the same destination. While it can also be configured over the Trac standard config file, it is essential to place the shortcut icon in the root of the host document to be compatible with MS IE.

To enable this plugin, access or insert the following information into the config file, normally in the 'conf/trac.ini' directory:

[components] tracshortcuticon.* = enabled

[shortcuticon] handler = true linkheader = true iconpath = /local/path/on/trac/server/icon.png mimetype = image/png

[project] # Disable build-in handling of icons: icon =

To use it, insert the below settings into the trac.ini config file under the [shortcuticon] section:

handler = true|false - Enables or disables the request handler for /favicon.ico URL.

linkheader = true|false - Enables or disables the insertion of link tags that point to the icon.

iconpath=/local/path/on/trac/server/icon.png - A local OS path of the icon file on the Trac server. Keep in mind; some browsers only support MS ICO format and not PNG or GIF. The icon should be 16x16 or 32x32 pixels in size.

mimetype = image/ - Overrides the file extension's automatic detection of mime-type.

As an example, one can use:

[shortcuticon]
handler = true
linkheader = true
iconpath = /local/path/on/trac/server/icon.png
mimetype = image/png

[project]
# Disable build-in handling of icons: icon =

We highly recommend the TracShortcutIconPlugin to anyone who wishes to provide a shortcut icon to standard compatible browsers and MS IE.