CustomizingWithLocalDir - Revision history

Bkembree: Add directions for finding the local directory.

2024-07-10T14:38:10Z

Add directions for finding the local directory.

← Older revision		Revision as of 10:38, 10 July 2024
Line 2:		Line 2:

	Under the RT installation tree, there is a directory called 'local'. You can place files under this directory to override most files in the RT installation without touching the original. Also, this allows you to quickly retrace what has been customized when you upgrade RT. This method works for both Mason components which RT puts under share/html/ and Perl library files which RT puts in lib/.		Under the RT installation tree, there is a directory called 'local'. You can place files under this directory to override most files in the RT installation without touching the original. Also, this allows you to quickly retrace what has been customized when you upgrade RT. This method works for both Mason components which RT puts under share/html/ and Perl library files which RT puts in lib/.

			= Finding the local directory =

			To find the full path to the local directory go to Admin -> Tools -> System Configuration and search for <code>RT::MasonLocalComponentRoot</code>.

	= Example =		= Example =

Admin: 2 revisions imported

2016-04-06T20:03:37Z

2 revisions imported

New page

= Introduction =

Under the RT installation tree, there is a directory called 'local'. You can place files under this directory to override most files in the RT installation without touching the original. Also, this allows you to quickly retrace what has been customized when you upgrade RT. This method works for both Mason components which RT puts under share/html/ and Perl library files which RT puts in lib/.

= Example =

Suppose you don't like default RT header. The Mason component for this is share/html/Elements/Header. To customize it, simply copy it to local/html/Elements/Header and apply your changes to that file. When you restart your web server, your new Header component will be loaded. You '''must restart''' your webserver and [http://wiki.bestpractical.com/view/CleanMasonCache clear the Mason object cache] (or have [[DevelMode]] enabled) to for the changes to take effect.

= Important thing to know =

You '''must''' remember that if you put a <code>local/lib/Xxx.pm</code> file under the local directory then RT will never try to load <code>lib/Xxx.pm</code> from the analogous base directory. Files under the local/ directory completely "replace" files from base directories logically.

This can be changed for Mason components. If you want to modify a component, but only use it sometimes and not others, see [[BypassLocalComponent]].

= Overriding translation files =

Also note that I18N overrides work differently; they go in <code>local/po</code> instead of <code>local/lib/RT/I18N</code>.

= Alternatives to the local dir =

In many cases you can instead use [[CustomizingWithCallbacks]] to customize the web GUI.

For customizing Perl libraries you should also look at [[CustomizingWithOverlays]]. Overlays can be put under the local/lib/ tree.

[[CustomizingWithPatches]] may be preferred in some cases.

= Other ways to customize RT =

[[Customizing]]

BillCole at 23:46, 19 November 2010

2010-11-19T23:46:57Z

New page