Backup content to your S3 bucket
You can configure manual or automatic daily/weekly (depending on your subscription plan) backups of your content and component definitions in Storyblok with the Backups app. This adds additional security and lets you restore the backups created on your personal Amazon AWS S3 bucket.
Backed Up Entries
Here is a list of all the backed-up entries:
- Stories
- Scheduled Content
- Releases
- Translated Stories
- Translated Slugs
- Discussions
- Branches
- Components
- Component Groups
- Assets
- Asset Folders
- Space Roles
- Collaborators
- Workflows
- Workflow Stages
- Workflow Stage Changes
- Datasources (including the dimensions data)
- App Provisions (indicates if an app was installed)
- Tasks
The backups will NOT contain story versions, presets, and space settings. Management API can be used for specific backup needs. Presets can also be backed up by the Storyblok CLI.
The backups don't contain the actual assets, they just store the references of the assets. If you restore any backup along with the assets, all the assets will be correctly changed as they were at the time the backup was taken. It will even bring up the assets that were deleted from the space. This can only be done if the real asset is present on the Storyblok side. If an asset is deleted from Storyblok databases for any reason, it will not be restored. So it is important to understand that the assets cannot always be restored when deleted from the space.
If you would like to backup your assets while using the Storyblok Asset Manager, you can write a script for that by using the Management API.
You can take inspiration from the Storyblok Assets Backup tool.
Setup instructions
To set up backups, you need an Amazon AWS account and subscribe to Storyblok's Business or Enterprise Plans. If you don't have an Amazon AWS account yet, click here to sign up.
- Install the app S3 Backups in the Apps Directory section of Storyblok.
)
Storyblok backups app
- Go to space Settings {1} , click on the Backup & Restore tab {2}, and click on the Backup tab {3}, add your S3-bucket name and your AWS Role ARN (you'll find below how to get these).
You can also activate automatic daily backups{4}, and choose the days and times when you want these backups to happen.
)
Storyblok backup app settings
- Sign in to your Amazon Cloud formation and create a stack in your preferred region. Under Prepare template {1}, choose Template is ready, and under Specify template {2}, choose Amazon S3 URL as the template source and copy the following URL as the Amazon template URL {3}:
https://storyblok-tools.s3.eu-central-1.amazonaws.com/cloudformation/backup.yml - Click Next {4}.
)
creating a stack with Amazon Cloud formation
- Input the stack name, bucket name, and Storyblok space ID (it's important to note that this should be in lowercase) click Next and Next again.
)
Specifying stack details on AWS
- On the review page, click on "I acknowledge that AWS CloudFormation might create IAM resources with custom names." {1} then click on Create Stack {2}.
)
After creating a stack, you'd see the newly create stack and a role as seen in the image below.
)
Getting Amazon ARN from stack
- Go to Outputs, copy the Role ARN field, paste it into the AWS ARN field, and input the name of the S3 bucket on Storyblok.
- Click on Backup now {1} to test the backup.
)
Backing up on Storyblok
)
Restoring S3 backups on Storyblok
If the backup you want to restore is older, then you can insert the path you get by browsing your S3 bucket manually in the input field Backup file.