Skip to content

Commit ed6c3f0

Browse files
docs: remove app backup info, update backup/restore instructions, add cloud backup section
1 parent d40c67b commit ed6c3f0

1 file changed

Lines changed: 144 additions & 42 deletions

File tree

Lines changed: 144 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,62 @@
11
---
22
title: Backup & Restore
3-
description: Easily fix things when they go wrong!
3+
description: Learn how to backup and restore your Streamer.bot configuration, including rolling back to previous versions.
44
---
55

6-
Streamer.bot **automatically** performs backups any time you open the application or perform an update with the in-built updater.
6+
## Local Backups
77

8-
You can use these backups to fully restore your data, in case you accidentally deleted something and would like to restore it.
8+
::important
9+
Backups are **automatically saved** any time you open Streamer.bot or perform an update with the built-in updater
10+
::
11+
12+
These backups contain **all** of your configuration settings, including actions, commands, stored user data, and more. This means that if you ever experience a catastrophic failure, you can fully restore your configuration to a previous state.
913

1014
You can even fix catastrophic scenarios preventing you from starting up Streamer.bot by simply restoring an automatic backup!
1115

1216
::note
1317
Automatic backups will always be located in the `backups` folder within your Streamer.bot app directory
18+
<br>
19+
You can quickly find your backups location by clicking the menu :icon{name=i-mdi-menu} icon and clicking `Open Log Folder`.
20+
If you then navigate up one directory from here, you should see the `backups` folder.
1421
::
1522

16-
::tip
17-
You can quickly find your backups location by clicking the menu :icon{name=i-mdi-menu} icon and clicking `Open Log Folder`. If you then navigate up one directory from here, you should see the `backups` folder.
18-
::
23+
### Restoring Data Backups
1924

20-
Two types of backups are automatically generated:
25+
::danger
26+
**Close Streamer.bot before you continue** to ensure there are no conflicts during the restoration process.
27+
::
2128

