Wiki source code of Backup and Restore
Last modified by Scott Kohlmann on 2023/04/21 14:05
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="box warningmessage" %) | ||
| 2 | ((( | ||
| 3 | There is a known issue on 3-series processors where the processor fails to correctly chunk and upload the selected SRBackup.zip file. | ||
| 4 | See below for a workaround and detailed instructions on how to load a backup on 3-series processors. | ||
| 5 | ))) | ||
| 6 | |||
| 7 | {{box cssClass="floatinginfobox" title="**CONTENTS**"}} | ||
| 8 | {{toc/}} | ||
| 9 | {{/box}} | ||
| 10 | |||
| 11 | (% class="row" %) | ||
| 12 | ((( | ||
| 13 | = Overview = | ||
| 14 | |||
| 15 | ShowRunnerCLC™ provides backup and restore capabilities. Backups contain all of the necessary configuration files along with all graphics and extensions associated with the project. Credentials are stored encrypted and require an encrypted export. When the backup is exported a user provided secret is required to encrypt the export. The secret will be needed to import the credentials when restoring the backup. | ||
| 16 | |||
| 17 | = Downloading a ShowRunnerCLC™ Backup = | ||
| 18 | |||
| 19 | * Enter the Setup > File Management page and click the "Backup" button | ||
| 20 | [[image:1666702617736-962.png||height="148" width="241"]] | ||
| 21 | * Enter a Secret to be used when restoring the backup. **Do not lose or forget this Secret** as it is required in order to restore the project files | ||
| 22 | [[image:1666702720415-631.png||height="205" width="207"]] | ||
| 23 | * Once a secret is entered, the Download button will become active. Click the Download button to download the SRBackup.zip file | ||
| 24 | |||
| 25 | = Restoring a ShowRunnerCLC™ Backup = | ||
| 26 | |||
| 27 | * Enter the Setup > File Management page and click the "Restore" button | ||
| 28 | [[image:1666703025965-865.png||height="270" width="286"]] | ||
| 29 | * Click "Choose Backup" and select the .zip file containing the ShowRunnerCLC™ backup | ||
| 30 | ** **Warning: 3-series processors may incorrectly report that the file has been uploaded successfully** | ||
| 31 | ** If the backup has not been successfully uploaded to the processor, then the processor will always report "Secret failed" even when the correct Secret has been input | ||
| 32 | ** In these cases, it is necessary to manually load the backup file to the processor. Rename the file to "sr-restore.zip" and load it to the processor's NVRAM/sr/ folder, where the ShowRunnerCLC™ license file is located | ||
| 33 | [[image:1675702931711-850.png]] | ||
| 34 | * Enter the Secret used when generating the Backup to download your Backup Files | ||
| 35 | ** If the Secret has been lost, then the backup file is still useful because it contains the SrConfig.json as well as any floorplan graphics and BACnet configurations. However, any credentials or LWAPI setup will likely need to be redone | ||
| 36 | [[image:1666703396039-595.png||height="266" width="285"]] | ||
| 37 | * If the incorrect Secret is entered, you will be notified and prompted to re-enter the correct Secret | ||
| 38 | [[image:1666703225544-948.png||height="283" width="307"]] | ||
| 39 | * After the correct Secret is entered and Authorized, the system will restart and load the backed up configuration | ||
| 40 | [[image:1666703186664-511.png||height="262" width="277"]] | ||
| 41 | ))) |