Skip to main content
Version: 8.1

Gateway Settings

Gateway Settings Property Reference

After you launch the Gateway, you can define the high-level settings that apply to the entire Gateway by going to the Config > Gateway Settings on the Gateway Webpage. From this page, you can use the default values or define a new setting. The Gateway is at the heart of the Ignition software. It runs as a web server and you can access it through a web browser. Once running, you can get various status information about the Gateway and access important functions.

Gateway Webpage - Gateway Settings Section

New in 8.1.0
The Gateway Settings Properties were updated significantly for release 8.1.0. Many security related settings have been moved to Gateway General Security Settings.

The following tables describe all the properties on the Gateway Settings.

Gateway Settings

System NameIs 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. CAUTION: It is not recommended to change the Gateway's System Name after initial Gateway setup. Renaming your Gateway may break critical dependencies, affect data collection, and halt production. To see a list of features dependent on the Gateway name, click here.
Homepage Redirect URLThe 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.,
Gateway Scripting ProjectThe 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
New in 8.1.34
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.

Launch Settings

Designer MemoryThe maximum amount of memory that the Designer has access to.
Disable Direct3DDisables the Direct3D rendering pipeline launched clients. Direct3D can cause performance problems with XOR painting. (affects clients on Windows only)
Disable DirectDrawDisables 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
New in 8.1.4
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

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 Client Fallback Settings

Enable Local FallbackEnables 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 FailoverThe number of seconds to wait before switching to the local Gateway project after communication loss.
Fallback ProjectThe local project to use during fallback.

Scheduled Backups

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 C:\backups or /var/backups, or a network path such as \\fileserver\backups.

Scheduled Backup Settings

Enable Scheduled BackupsEnables the scheduled backup system which automatically makes backups at a scheduled time.
Backup FolderA path to a folder in which to put the scheduled backups.
Backup ScheduleA UNIX 'crontab' format scheduling string representing when to make the backups. See the Crontab Formatting Reference page for more details.
Retention CountThe number of backups to keep in the backup folder.
Filename Pattern
New in 8.1.4
The filename pattern used for creating scheduled and manually downloaded Gateway backups. Default pattern is ${gatewayName}_Ignition-backup-${edition}${timestamp}.gwbk. There are a few possible placeholder pattern values:
  • ${os} - The operating system the Gateway is installed on.
  • ${version} - The Ignition Gateway version.
  • ${gatewayName} - The System Name of your Gateway.
  • ${edition} - The Ignition edition you are using (for example, edge). Standard Ignition versions will be blank.
  • ${timestamp} - The current date and time at which the backup initializes.

Automatic Thread Dump

New in 8.1.13

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 DumpsEnables automated thread dump generation when CPU utilization exceeds the threshold below.
Thread Dump Capture IntervalNumber of seconds between thread dumps when utilization threshold+duration is met.
CPU Usage ThresholdCPU Usage Threshold (%) that when exceeded for a given duration (below) will trigger a thread dump capture.
CPU Usage Exceedance DurationDuration (seconds) during CPU Usage Threshold exceedance to delay a thread dump capture.
Retention CountThe number of thread dumps to keep in the logs folder.

Error Reporting

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.

Message TabDetails Tab
Error Box Message TabError Box Details Tab

These settings define how the errors are reported.

Error Reporting Settings

SMTP ServerWhen not blank, user-reported errors are emailed using this SMTP server.
To AddressThe email address(es) that will receive the error notification. Separate multiple email addresses with a semicolon (;)
From AddressThe email address that the error notification is from.
SMTP UsernameA username for the SMTP server, if required.
Change Password?Check this box to change the existing password.
PasswordA password for the SMTP server, if required.
PasswordRe-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.

Multicast Settings

Enable MulticastAllows this Gateway to be discoverable on your local network.
Multicast IP AddressGateway messages are broadcast on this address.
Send PortThis port must be open on this machine to send multicast messages.
Receive PortThis port must be open on any machine that will receive multicast messages.
Message IntervalThe interval in milliseconds at which multicast messages will be sent.