Backup & Restore

Learn how to backup and restore your Streamer.bot configuration, including rolling back to previous versions.

Backups are automatically saved any time you open Streamer.bot or perform an update with the built-in updater

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.

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

Automatic backups will always be located in the backups folder within your Streamer.bot app directory
You can quickly find your backups location by clicking the menu icon and clicking Open Log Folder. If you then navigate up one directory from here, you should see the backups folder.
Close Streamer.bot before you continue to ensure there are no conflicts during the restoration process.
  • Navigate to your backups directory and select a data backup.
  • Pay attention to the [date]-[time]-[version] 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.
  • Open the backup .zip file and copy the contents
  • Return to your Streamer.bot directory and navigate to the data folder.
  • Paste the backup contents here
If a Replace or Skip Files dialog appears, choose 'Replace the file in the destination'.
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 below.

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

Sometimes you may need to repeat this process to restore an even earlier version

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

This can be useful if you experienced an update failure which did not automatically revert during the update process, or if you are debugging a fatal crash.

We always recommend to stay on the latest version unless absolutely necessary.
Close Streamer.bot before you continue to ensure there are no conflicts during the restoration process.
  • Navigate to the downloads page and download the version you would like to roll back to.
  • Extract the contents of the downloaded .zip file into a new folder.
    • This will be your new Streamer.bot directory for the version you are rolling back to.
  • Navigate to the backups directory of your previous Streamer.bot installation and select a data backup.
  • Pay attention to the [date]-[time]-[version] parts of the filename to determine which backup you would like to restore.
You must select a data backup that was created on the same version you are rolling back to.
Double check the [version] part of the filename to ensure it matches the version you are rolling back to.
  • Open the backup .zip file and copy the contents
  • Return to your newly created Streamer.bot directory and navigate to the data folder.
    • You can create a new data folder if it does not already exist.
  • Paste the backup contents here
If a Replace or Skip Files dialog appears, choose 'Replace the file in the destination'.
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 below.

You can now start Streamer.bot and if everything went smoothly you will be on the selected version!

Cloud backups are only available to Patreon supporters

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.

Cloud backups are not automatically generated.
In Streamer.bot, navigate to Settings > Backups
  • Click on Create a Cloud Backup to configure your backup
Description
Text
Enter a description for your backup. This can be used to identify your backup in the cloud.
Include auth.db
Toggle
Optionally include your auth.db file in the backup.
This file contains your authentication tokens for Twitch, YouTube, and other services.
If you do not include this file, you will need to re-authenticate these services after restoring your backup.
  • Click Create Backup to upload your backup to the cloud.
  • You will see a progress bar indicating the upload status.
Ensure you are logged into the same Streamer.bot account that you used to create the cloud backup.
In Streamer.bot, navigate to Settings > Backups

Click on Cloud Backups to expand the list of available backups.

  • Right-Click on the backup you would like to restore and select Restore Backup.
    • If you have multiple Streamer.bot instances, you can see cloud backups from other instances in the Other Instances tab
  • You will be prompted to confirm the selection:
    • Click Yes to proceed.
    • The backup will be downloaded and restored to your local Streamer.bot installation.

Streamer.bot should automatically restart after the restoration process is complete!