Data Security

Data security is a critical aspect when building a knowledge base site using MrDoc. Whether you are an enterprise user or an individual deployer, it is essential to ensure data integrity, recoverability, portability, and protection against data loss or leakage.

This document will help you build a comprehensive awareness and operational approach to site data security by covering data components, common risks, protection measures, and related documentation.

---

## 1. Site Data Composition

A running MrDoc knowledge base primarily involves the following three core data types:

| Data Type     | Storage Location            | Description                                                                                                   |
| ------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------- |
| Database Data | SQLite / MySQL / PostgreSQL | Stores all document content, user info, permission controls, operation logs, and other critical business data |
| Media Assets  | `/media/` directory         | Actual resource files such as user-uploaded attachments, images, and imported documents                       |
| Config Files  | `config/config.ini`         | Site configurations including database connections, storage settings, debug toggles, etc.                     |

---

## 2. Common Risk Types

| Risk Type                         | Example Scenario                                                                                        |
| --------------------------------- | ------------------------------------------------------------------------------------------------------- |
| **Accidental Deletion/Overwrite** | User mistakenly deletes documents or data directories are wrongly overwritten during upgrades           |
| **Database Corruption**           | Power failure, disk damage, or insufficient storage causing SQLite/MySQL data anomalies                 |
| **Migration Failure**             | Failure to correctly migrate databases or media files during server transfer, resulting in content loss |
| **Data Leakage**                  | Misconfiguration leading to external access to database/media directories or exposure of sensitive keys |
| **Lack of Permissions/Backup**    | Improper file permissions or absence of regular backups, causing irrecoverable data loss                |

---

## 3. Security Recommendations

1. **Regular Backups**

* **Database**: Use tools like `mysqldump`, `pg_dump`, or directly copy SQLite files
* **Media Assets**: Periodically archive the `media/` folder, or use object storage solutions with synchronization
* **Config Files**: Backup `config/config.ini`

2. **Access Control**

* Ensure strict access permissions on database, media directories, and config files
* Disable public access to sensitive files like `.env`, `.sqlite` when configuring web services

3. **Configuration Management**

* `config.ini` is the sole configuration entry point and does not rely on `.env` variables; strictly control its permissions during deployment

4. **Offsite Disaster Recovery**

* It is recommended to push backup data daily to remote storage locations such as object storage services or NAS

---

## 4. Recommended Operational Strategies

| Scenario           | Recommended Practice                                              |
| ------------------ | ----------------------------------------------------------------- |
| Daily Operation    | Automate daily backups of database and media directory            |
| Before Upgrading   | Manually backup database, config files, and media directory       |
| Server Migration   | Full copy of files plus database import                           |
| Compliance & Audit | Retain backup data for 7-30 days, regularly test data restoration |

> i 📌 **Note**: Never rely on a single backup! Always keep at least two backups on different media or locations to mitigate risks of unexpected data loss.

---

## 5. Data Recovery and Migration Capabilities

To ensure data can be recovered or migrated under any circumstances, MrDoc provides comprehensive backup, export, and deployment mechanisms, including:

* ✅ Full site backup and restore
* ✅ Data export and import for the open-source edition
* ✅ Data export and import for the professional edition
* ✅ Migration from open-source edition to professional edition

For detailed operational instructions, please refer to the following sub-documents:

Site Data Backup / Site Migration

Data Export and Import

Open Source Edition → Professional Edition Data Migration