> For the complete documentation index, see [llms.txt](https://docs.copia.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.copia.io/docs/devicelink/basic/inductive-automation-ignition.md).

# Inductive Automation Ignition

## Overview

Backing up your Inductive Automation Ignition system is important to protect your data and settings if something goes wrong, like a hardware failure or a cyberattack. It helps you quickly restore your system and avoid long delays or costly downtime. Regular backups make sure you can recover important information and keep everything running smoothly.

This page explains how to configure a Copia DeviceLink [Script](https://docs.copia.io/docs/devicelink/basic/copia-scripting.md) based project, in coordination with a scheduled Ignition Gateway backup, for **disaster recovery**. The same approach works for Ignition 8.1 and 8.3, since each version can create Gateway backups (`.gwbk` files) on a schedule.

| Ignition version | Scheduled backup settings location       | Ignition documentation                                                                                                           |
| ---------------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| 8.3              | **Platform > System > Gateway Settings** | [Gateway Settings (8.3)](https://docs.inductiveautomation.com/docs/8.3/platform/gateway/web-interface/platform/gateway-settings) |
| 8.1              | **Config > Gateway Settings**            | [Gateway Settings (8.1)](https://docs.inductiveautomation.com/docs/8.1/platform/gateway/config/gateway-settings)                 |

{% hint style="info" %}
Though it is possible to create Project Backups in Ignition as well, only Gateway backups have a scheduler option. Since Gateway backups contain all project data, it is possible to extract a specific Project from that data by opening the resulting .zip file or using Inductive's helper tool [Kindling](https://github.com/inductiveautomation/kindling). See forum posts [1](https://forum.inductiveautomation.com/t/edge-automated-project-back-ups/86122) & [2](https://forum.inductiveautomation.com/t/gateway-loosing-projects-how-to-restore-projects/88820/1).&#x20;
{% endhint %}

## Requirements

It is assumed that you are familiar with creating a Copia Script based backup. If not, please review the [Copia Scripting](https://docs.copia.io/docs/devicelink/basic/copia-scripting.md) documentation.

* Ignition 8.1 or 8.3 with access to the Gateway Webpage to configure scheduled backups.
* A backup folder that the Ignition Gateway can write to and the Copia Agent can read from. This can be a folder on the Copia Agent, or a network location.

## Ignition Gateway Backup Configuration

We recommend that you follow the guidelines for creating a scheduled Gateway backup in the Ignition documentation for your version.

As an example, let's assume that the Copia Agent is installed on a machine with an IP address of 1.2.3.4. You would configure the **Scheduled Backup Settings** section of the Gateway Settings page as shown for nightly backups:

<figure><img src="https://3704730939-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4lSQNVI3DZ15V7kjkMCA%2Fuploads%2FQUnt9Lb8zWm1ZEuiwoir%2Fimage.png?alt=media&amp;token=f1da41da-221e-47d3-9394-747600f67f57" alt=""><figcaption></figcaption></figure>

1. **Enable Scheduled Backups:** checked.
2. **Backup Folder:** a temporary location that the Copia Agent can access, for example `\\1.2.3.4\copia\ignition_backup` (`c:\copia\ignition_backup` on the Agent).
3. **Backup Schedule:** a UNIX crontab-format schedule. For example, `0 0 * * *` creates a backup every night at midnight.
4. **Retention Count:** `1`.
5. **Filename Pattern:** `${gatewayName}_Ignition-backup`. This removes the default `${timestamp}` so that each backup uses the same file name.

{% hint style="info" %}
When using a network location, Ignition requires a full UNC path (mapped network drives are not supported), and the Gateway service must have permission to create and write files in the backup folder.
{% endhint %}

A few notes in the above example:

1. You are storing the backup in a temporary location on the Copia Agent, so that it can move that backup to the proper location at the proper time, and it will delete the backup after doing so.
2. The backup file name does not need to be changed. Ignition 8.1 and 8.3 add a date/time stamp to scheduled backup file names by default, and the script below renames the backup to a fixed name so that each backup becomes a new commit of the same file in the Copia repo.

## Scripts

The following script should be stored and executed on the Copia Agent (*for example,* `c:\copia\scripts\Ignition_backup.BAT`). The script will move the newest `.gwbk` file from the backup folder to the appropriate folder for Copia to store in the repository, and name it `Ignition_backup.gwbk`.

An **example** batch script is provided below (*change* `c:\copia\ignition_backup` *if you used a different backup folder*):

```batch
echo Running Ignition Backup Script...
@echo off
REM -Setup-------------------------------------------------------------
echo %date% %time% Starting Ignition Backup Script >> %temp%\backup_results\CopiaError.log

REM -Script------------------------------------------------------------
move c:\copia\ignition_backup\{filename} %temp%\backup_results\

REM -Cleanup and Exit--------------------------------------------------
echo %date% %time% Completed Backup Command >> %temp%\backup_results\CopiaError.log

REM -Remove Error Log:  No error log is considered a success ----------
del %temp%\backup_results\CopiaError.log
exit 
```

## Project Configuration

To configure an Ignition project, you need a repository for your Inductive Automation Ignition backup to reside in. You can just create a single repository (*for example,* `Ignition_[servername]`).

Click either of the *Add a Project* buttons in the Projects tab.

<figure><img src="https://3704730939-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4lSQNVI3DZ15V7kjkMCA%2Fuploads%2FtuLnrjpfl69xyulXbzSW%2Fimage.png?alt=media&amp;token=038366e3-7be2-4f7a-b960-06462a1a90f9" alt=""><figcaption></figcaption></figure>

The *Add a new project* configuration dialog will appear which allows you to fully configure the project, devices and job for the project.

<figure><img src="https://3704730939-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4lSQNVI3DZ15V7kjkMCA%2Fuploads%2FEts1nxTlwbAR5mIuckyT%2Fimage.png?alt=media&amp;token=deaa1d52-843b-4b79-9480-b7f0c3bed948" alt=""><figcaption></figcaption></figure>

#### Define the Project

To get started, select **Script** as the *Project Type*, and then select an *Agent*. See more about this in the [Agents](https://docs.copia.io/docs/devicelink/sitesandagents/agents.md) section of the documentation.

<figure><img src="https://3704730939-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4lSQNVI3DZ15V7kjkMCA%2Fuploads%2Fp8kGGVVwY2kxtSc0A9Wz%2Fimage.png?alt=media&amp;token=476c8ad7-7d0f-4ac7-b6b6-ee40a107656e" alt=""><figcaption></figcaption></figure>

When choosing the Project Path, select the repository you created, and (*if not already created*) choose to make a new folder named the same as the Ignition system you are backing up.

<figure><img src="https://3704730939-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4lSQNVI3DZ15V7kjkMCA%2Fuploads%2FPkgOGqE0Xax4pLsQAvEs%2Fimage.png?alt=media&amp;token=5153cd6d-f41c-47f9-bd5a-e5f7ef809c45" alt=""><figcaption></figcaption></figure>

When defining the script, add the full path to the script on the Agent. In the above example: `c:\copia\scripts\Ignition_backup.BAT`

<figure><img src="https://3704730939-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4lSQNVI3DZ15V7kjkMCA%2Fuploads%2FMpuCzcUVEGrvGf5HWUwz%2Fimage.png?alt=media&amp;token=9c46664e-af64-4d45-b295-46d772f28174" alt=""><figcaption></figcaption></figure>

#### Define the Device

Since the Script exists on the Agent, there is no need to define a Device for Projects that use a Script during setup. You can skip to the Job section.

#### Define the Job

Creating Jobs is similar for all vendor types, and is described in the [Creating Jobs](https://claude.ai/docs/devicelink/jobs/creating-jobs.md) section.

{% hint style="info" %}
We recommend you create and run a Job for this Project periodically (*at least weekly*), scheduled shortly after the Ignition backup schedule, so that you always have a recent backup of your Ignition configuration for restore.&#x20;
{% endhint %}

#### Submit the Configuration

Once complete, press *Submit Project Setup* to create the Project, Device and Job.

<figure><img src="https://3704730939-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4lSQNVI3DZ15V7kjkMCA%2Fuploads%2FJMFiMT57AN3Vfb6ykkwi%2Fimage.png?alt=media&amp;token=ac413a62-a1cf-4070-91ef-72fd1ebf2b16" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.copia.io/docs/devicelink/basic/inductive-automation-ignition.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
