LESSON

Making Ignition Gateway Backups

Description

Learn how to create a backup of Ignition on demand and with a schedule.

Video recorded using: Ignition 8.3

Transcript

(open in window)

[00:00] In this lesson, we'll learn how to create gateway backups, which are files that contain everything that exist within the gateway and your projects. Very quickly, we can save the entire state of our gateway and be able to restore it on any Ignition server. Assuming that you're logged into the Ignition Gateway webpage, we can create a backup by clicking on this platform tab and expanding system. From here, you can click on backup and restore. On this screen, we can take a backup on demand by clicking this blue button that says download backup. We can see it's downloading, and this disclaimer says the file will contain all projects, drivers, images, and configurations, but not the modules. This button is useful for very quickly gathering a backup, but you can also schedule these so you don't have to come to this page every time. Backup scheduling is configured in the gateway settings page, and you can scroll down to find them.

[01:04] Scheduling can be enabled by marking off this checkbox. You can specify the folder to save the file in, and I'll paste in the path to my backups folder. The schedule itself is determined by this crontab expression. By default, the schedule is set for every day at 1:15 AM. This field can be changed, so you can set the schedule that works best for you. If you need help developing the crontab expression, I've included a link to our crontab formatting reference guide below this video. Next, we have the retention count, which sets a limit on how many backup files can be placed in the folder we specified above. Right now, it's set to five, so if a sixth file gets generated, the oldest one will be deleted. Finally, you can define the file name pattern. There's a few of these placeholder values listed in these curly brackets to insert things like the gateway's name or the current timestamp. For a full list of these values, I've included a link to the user manual for the scheduled backup settings.

[02:06] If you do end up changing the schedule, then you can save those changes with this button in the top right. You can also utilize the gateway command utility to generate backups on demand. I won't cover how to use it in this lesson, but just know that option is also available, and I've included one more link for using gateway commands.

You are editing this transcript.

Make any corrections to improve this transcript. We'll review any changes before posting them.