SiteConfig - Revision history

Jbrandt: /* Plugins */

2025-06-25T12:26:40Z

Plugins

← Older revision		Revision as of 08:26, 25 June 2025
Line 20:		Line 20:
	= Plugins =		= Plugins =

	Enable extensions, also called plugins, with a `Plugin` line.		Enable extensions, also called plugins, with a <code>Plugin</code> line.

	Plugin('RT::Extension::ResetPassword');		Plugin('RT::Extension::ResetPassword');
Line 31:		Line 31:
	Set(@Plugins, qw(Extension::QuickDelete));		Set(@Plugins, qw(Extension::QuickDelete));

	When upgrading, convert to the `Plugin` form shown above.		When upgrading, convert to the <code>Plugin</code> form shown above.

	==Custom Statuses==		==Custom Statuses==

Jbrandt: /* Plugins and Extensions */

2025-06-25T12:24:53Z

Plugins and Extensions

← Older revision		Revision as of 08:24, 25 June 2025
Line 20:		Line 20:
	= Plugins =		= Plugins =

	~~Set(@Plugins~~, ~~qw(RT::Extension::ResetPassword RT::Extension::MandatorySubject));~~		Enable extensions, also called plugins, with a `Plugin` line.

	~~The following is an invalid way to define extensions as each declaration will override the previous~~:		Plugin('RT::Extension::ResetPassword');
			Plugin('RT::Extension::Helpdesk');

	~~Set(@Plugins, qw(Extension::QuickDelete));~~		Use one line for each plugin.
	~~Set(@Plugins, qw(RT::Extension::ResetPassword));~~
	~~Set(@Plugins, qw(RT::Extension::MandatorySubject));~~

	~~Note there are only spaces between the (full) extension name and any spaces are allowed, so the following is also valid~~:		RT before version 4 used syntax like this:

	Set(@Plugins, qw(		Set(@Plugins, qw(Extension::QuickDelete));
	~~RT::Extension::ResetPassword~~
	~~RT::Extension::MandatorySubject~~
	~~RT::~~Extension::QuickDelete
	));

	~~==Custom Statuses:==~~		When upgrading, convert to the `Plugin` form shown above.

	~~RT 4 and after: [http://bestpractical.com/rt/docs/4.0/customizing/lifecycles.html Lifecycles]~~		==Custom Statuses==

	RT 3.8 and prior: [[CustomStatuses]]		RT 4 and after use the [http://bestpractical.com/rt/docs/latest/customizing/lifecycles.html Lifecycles] system to define custom statuses, workflows, actions, and more.

			RT 3.8 and prior used configuration values to define [[CustomStatuses]].

Admin: 6 revisions imported

2016-04-06T20:37:46Z

6 revisions imported

New page

= What It Is =

The '''SiteConfig''' file lives in <code>${RTHOME}/etc/RT_SiteConfig.pm</code>. Its purpose is to provide you a place to override config settings in <code>${RTHOME}/etc/RT_Config.pm</code> as well as add new config variables as provided by various user [[Contributions]] or for your own purposes.

All of the available configuration options are documented in RT_Config.pm and also [http://bestpractical.com/rt/docs/latest/RT_Config.html available on the web].

You set a config variable like so:

Set($Foo, "Value of Foo");
Set($Bar, 1);
Set(@Baz, "array", "of", "values");
Set(%Zot, "hash" => "of", "keyed" => "values");

You access them like this in RT 3.8 and newer:

RT->Config->Get('Foo') # "Value of option Foo"
RT->Config->Get('Bar') # 1
RT->Config->Get('Baz')->[0] # get option Baz that is array reference and access first element

= Plugins =

Set(@Plugins, qw(RT::Extension::ResetPassword RT::Extension::MandatorySubject));

The following is an invalid way to define extensions as each declaration will override the previous:

Set(@Plugins, qw(Extension::QuickDelete));
Set(@Plugins, qw(RT::Extension::ResetPassword));
Set(@Plugins, qw(RT::Extension::MandatorySubject));

Note there are only spaces between the (full) extension name and any spaces are allowed, so the following is also valid:

Set(@Plugins, qw(
RT::Extension::ResetPassword
RT::Extension::MandatorySubject
RT::Extension::QuickDelete
));

==Custom Statuses:==

RT 4 and after: [http://bestpractical.com/rt/docs/4.0/customizing/lifecycles.html Lifecycles]

RT 3.8 and prior: [[CustomStatuses]]

130.235.93.68 at 10:10, 1 February 2013

2013-02-01T10:10:00Z

← Older revision		Revision as of 06:10, 1 February 2013
Line 82:		Line 82:
	= To Be Documented =		= To Be Documented =

	Hey, ~~common~~! ~~Make~~ a step and document this.		Hey, come on! Make a step and document this.

	$RT::WebExternalAuto (autohandler)		$RT::WebExternalAuto (autohandler)

80.95.70.19 at 12:19, 26 July 2011

2011-07-26T12:19:37Z

← Older revision		Revision as of 08:19, 26 July 2011
Line 74:		Line 74:
	rtname lets you set name of your RT instance. See also [[EmailInterface]] and [[RenameInstance]].		rtname lets you set name of your RT instance. See also [[EmailInterface]] and [[RenameInstance]].

	Custom Statuses:		==Custom Statuses:==


	RT 3.8 and prior: [[CustomStatuses]]		RT 3.8 and prior: [[CustomStatuses]]

80.95.70.19 at 12:18, 26 July 2011

2011-07-26T12:18:22Z

New page

= What It Is =

The '''Site''''''Config''' file lives in ${RTHOME}/etc/RT_SiteConfig.pm. Its purpose is to provide you a place to override config settings in ${RTHOME}/etc/RT_Config.pm as well as add new config variables as provided by various user [[Contributions]] or for your own purposes. You set a config variable like so:

Set($Foo, "Value of Foo");
Set($Bar, 1);
Set(@Baz, "array", "of", "values"); # works properly in RT 3.8 only
Set(%Zot, "hash" => "of", "keyed" => "values"); # works properly in RT 3.8 only

The following works in earlier versions of RT, but above is recommended for new things:

Set($Baz, ["reference", "to", "array", "of", "values"]);
Set($Zot, {"reference" => "to", "hash" => "of", "keyed" => "values"});

You access them like this in RT 3.8 and newer:

RT->Config->Get('Foo') # "Value of option Foo"
RT->Config->Get('Bar') # 1
RT->Config->Get('Baz')->[0] # get option Baz that is array reference and access first element

For backwards compatibility with RT 3.6 you can use the following syntax:

$RT::Foo # "Value of Foo"
$RT::Bar # 1
$RT::Baz->[0] # "array"
$RT::Zot->{"keyed"} # "values"

= Plugins =

Set(@Plugins, qw(RT::Extension::ResetPassword RT::Extension::MandatorySubject));

The following is an invalid way to define extensions as each declaration will override the previous:

Set(@Plugins, qw(Extension::QuickDelete));
Set(@Plugins, qw(RT::Extension::ResetPassword));
Set(@Plugins, qw(RT::Extension::MandatorySubject));

Note there are only spaces between the (full) extension name and any spaces are allowed, so the following is also valid:

Set(@Plugins, qw(
RT::Extension::ResetPassword
RT::Extension::MandatorySubject
RT::Extension::QuickDelete
));

= Email interface =

Options related to an email handling are described on [[EmailInterface]] page.

= Logging =

Configuring RT's, mysql's, apache's logs is described on [[LogsConfig]] page.

= Other config variables =

Here's an alphabetical list of some of the variables used by RT and what they do; please feel free to add more or document better.

$'''Auto''''''Create''' (hash reference)

Attributes for autocreated accounts; used only in share/html/autohandler when $RT::WebExternalAuth and $RT::WebExternalAuto are set.

Set($AutoCreate, {Privileged => 1, WorkPhone => 'x900'});

Note: "Privileged => 1" does not appear to work at present. All auto-created users are unprivileged, and therefore do not show up in the "Configuration -> Users" list, and obviously do not have privileged status in the system either.

This issue has been reported: http://issues.bestpractical.com/Ticket/Display.html?id=14472

$'''Min''''''Password''''''Length''' (scalar)

MinPasswordLength lets you set a minimum password length for your users.

$'''rtname''' (scalar)

rtname lets you set name of your RT instance. See also [[EmailInterface]] and [[RenameInstance]].

Custom Statuses:

RT 3.8 and prior: [[CustomStatuses]]

RT4 and after: [[CustomStatusesInRt4]]

= To Be Documented =

Hey, common! Make a step and document this.

$RT::WebExternalAuto (autohandler)
$RT::WebExternalGecos (autohandler)
$RT::WebFallbackToInternalAuth (autohandler)
$RT::WebExternalOnly (autohandler)
$RT::WebExternalAuth (autohandler)
$RT::LdapServer (WebExternalAuth Parameter)
$RT::LdapUser (WebExternalAuth Parameter)
$RT::LdapPass (WebExternalAuth Parameter)
$RT::LdapBase (WebExternalAuth Parameter)
$RT::LdapUidAttr (WebExternalAuth Parameter)
$RT::LdapFilter (WebExternalAuth Parameter)
$RT::LdapTLS (WebExternalAuth Parameter)
$RT::LdapGroup (WebExternalAuth Parameter)
$RT::LdapGroupAttribute (WebExternalAuth Parameter)
$RT::LdapSSLVersion (WebExternalAuth Parameter)