====== Backup Files ======

You can save your Internet Gate configuration to a file on your PC for later reload. It is very convenient to do if you have to perform a reset to factory defaults, or want to copy one unit's settings to another one. All your settings are saved to one PC file that can be reloaded at a later time.

You are recommended to backup your settings after you have configured your Internet Gate.

:!: Do a backup of your settings now. Yes **now**. You never know when you need them later.

===== Backup =====
  - Open [[web GUI:Administration page]] from the Configuration section of the [[web GUI:main menu]].
  - If the backup file should be loadable on other Internet Gate units too (recommended) then enter a password. (If no password entered file is only loadable into same unit.)
  - Click "Backup to file".
  - Select a location to store the backup file and click Save .

The backup file is typically named (if no other name is chosen) ''settings.txt''


===== Restore =====
<if ver lt 5.32>
^ :!: Restore must always be performed into a factory defaulted unit! ^

  - Open [[web GUI:Administration page]] from the Configuration section of the [[web GUI:main menu]].
  - Click the Factory Reset button at the bottom of the page.
  - Let the unit reboot, then reopen [[web GUI:Administration page]] again.
  - In the section Backup/restore settings click Browse .
  - Select the previously saved backup file and click Open .
  - Click Go .
  - Save the restored settings permanently.
  - Reboot the unit.
:!: Backup files created with release 5.32 or higher cannot be loaded into units running older releases.
</if>
<if ver gt 5.31 or !is_box>
  - Open [[web GUI:Administration page]] from the Configuration section of the [[web GUI:main menu]].
  - if backup file was created using a password enter the same password.
  - Click Browse, select the previously saved backup file and click Open.
  - Click Go.
The unit performs a reset to factory defaults, loads the backup file settings, and saves them permanently. During this process Internet Gate reboots twice. Do not turn power off or abort the process in any way.

:!: Backup files created with release 5.31 or lower will load only partially: most settings load OK, but passwords and other encrypted settings do **not** load and remain unchanged or empty.

:!: Backup files created without password on other units will also load only partially: most settings load OK, but passwords and other encrypted settings do **not** load and remain unchanged or empty.
</if>

===== Encryption =====
Starting from firmware release 5.32 passwords in the backup file are encrypted for safety reasons.

A backup file saved without password is saved in clear text, except for passwords and other sensitive information. The encryption key used to encrypt them is unique for each individual unit, thus such a file can only be restored back into the same unit. Loading such a file into some other unit will load all configuration except the passwords (as encryption key of that unit will not match).

A backup file saved with password is saved fully encrypted, thus it is not human readable. The encryption key used is based on the supplied password, thus such a file can be restored back into any other unit, provided you enter the same password again.

===== Advanced =====
^ :!: This information is only for advanced users. ^
| You can render your unit uncontactable by loading an incorrect backup file. |

<if ver gt 5.31 or !is_box>
If you have saved a backup file without password you can open it in any editor capable of editing files with LF as linefeeds (unix-style). By deleting unwanted files and settings you can create backup files that only affect selected parts of the unit's configuration. Files and settings not included into the backup file will be left unchanged.

Make sure you delete the ''##@#FactoryDefault'' entry near the end of the file to avoid reset of settings not included into your partial backup file.

:!: Backup files saved with password are not humanly readable and cannot be edited this way.

:!: Encrypted values cannot be changed.
</if>
<if ver lt 5.32>
You can open the ''settings.txt'' backup file in any editor capable of editing files with LF as linefeeds (unix-style). By deleting unwanted files and settings you can create backup files that only affect selected parts of the unit's configuration. Files and settings not included into the backup file will be left unchanged.

To load such a partial backup file into a unit do not perform factory reset before loading (skip step 2 above).
</if>

The structure of the ''settings.txt'' backup file is as follows:

<code>
##@#
# 5.30 Exported VMI settings file.
# This file is in UNIX format (lines end with single LF char) and must be so at import.
##@#<filename1>
<parameter1 assignment>
<parameter2 assignment>
     ....
##@#<filename2>
<parameter1 assignment>
<parameter2 assignment>
     ....
##@#<filename3>
<parameter1 assignment>
<parameter2 assignment>
     ....
##@#EndOfFile
</code>

The "''##@#''" string is a //filemark//. It preceeds the name of the file, and marks that the following lines will list parameters (possibly modified) belonging to that file, up to the next filemark.

A parameter assignment will overwrite the existing value of the named parameter, or be added to the file if missing.

The first line must be a single filemark (filename is empty), and is followed by some lines that are treated as comments, up to next filemark. 

A filemark can be followed by the REPLACE keyword, meaning that the following parameters will constitute the new file, while deleting the old contents of the file (instead of parameter-per-parameter overwriting).