chore: Add Documentation on Backing up Chatwoot (#429)

config/sidebar/selfhosted.js

@@ -104,10 +104,11 @@ module.exports = [
   },
   {
     collapsible: true,
-    label: "Upgrade",
+    label: "Maintenance",
     type: "category",
     items: [
       "self-hosted/deployment/upgrade",
+      "self-hosted/deployment/backup",
     ],
   },
   {

docs/self-hosted.md

@@ -70,6 +70,11 @@ This guide will help you to install and setup a production ready Chatwoot.
 - [Twitter App Setup](/docs/self-hosted/configuration/features/integrations/twitter-channel-setup)
 - [Slack App](/docs/self-hosted/configuration/features/integrations/slack-integration-setup)
 
+## Maintenance
+
+- [Upgrading your Chatwoot installation](/docs/self-hosted/deployment/upgrade)
+- [Backup your Chatwoot installation](self-hosted/deployment/backup)
+
 ## Runbooks
 
 - [How to migrate Chatwoot database?](/docs/self-hosted/runbooks/migrate-chatwoot-database)

docs/self-hosted/configuration/environment-variables.md

@@ -167,7 +167,7 @@ But you can change it to use any of the cloud providers like amazon s3, microsof
 ACTIVE_STORAGE_SERVICE=local
 ```
 
-When `local` storage is used the files are stored under `public/uploads` directory in the chatwoot root folder.
+When `local` storage is used the files are stored under `/storage` directory in the chatwoot root folder.
 
 > It is recommended to use a cloud provider for your chatwoot storage to ensure proper backup of the stored attachments and prevent data loss.
 

docs/self-hosted/deployment/backup.md

@@ -0,0 +1,67 @@
+---
+sidebar_label: "Backup"
+title: "Backing Up Your Chatwoot Installation"
+---
+
+Backups are crucial for any software system, including Chatwoot, for several reasons:
+
+1. **Disaster Recovery**: Backups serve as your safety net in the event of catastrophic incidents like hardware failure, data center outage, or natural disasters. They allow you to restore your application to its previous state quickly.
+
+2. **Data Loss Prevention**: Accidental data deletion or alteration due to human errors, software bugs, or malicious attacks can lead to significant losses. Backups provide a way to recover such lost or corrupted data.
+
+3. **Audit and Compliance**: Certain regulations require businesses to maintain backups for a specific period. These backups may serve as reference points for audits or compliance checks.
+
+4. **Business Continuity**: In situations where your primary data source becomes unavailable, having a backup allows your business to continue its operations with minimal disruption.
+
+In short, backups are an essential part of risk management and ensure the smooth operation of your software system.
+
+## What Data Should Be Backed Up?
+
+- [Postgres Database](#postgres-database)
+- [Storage (File uploads/Other Assets in Your Installation)](#storage)
+- [Configuration Variables](#configuration)
+- [Code Customisations](#code-customisations)
+
+
+### Postgres Database
+
+If you are managing the Postgres service yourself, you can use the `pg_dump` tool provided by PostgreSQL for this purpose.
+
+```bash
+pg_dump -U postgres -W -F t chatwoot_production > backup.tar
+```
+
+If you are using a managed provider like AWS, Google Cloud, or Azure, enable backups using the options provided by your provider.
+
+### Storage
+
+Based on your [storage configuration](/docs/self-hosted/configuration/environment-variables#configure-storage), you should take the appropriate steps. 
+
+If you are using a managed provider like `S3`, `GCS`, etc., ensure backups using the options available with the provider.
+If you are using the `local` storage provider, ensure to take a disk backup of the `storage` folder in the root of your Chatwoot Installation.
+
+### Configuration
+
+Important configuration might be stored in environment variables. You should back these up as well.
+Make a copy of the `.env` file or keep a backup of these configurations based on your setup.
+
+### Code Customisations
+
+Official Chatwoot updates using tools like `cwctl` assume that there are no customisations done to the Chatwoot installation. We don't provide support for custom modifications of the Chatwoot codebase. If you are planning any such modifications, please ensure that you back up these customisations using `git` or other appropriate tooling.
+
+## Guidelines
+
+The frequency of backups largely depends on the nature of your application and the amount of data you generate and can afford to lose. You can opt for `continuous` or `daily` backups as per your need.
+
+> Remember, these backups should be stored in a different physical location to protect against hardware failures. Using a cloud storage provider could be a good solution. Please ensure that access to these backups is tightly controlled, as they contain sensitive data.
+
+## Restoring a Backup
+
+To restore a backup into a new Chatwoot installation, please follow these steps:
+
+- Set up a new Chatwoot installation and finish the onboarding flow.
+- Ensure that the [configuration](#configuration) values match the ones in your backup.
+- Purge the database of this installation and replace it with the data from your [postgres](#postgres-database) backup.
+- Restore [Storage](#storage) with your backup data.
+- Restore any [Code Customisations](#code-customisations).
+- Restart Chatwoot services and you are good to go.