This is documentation for Ignition 8.3 Beta 🚧. Documentation for this version is still in progress and any unreleased features described are subject to change.
For documentation on the latest stable release, see the latest version (8.1).
This page is a reference sheet for Ignition's data folder structure. Ignition uses this data folder structure for many elements of the software, including the Gateway, projects, modules, configuration changes, and more.
The config child folder within the data directory also includes a migration log Markdown file. This migration log details the various tables that are migrated over when upgrading from 8.1 to 8.3, including metrics such as the migration duration time, migration timestamp, migration strategies, and any remaining tables that have not been moved over.
Certain symbols and characters are not allowed when renaming Ignition Gateway files, as they are either illegal characters or reserved for Ignition or the operating system. Follow the guidelines below when naming files:
You can use any unicode letter, number, punctuation mark, or symbol as the first character, except for symbols that typically cause naming problems.
Some symbols are not allowed as the first or last character, but can be used for characters in between.
File naming follows canonical equivalence.
Long File Path Considerations
Some operating systems and programs have 255 character limitations when copying over file paths or creating backups. See the Working with Long File Paths page for more information on how your system may be impacted.
The following characters, with some exceptions, are not allowed to be used when naming files:
Platform files that should be identical on the redundant master and backup. These files provide configuration and therefore should be included in a .gwbk
Files maintained by a module that should be identical on the redundant master and backup. These files provide configuration and therefore should be included in a .gwbk
Platform files that should be different between a redundant master and backup. These files provide configuration and therefore should be included in a .gwbk
Yes (separate /local-backup folder for redundancy)
Possible, but depends on the redundant provider
Hostname-specific certificates and files that are machine-specific but not part of a resource collection
Module files that should be different between a redundant master and backup. These files provide configuration and therefore should be included in a .gwbk
Yes (separate /local-backup folder for redundancy)