The following tables describe all the properties on the Gateway Setttings.
Is a unique name for this Ignition installation. It is used to distinguish this server from others on the network when working with multiple Ignition installations.
Whether or not alarm properties such as acknowledgment should persist across Gateway restarts.
|Homepage Redirect URL||The URL this gateway will redirect to when http://ip:port/ is visited. Can either be a relative path (e.g., /web/home), or fully qualified (e.g., https://inductiveautomation.com).|
Gateway Scripting Project
|The Gateway Scripting Project is a Project in which Gateway-scoped scripts with no project affiliation can access user script libraries.|
Enable Tag Reference Tracker Store
Enables the storing of Tag Reference entries to a database on the local Gateway for analysis in a Designer for third party modules. Default is true.
The maximum amount of memory that the Designer has access to.
Disables the Direct3D rendering pipeline launched clients. Direct3D can cause performance problems with XOR painting. (affects clients on Windows only)
Disables the DirectDraw system for launched clients. Can be useful for some video cards that don't support DirectDraw well. (affects clients on Windows only)
|Use Condensed Font|
Designers and Vision Clients will use a condensed version of the "Dialog" font for better compatibility with pre-8.0 Vision project design. (affects clients on Windows and Linux only). Defaults to false.
Local Client Fallback Settings
Ignition provides a Local Vision Client Fallback mechanism that lets you use a Gateway running on the local machine. If the Gateway is lost, the Client can automatically retarget to a project that you specify in the local in the local Gateway.
Local Vision Client Fallback
Enable Local Fallback
Enables a client to fall back to a project in a local Gateway if communication is lost to the central Gateway. Note that port 6501 must be open on the local machine.
Seconds Before Failover
The number of seconds to wait before switching to the local Gateway project after communication loss.
The local project to use during fallback.
The Scheduled Backup Settings control the Gateway's scheduled backup system. This system is capable of automatically making a Gateway backup and storing it to the specified location, which can be a network path. When you enable this system, you must specify a destination folder. This can be a local folder, for example
/var/backups , or a network path such as
The scheduled backup system works on a schedule that is specified using UNIX Crontab syntax. See the Crontab Formatting Reference page for more details.
Scheduled Backup Settings
|Enable Scheduled Backups|
Enables the scheduled backup system which automatically makes backups at a scheduled time.
A path to a folder in which to put the scheduled backups.
A UNIX 'crontab' format scheduling string representing when to make the backups.
The number of backups to keep in the backup folder.
The filename pattern used for creating scheduled and manually downloaded Gateway backups. Default pattern is
Automatic Thread Dump Settings
When enabled, Ignition will conduct automatic thread dumps at the specified interval when above the target CPU Usage Threshold. If the threshold is met or exceeded, a timestamped thread dump will be saved to the logs folder. When the number of thread dumps in the logs folder exceeds the Retention Count, old files will be automatically removed. The default sample rate (60 seconds) can be overridden by adding an additional parameter to the Ignition configuration file.
Automatic Thread Dump Settings
|Enable Automatic Thread Dumps|
Enables automated thread dump generation when CPU utilization exceeds the threshold below.
|Thread Dump Capture Interval|
Number of seconds between thread dumps when utilization threshold+duration is met.
|CPU Usage Threshold|
CPU Usage Threshold (%) that when exceeded for a given duration (below) will trigger a thread dump capture.
|CPU Usage Exceedance Duration|
Duration (seconds) during CPU Usage Threshold exceedance to delay a thread dump capture.
|Retention Count||The number of thread dumps to keep in the logs folder.|
When an error occurs in the Client or Designer, the users can click a link on the Details tab to report the error via email.
These settings define how the errors are reported.
When not blank, user-reported errors are emailed using this SMTP server.
The email address(es) that will receive the error notification. Separate multiple email addresses with a semicolon (;)
The email address that the error notification is from.
A username for the SMTP server, if required.
Check this box to change the existing password.
A password for the SMTP server, if required.
Re-type password for verification.
These properties allow the Gateway to broadcast information about itself via multicast UDP packets. This allows the Gateway to be discoverable by any components that are also listening to the same multicast address. For example, native client launchers listen on a multicast address to provide a list of available Gateways on the network. Verify that the send ports and receive ports are open on the Gateway machine in order to be able to broadcast multicast message.
Allows this Gateway to be discoverable on your local network.
|Multicast IP Address|
Gateway messages are broadcast on this address.
This port must be open on this machine to send multicast messages.
This port must be open on any machine that will receive multicast messages.
The interval in milliseconds at which multicast messages will be sent.