The way Iguana is architected and packaged together makes for a smooth backup procedure. See How is Iguana X packaged?
The following files in your Working Directory are key files to backup regularly:
| Expand | ||
|---|---|---|
| ||
Iguana X stores all local component repositories in a single repos directory in your working directory. The repos directory contains individual folders for each component, storing the project files (including custom fields and their default values, sample data, and database files added to your component projects). You can backup this single directory to backup all components and their associated project files on your instance. This directory can be found in:
Due to the way Iguana X leverages git (How does Iguana X use Git?) you can also connect each one of your components to an upstream repository in Bitbucket to backup your components. |
| Expand | ||
|---|---|---|
| ||
The commit you select to run each component on is stored in the run directory. It is recommended to backup this entire directory to save the running commits. If not backed up, during the restore process, all components would be set to run from the DEVELOPMENT commit. This directory can be found in:
See Choosing the code to run for your component for context on selecting component commits. |
| Expand | ||
|---|---|---|
| ||
The Configuration Files contain all your unique Iguana instance configurations like your users, notifications, logging rules, web server settings, custom field values etc. It is recommended to backup the entire configuration directory regularly. This directory can be found in:
|
| Expand | ||
|---|---|---|
| ||
The Log Directory contains all of your Iguana Service and transaction data flowing through Iguana. It is recommended to backup the entire log directory. This directory can be found in:
|
...
| title | Environment Variables - IguanaEnv.txt |
|---|
If you have configured any custom environment variables, an IguanaEnv.txt file is created and stored in your instance directory.
You can find this file in:
| Code Block |
|---|
<intance directory>/IguanaEnv.txt |
...
Iguana’s files are structured so that all the key files that should be backed up in order to restore IguanaX are located in the Working Directory.
It is recommended to regularly backup the entire working directory. However, if you want to decrease the size of your backup, it is safe to exclude particular folders:
Files | Default Location | Required? |
|---|---|---|
Instance Configuration Files |
| Required |
(unless changed to a new location) | Required | |
Resources |
| Optional Rebuilt on startup |
Upgrades |
| Optional |
Other files and dependencies created by components. Ex. a database file |
| Required |
| Info |
|---|
Note: Ensure your backup software does not lock the files in the log directory and the configuration directory as these files are frequently accessed by Iguana. It may cause an interruption if Iguana tries to access these files and they are locked by another process. For Antivirus software, it is recommended to whitelist the log directory and the configuration directory. |