22-
- **Data Backup**
23-
- Contains all configuration from your bot, such as actions, settings, etc
24-
- Created on every startup of Streamer.bot
25-
- Saved as `backups/backup-[date]-[time].zip`
26-
- **Application Backup**
27-
- Contains a full backup of the current Streamer.bot version, including application files necessary for Streamer.bot to execute
28-
- Created when performing an automatic update
29-
- Saved as `backups/app-backup-[version]-[date]-[time].zip
29+
::steps{level=4}
3030

31-
## Restoring Backups
32-
### Data
31+
#### Select a Backup to Restore
3332

34-
::danger
35-
**Close Streamer.bot** to ensure there are no conflicts during the restoration process.
36-
::
33+
- Navigate to your `backups` directory and select a data backup.
34+
- Pay attention to the `[date]-[time]-[version]`{lang=cs} parts of the filename to determine which backup you would like to restore. Typically, you want to choose the most recent backup from **before** the absolute latest.
3735

38-
Navigate to your `backups` directory and select a data backup. Pay attention to the `[date]-[time]` parts of the filename to determine which backup you would like to restore. Typically, you want to choose the most recent backup from **before** the latest.
36+
#### Restore Your Backup
3937

4038
- Open the backup `.zip` file and copy the contents
4139
- Return to your Streamer.bot directory and navigate to the `data` folder.
4240
- Paste the backup contents here
4341

44-
::warning
42+
:::warning
4543
If a `Replace or Skip Files` dialog appears, choose 'Replace the file in the destination'.
46-
::
44+
:::
4745

48-
::tip
49-
You can also open your `data` directory and selected `backup.zip` in separate windows, and view them side-by-side. YOu can then simply drag-and-drop the contents across. This is the method used in the [video tutorial](#video-tutorial) below.
50-
::
46+
:::tip
47+
You can also open your `data` directory and selected `backup.zip` in separate windows, and view them side-by-side. You can then simply drag-and-drop the contents across. This is the method used in the [video tutorial](#video-tutorial) below.
48+
:::
49+
50+
#### Restart Streamer.bot
5151

5252
The next time you open Streamer.bot your backup configuration will be loaded!
5353

54-
::tip
54+
:::tip
5555
Sometimes you may need to repeat this process to restore an even earlier version
56+
:::
5657
::
5758

58-
### App Rollback
59-
60-
::danger
61-
**Close Streamer.bot** to ensure there are no conflicts during the restoration process.
62-
::
59+
### Rolling Back to a Previous Version
6360

6461
Application backups allow you to roll back to previous versions of Streamer.bot
6562

@@ -69,20 +66,125 @@ This can be useful if you experienced an update failure which did not automatica
6966
We always recommend to stay on the latest version unless absolutely necessary.
7067
::
7168

72-
Navigate to your `backups` directory and select an application backup (files prefixed with `app-backup`).
69+
::danger
70+
**Close Streamer.bot before you continue** to ensure there are no conflicts during the restoration process.
71+
::
72+
73+
::steps{level=4}
74+
75+
#### Download a previous version of Streamer.bot
76+
77+
- Navigate to the [downloads page](https://streamer.bot/downloads) and download the version you would like to roll back to.
78+
- Extract the contents of the downloaded `.zip` file into a new folder.
79+
- This will be your new Streamer.bot directory for the version you are rolling back to.
7380

74-
Note the `[date]-[time]` parts of your selected backup as these will allow you to find your matching [Data Backup](#data).
81+
#### Select a Backup to Restore
7582

76-
- Open the app backup `.zip` file and copy the contents
77-
- Return to your main Streamer.bot directory
83+
- Navigate to the `backups` directory of your previous Streamer.bot installation and select a data backup.
84+
- Pay attention to the `[date]-[time]-[version]`{lang=cs} parts of the filename to determine which backup you would like to restore.
85+
86+
:::warning
87+
**You must select a data backup that was created on the same version you are rolling back to.**
88+
<br>
89+
Double check the `[version]` part of the filename to ensure it matches the version you are rolling back to.
90+
:::
91+
92+
#### Restore Your Backup
93+
94+
- Open the backup `.zip` file and copy the contents
95+
- Return to your newly created Streamer.bot directory and navigate to the `data` folder.
96+
- You can create a new `data` folder if it does not already exist.
7897
- Paste the backup contents here
79-
- Find your matching data backup `.zip` file, open it, and copy the contents
80-
- Return to your Streamer.bot directory and navigate to the `data` folder
81-
- Paste the data contents here to restore your configuration files
8298

83-
::success
99+
:::warning
100+
If a `Replace or Skip Files` dialog appears, choose 'Replace the file in the destination'.
101+
:::
102+
103+
:::tip
104+
You can also open your `data` directory and selected `backup.zip` in separate windows, and view them side-by-side. You can then simply drag-and-drop the contents across. This is the method used in the [video tutorial](#video-tutorial) below.
105+
:::
106+
107+
#### Restart Streamer.bot
108+
84109
You can now start Streamer.bot and if everything went smoothly you will be on the selected version!
85110
::
86111

87-
## Video Tutorial
88-
:youtube-embed{id="dLkiqW2b_Vo"}
112+
### Video Tutorial
113+
114+
:youtube-embed{id="dLkiqW2b_Vo"}
115+
116+
## Cloud Backups
117+
118+
::note
119+
**Cloud backups are only available to [Patreon](https://www.patreon.com/nate1280){target=\_blank} supporters**
120+
::
121+
122+
Streamer.bot can also upload your backups to the cloud, allowing you to restore your configuration from anywhere, even if you are on a different computer.
123+
124+
### Upload a Backup to the Cloud
125+
126+
::warning
127+
Cloud backups are **not** automatically generated.
128+
::
129+
130+
::steps{level=4}
131+
132+
#### Open Backup Settings
133+
134+
:::navigate
135+
In Streamer.bot, navigate to **Settings > Backups**
136+
:::
137+
138+
- Click on `Create a Cloud Backup` to configure your backup
139+
140+
#### Configure Your Cloud Backup
141+
142+
:::field-group
143+
::::field{name="Description" type=Text}
144+
Enter a description for your backup. This can be used to identify your backup in the cloud.
145+
::::
146+
::::field{name="Include auth.db" type=Toggle}
147+
Optionally include your `auth.db` file in the backup.
148+
<br>
149+
This file contains your authentication tokens for Twitch, YouTube, and other services.
150+
<br>
151+
If you do not include this file, you will need to re-authenticate these services after restoring your backup.
152+
::::
153+
:::
154+
155+
#### Create Backup
156+
157+
- Click `Create Backup` to upload your backup to the cloud.
158+
- You will see a progress bar indicating the upload status.
159+
160+
::
161+
162+
### Restore a Backup from the Cloud
163+
164+
::important
165+
Ensure you are logged into the same Streamer.bot account that you used to create the cloud backup.
166+
::
167+
168+
::steps{level=4}
169+
170+
#### Open Backup Settings
171+
172+
:::navigate
173+
In Streamer.bot, navigate to **Settings > Backups**
174+
:::
175+
176+
Click on `Cloud Backups` to expand the list of available backups.
177+
178+
#### Select a Backup to Restore
179+
180+
- `Right-Click` on the backup you would like to restore and select `Restore Backup`.
181+
- If you have multiple Streamer.bot instances, you can see cloud backups from other instances in the `Other Instances` tab
182+
- You will be prompted to confirm the selection:
183+
- Click `Yes` to proceed.
184+
- The backup will be downloaded and restored to your local Streamer.bot installation.
185+
186+
#### Restart Streamer.bot
187+
188+
Streamer.bot should automatically restart after the restoration process is complete!
189+
190+
::

0 commit comments

Comments
 (0)