Skip to content

Commit ef83830

Browse files
committed
chore: add backups section to documentation
bitfocus/website#16 @zklosko
1 parent ba13207 commit ef83830

1 file changed

Lines changed: 25 additions & 1 deletion

File tree

docs/user-guide/3_config/settings.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,31 @@ _If enabled, Companion will listen for Artnet messages, allowing for external de
147147

148148
## Backups
149149

150-
TODO
150+
Companion can back itself up on a schedule to multiple directories if desired. These backups can be synced to cloud storage or backed up during OS backup to give more piece-of-mind to administrators.
151+
152+
Companion has four different types of backups: Raw Database, Compressed, JSON, and YAML. Raw Database backups are the most complete yet can't be restored using Companion's UI. Compressed, JSON, and YAML backup types can be restored using Companion's UI (see the Restoring section below).
153+
154+
Compressed backups are recommended for most users.
155+
156+
### Setting Up Backups
157+
158+
1. Click on **Add Backup Rule** to create a new backup entry
159+
2. Fill out the right pane:
160+
- Rule Name - The name of your backup schedule.
161+
- Cron Schedule - Use cron syntax to indicate your backup schedule. You can use [crontab guru](https://crontab.guru/) to help you generate the correct syntax.
162+
- Backup Type - Select a backup type. Compressed backups are recommended for most users.
163+
- Backup Path - Fill out where backups are stored, including your root directory (Linux, Mac OS) or drive letter (Windows). If left blank, Companion will default to its built-in location.
164+
- Backup Name Pattern - Using Companion variables, fill out the name of each backup.
165+
- Number of Backups to Keep - Companion will delete older backups after this number of backups has been reached.
166+
3. Click the yellow **Run Now** button to test your backup rule.
167+
168+
### Restoring
169+
170+
Compressed, JSON, and YAML backups can be restored using the [Import/Export](import-export.md) page. Click Import Configuration and select the backup file.
171+
172+
Raw database backups _cannot_ be imported using Companion's UI.
173+
174+
A list of previous backups can be found at the bottom of the **Edit Backup Rule** pane after clicking the backup rule. Backups can be deleted using Companion's UI.
151175

152176
## Advanced
153177

0 commit comments

Comments
 (0)