Outdated documentation

You are looking at the documentation for an older release. For the latest information, please see current release documentation.

WebApp

WebApp::DefaultRedirect

Defines the default redirect. Use ‘/external’ for the external or ‘/otrs/index.pl’ for the agent interface, or an absolute URL if you want to redirect to an external site.

This setting can not be deactivated.

Default value:

/external

WebApp::SSO::RemoteUserSecret

Shared secret for SSO. Reverse proxies must pass a REMOTE_USER and a REMOTE_USER_SECRET header with the value of this setting, only then REMOTE_USER will be accepted and usable for HTTPBasicAuth.

This setting is not active by default.

Default value:

''

WebApp::Server::AdditionalOrigins

Defines additional origins for production web server content security policy headers. You can specify new entries for any supported rule, please use the name of the rule as the key.

This setting can not be deactivated.

Default value:

---
connect-src:
- ''
font-src:
- ''
frame-src:
- ''
img-src:
- ''
script-src:
- ''
style-src:
- ''

WebApp::Server::AutomaticReloadFile

Defines the path to a file that should signal the need to reload the web server. It will only work correctly with the default value; change this only if you intend to use this file for other purposes (like triggering a cluster-wide web server reload - in this case you have to handle the actual reloads on your own).

This setting can not be deactivated.

Default value:

<OTRS_CONFIG_Home>/var/run/otrs.WebServer.pid.needs-reload

WebApp::Server::TriggerAutomaticReloads

If active, certain operations like package changes and external interface setting changes will trigger a hot reload of the production web server on the current node. This can be turned off if you plan to restart the web server manually or if another mechanism is used to perform the needed restarts.

This setting can not be deactivated.

Default value:

1

WebAppAPICustomer

WebApp::API::Customer::DefaultAgentName

Defines the default agent name in the ticket zoom view of the external interface.

This setting can not be deactivated.

Default value:

Support Agent

WebApp::API::Customer::DisplayNoteFrom

Defines the displayed style of the From field in notes that are visible for customers. A default agent name can be defined in WebApp::API::Customer::DefaultAgentName setting.

This setting can not be deactivated.

Default value:

FromField

WebAppAPICustomerAccount

WebApp::API::Customer::Account::EmailBlacklist

If active, none of the regular expressions may match the user’s email address to allow registration.

This setting is not active by default.

Default value:

---
- \@your\.domain\.example$

WebApp::API::Customer::Account::EmailWhitelist

If active, one of the regular expressions has to match the user’s email address to allow registration.

This setting is not active by default.

Default value:

---
- \@your\.domain\.example$

WebApp::API::Customer::Account::Recover

Enables customers to recover their own accounts via the external interface.

This setting can not be deactivated.

Default value:

1

WebApp::API::Customer::Account::RecoverBody

Defines the body for an email with password recovery instructions for customer users, containing a link to request a new password.

This setting can not be deactivated.

Default value:

Hi <OTRS_USERFIRSTNAME>,

You or someone impersonating you has requested to change your OTRS password.

If you want to do this, click on this link. You will receive another email containing the password.

<OTRS_CONFIG_HttpType>://<OTRS_CONFIG_FQDN><OTRS_CONFIG_Frontend::PrefixPath>/external/account/reset/<OTRS_TOKEN>

If you did not request a new password, please ignore this email.

WebApp::API::Customer::Account::RecoverSubject

Defines the subject for an email with password recovery instructions for customer users.

This setting can not be deactivated.

Default value:

New OTRS password request

WebApp::API::Customer::Account::Register

Enables customers to create their own accounts via the external interface.

This setting can not be deactivated.

Default value:

1

WebApp::API::Customer::Account::RegisterBody

Defines the body text for notification mails sent to customers, about new account.

This setting can not be deactivated.

Default value:

Hi <OTRS_USERFIRSTNAME>,

You or someone impersonating you has created a new OTRS account for you.

Full name: <OTRS_USERFIRSTNAME> <OTRS_USERLASTNAME>
User name: <OTRS_USERLOGIN>
Password: <OTRS_USERPASSWORD>

You can log in via the following URL. We encourage you to change your password in the user preferences after logging in.

<OTRS_CONFIG_HttpType>://<OTRS_CONFIG_FQDN><OTRS_CONFIG_Frontend::PrefixPath>/external

WebApp::API::Customer::Account::RegisterSubject

Defines the subject for notification mails sent to customers, about new account.

This setting can not be deactivated.

Default value:

New OTRS Account!

WebApp::API::Customer::Account::ResetBody

Defines the body for an email with new password for customer users.

This setting can not be deactivated.

Default value:

Hi <OTRS_USERFIRSTNAME>,

Your new password is: <OTRS_NEWPW>

You can log in via the following URL. We encourage you to change your password in the user preferences after logging in.

<OTRS_CONFIG_HttpType>://<OTRS_CONFIG_FQDN><OTRS_CONFIG_Frontend::PrefixPath>/external

WebApp::API::Customer::Account::ResetSubject

Defines the subject for an email with new password for customer users.

This setting can not be deactivated.

Default value:

New OTRS password

WebAppAPIClient

WebApp::APIClient###CloseTimeout

Defines timeout in milliseconds for the closing of a WebSocket connection in the frontend applications. Value of ‘0’ will disable the timeout. Please note that changes to this setting require a restart of the web server (bin/otrs.WebServer.pl –deploy-assets).

This setting can not be deactivated.

Default value:

0

WebApp::APIClient###MaxReconnectionAttempts

Defines maximum number of attempts before giving up trying to re-establish a WebSocket connection in the frontend applications. Please note that changes to this setting require a restart of the web server (bin/otrs.WebServer.pl –deploy-assets).

This setting can not be deactivated.

Default value:

10

WebApp::APIClient###MaxReconnectionDelay

Defines maximum delay in milliseconds when trying to re-establish a WebSocket connection in the frontend applications. Please note that changes to this setting require a restart of the web server (bin/otrs.WebServer.pl –deploy-assets).

This setting can not be deactivated.

Default value:

10000

WebApp::APIClient###OpenTimeout

Defines timeout in milliseconds for the opening of a WebSocket connection in the frontend applications. Value of ‘0’ will disable the timeout. Please note that changes to this setting require a restart of the web server (bin/otrs.WebServer.pl –deploy-assets).

This setting can not be deactivated.

Default value:

0

WebApp::APIClient###ReconnectionDelayIncrement

Defines increment delay in milliseconds with every reconnection attempt of a WebSocket connection in the frontend applications. Please note that changes to this setting require a restart of the web server (bin/otrs.WebServer.pl –deploy-assets).

This setting can not be deactivated.

Default value:

1000

WebApp::APIClient###ResponseTimeout

Defines timeout in milliseconds for the responses of WebSocket requests in the frontend applications. Value of ‘0’ will disable the timeout. Please note that changes to this setting require a restart of the web server (bin/otrs.WebServer.pl –deploy-assets).

This setting can not be deactivated.

Default value:

30000

WebApp::APIClient###WebSocketUpgrade

Defines if the primary API client communication protocol should be upgraded to WebSocket, where possible. Please note that changes to this setting require a restart of the web server (bin/otrs.WebServer.pl –deploy-assets).

This setting can not be deactivated.

Default value:

1