Plans supporting access to backup & restore settings in knowledge base portal
Free | Professional | Business | Enterprise |
---|---|---|---|
Document360 automatically backs up your project's data daily at 00:00 UTC. However, you can perform a manual backup at any point.
You can also restore your project to a previous state from any available backup. The listed elements of your Knowledge base can be restored:
Documentation
Sitebuilder
API Documentation
Custom CSS
Custom JavaScript
For example, if a team member accidentally deletes or changes a category from your documentation, you can restore just your documentation from the most recent backup.
Creating a manual backup
You can create a manual backup by following these steps:
Navigate to Settings > Knowledge base portal > Backup and Restore to open the Backup and Restore page.
Click the New backup button on the top right.
The Backup name panel will appear.
Enter your desired backup name and click Backup.
When the backup is complete, it will be added to the backup log.
To restore from a backup
You can restore from the backup by following these steps:
Navigate to Settings > Knowledge base portal > Backup and Restore to open the Backup and Restore page.
On the desired backup, click the Restore option dropdown and select the desired restore option:
For Documentation, Site builder, and API documentation: Select the checkbox of the option(s) you want to restore and click Restore.
For Custom CSS and Custom JavaScript: Compare the backup and current workspace. If you want to restore the backup version, click Restore.
On the confirmation prompt, click Yes.
The restore process will run in the background. Once completed, a Backup Restored message will appear.
Restore options
1. Documentation
Restores your project documentation as they were when the backup was created.
You can select the desired workspaces, languages, categories, or articles.
Turn on the Select all toggle if you need to select the complete documentation.
In the Restore documentation panel, hover over any article/category page, and the View option will appear next to it. Click View to see the backup content of the respective article/category page.
Example, To retrieve the documentation of a recently deleted language:
Navigate to Settings > Knowledge base portal > Backup and Restore in the Knowledge base portal.
Click the Restore option and select Documentation.
Select the desired workspace and language, and click Restore.
NOTE
When you restore an existing workspace/language/category/article, it is updated with the backup content.
When you restore a deleted workspace/language/category/article, it is added as a new workspace/language/category/article.
2. Site builder
When a backup is created, you can restore all the features of the site builder, including:
Navigations: Header & Footer
Main Pages: Home, Documentation, and Login
Error Pages: 404 Page, Access Denied Page, Unauthorized Page, and IP Restrictions
You can select the desired workspaces and languages.
Use the "Select all" toggle to select all workspaces and languages.
Example, To retrieve the Home page of a recently deleted language:
Navigate to Settings > Knowledge base portal > Backup and Restore in the Knowledge base portal.
Click the Restore option and select Site builder > Home.
Select the desired workspace and language, and click Restore.
3. API documentation
Restores your project documentation as they were when the backup was created.
You can select the desired workspaces, languages, categories, or articles.
Turn on the Select all toggle if you need to select the complete documentation.
In the Restore documentation panel, hover over any article/category page, and the View option will appear next to it. Click View to see the backup content of the respective article/category page.
4. Custom CSS
Restores the custom CSS of the Knowledge base site to the state when the backup was created.
You can compare the custom CSS of the backup and the current version, with changes highlighted.
To copy the CSS codes, click the Copy code snippet () icon next to the respective version.
For example, If multiple team accounts add custom CSS to your project, sometimes the snippets can be overwritten. If you need to retrieve and restore a previous version of custom CSS, follow these steps:
Navigate to Settings > Knowledge base portal > Backup and Restore.
Click the Restore option and select Custom CSS.
Compare the backup and the current version.
Click Restore to retrieve the recently changed CSS snippet.
4. Custom JavaScript
Restores the custom JavaScript of the Knowledge base site to the state when the backup was created.
You can compare the custom JavaScript of the backup and the current version, with changes highlighted.
To copy the JavaScript codes, click the Copy code snippet () icon next to the respective version.
For example, If multiple team accounts add custom JavaScript to your project, sometimes the snippets can be overwritten. If you need to retrieve and restore a previous version of custom JavaScript, follow these steps:
Navigate to Settings > Knowledge base portal > Backup and Restore.
Click the Restore option and select Custom Javascript.
Compare the backup and the current version.
Click Restore to retrieve the recently changed JavaScript snippet.