Data security

# Data Security

When using MrDoc to build a knowledge base site, **data security** is an extremely important aspect. Whether you are an enterprise user or an individual deployer, you need to pay attention to data integrity, recoverability, portability, and the ability to prevent data loss or leakage.

This document will help you establish an overall awareness and operational path for site data security from several dimensions, including data composition, common risks, protective measures, and related documents.

## I. Site Data Composition

A running MrDoc knowledge base site mainly involves the following three types of core data:

| Data Type | Storage Location | Description |
| ----- | --------------------------- | ------------------------------- |
| Database data | SQLite / MySQL / PostgreSQL | Stores all key business data such as document content, user information, permission control, and operation logs |
| Media resources | `/media/` directory | Actual resource files such as attachments, images, and imported documents uploaded by users |
| Configuration file | `config/config.ini` | Contains site configuration items such as database connection, storage configuration, and debug switches |

---

## II. Common Risk Types

| Risk Type | Example |
| ----------- | --------------------------------- |
| **Accidental deletion/overwrite** | A user mistakenly deletes a document, or the data directory is incorrectly overwritten during an upgrade |
| **Database corruption** | Power failure, disk damage, insufficient space, etc. cause SQLite/MySQL data abnormalities |
| **Migration failure** | The database or media files are not correctly migrated during a server change, resulting in missing content |
| **Data leakage** | Configuration errors cause the database/media directory to be accessed externally, or keys are exposed |
| **No permission/backup mechanism** | Improper file permission settings and lack of regular backups make recovery impossible after a problem occurs |

---

## III. Security Protection Recommendations

1. **Regular backups**

- **Database**: Use mysqldump, pg_dump, or directly copy the SQLite file
- **Media resources**: Regularly package the media/ folder, or use an object storage solution and synchronize data
- **Configuration file**: Back up config/config.ini

2. **Permission control**

* Ensure that access permissions for the database, media directory, and configuration file are strictly restricted
   * When configuring the web service, disable public access to files such as `.env` and `.sqlite`

3.  **Configuration management recommendations**
The config.ini file is the only entry point and does not rely on .env environment variables. Please strictly control its permissions during deployment

4. **Off-site disaster recovery**

* For important deployments, it is recommended to push backup data to remote storage every day (such as object storage or NAS)

---

## IV. Recommended Operational Strategies

| Operation Scenario | Recommended Practice |
| ----- | -------------------------- |
| Daily use | Automatically back up the database daily and back up the media directory daily |
| Before upgrade | Manually back up the database + configuration file + media directory |
| Server migration | Full copy + database import |
| Compliance and supervision | Retain backup data for 7-30 days and regularly test the data recovery process |

> 📌 **Reminder**: At any time, do not rely on only one backup! Keep at least two backups on different media or in different locations to withstand unforeseen data loss risks.

---

## V. Data Recovery and Migration Capabilities

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

* ✅ Full-site backup and recovery
* ✅ Open source edition data export and import
* ✅ Pro edition data export and import
* ✅ Open source edition -> Pro edition data migration

For specific operation instructions, please read the following sub-documents: