Documentation/Setup/Configuration

Documentation :: Application Configuration

There are two sets of configuration for ScriptRunner, global configuration and host configuration.

Global Configuration is managed through the ScriptRunner web interface through the menu options Application Configuration > Edit Global Configuration'.

Host Configuration is set directly in a configuration file named scriptRunner.properties. The location of this file will depend on where you have installed ScriptRunner, but will always be in the config folder of the installation path. For example, if you have installed ScriptRunner at /opt/smnt/ScriptRunner, this file will be located in /opt/smnt/ScriptRunner/config/scriptRunner.properties.

Editing Global Configuration

• From the menu, select Application Configuration > Edit Global Configuration'.

• A form containing all Global Configuration should now be shown.
  
  
  
  
  • Page Title: The page title to be used by the ScriptRunner web pages.
  • Company Name: The company name is added at the top of each page.
  • Session Timeout: The number of inactive seconds until a session times out.
  • Session Cookie Name: The name of the session cookie. This is customisable to avoid any clashes you may have from other applications running on the same host.
  • Allowed URLs: The URLs ScriptRunner will accept access on, comma separated. This is used as part of the security filter to help prevent CRSF attacks.
  • Default Page Size: The default number of records to show in a list.
  • Show Stack Traces: Enabling stack traces to show in error messages can be helpful when reporting issues, but it's recommend to leave this unticked in normal production use.
  • Enable Housekeeping: Tick to allow ScriptRunner to run daily housekeeping of its own database tables.
  • Housekeeping Batch Size: The maximum number of executed scripts housekeeping will delete in one transaction. If you are finding you get locks in your ScriptRunner database, this value should be reduced.
  • MFA Key Name: The friendly name given when scanning the MFA key. Typically it is also the name that shows against the code within a MFA application.
  • Batch Generation Time: The time each day that new batch instances are created. Format HH:MM:SS.
  • AlertCentral URL: The AlertCentral enpoint to submit alerts to. Leave empty if not using AlertCentral.
  • AlertCentral User: The AlertCentral API user. Leave empty if not using AlertCentral.
  • AlertCentral Password: The AlertCentral API password. Leave empty if not using AlertCentral.
  • OpsGenie API URL: The OpsGenie API endpoint to use. Leave empty if not using OpsGenie.
  • OpsGenie Key: The integration key to use in OpsGenie. Leave empty if not using OpsGenie.
  • Alert Emails From Address: The email address to send alert emails from.
  • Alert Emails From Name: The name to send alert emails from.
  • Alert Email Subject: The subject line given to alert emails.
  • Alert Email Recipients: The email addresses to send alert emails to (comma separated).
  • Agent Offline Warning Minutes: The number of minutes an agent doesn't check in to consider a warning.
  • Agent Offline Alert Minutes: The number of minutes an agent doesn't check in to consider an alert.

• Click to save any changes made. The new configuration will be automatically distributed to all configured controllers and agents. No restarts are required.

Editing Host Configuration (Controllers):

• Using your text editor of choice, edit open the scriptRunner.properties located in the config directory of the ScriptRunner installation.
  • com.smnt.ScriptRunner.keyFile: The location of your keys file. The keys file contains the encryption keys used by ScriptRunner to store sensitive information such as passwords.
  • com.smnt.ScriptRunner.databaseHost: The hostname of the database to use.
  • com.smnt.ScriptRunner.databaseMaximumPoolSize: The maximum number of connections that can be established to your database.
  • com.smnt.ScriptRunner.databaseName: The name of the database to use.
  • com.smnt.ScriptRunner.databseSchema: The schema to use within the database. Not applicable for all database types.
  • com.smnt.ScriptRunner.enableSetup: If set to true, this puts ScriptRunner in setup mode. Setup mode enables the /setup screen to work, but also prevents any scripts from running.
  • com.smnt.ScriptRunner.databasePort: The port number to connect to the database on.
  • com.smnt.ScriptRunner.databaseMinimumPoolSize: The initial number of connections to establish with the database.
  • com.smnt.ScriptRunner.databaseIdleConnectionTimeout: The number of seconds a database connection can be idle for before it's closed.
  • mail.smtp.host: The hostname of the SMTP server to use for sending email alerts.
  • com.smnt.ScriptRunner.databaseUser: The user name to use when connecting to the database.
  • com.smnt.ScriptRunner.databasePassword: The encrypted password to use when connecting to the database. This should be changed using the setup screen and not manually in this configuration file.
  • mail.smtp.port: The port number to use when connecting to the SMTP server.
  • com.smnt.ScriptRunner.databaseType: The type of database used. Must be either db2, mysql or postgres.
  • com.smnt.ScriptRunner.scriptLoggingDirectory: The directory to write the logs of executing scripts to before they're copied to the database. If running multiple controllers, this ideally should be a common directory shared between all controller hosts.

• Save your changes to the scriptRunner.properties file.

• Restart the controller for changes to apply.