Server Requirements & Deployment Recommendations

This page provides guidance on choosing a suitable server configuration when deploying MrDoc.

MrDoc runs on **Django + uWSGI**, with the default configuration using **4 uWSGI workers** and thread support enabled. Server specifications directly affect concurrency and overall system performance.

---

## 1. Recommended Server Specifications (By Team Size)

### ✅ **Small Teams (up to 10 users)**

Suitable for personal use or small teams with low to moderate traffic.

| Item          | Recommended Specification |
| ------------- | ------------------------- |
| **CPU**       | 2 cores                   |
| **Memory**    | 4 GB                      |
| **Disk**      | 40 GB+ SSD                |
| **Bandwidth** | ≥ 2 Mbps                  |

Notes:
With the default 4 uWSGI workers, 2 CPU cores and 4 GB memory offer stable performance for small-scale collaboration.

---

### ✅ **Medium Teams (10–100 users)**

Suitable for most organizations and moderately active usage.

| Item          | Recommended Specification |
| ------------- | ------------------------- |
| **CPU**       | 4 cores                   |
| **Memory**    | 8 GB                      |
| **Disk**      | 80–200 GB SSD             |
| **Bandwidth** | ≥ 5 Mbps                  |

Notes:
More CPU cores ensure better request throughput under concurrency, while 8 GB memory provides sufficient headroom during heavy operations such as document preview, export, and attachment uploads.

---

### ✅ **Large Teams or High-Traffic Scenarios (100+ users)**

| Item          | Recommended Specification |
| ------------- | ------------------------- |
| **CPU**       | 8 cores                   |
| **Memory**    | 16 GB                     |
| **Disk**      | 200–500 GB SSD            |
| **Bandwidth** | ≥ 10 Mbps                 |

Notes:
Suitable for enterprise-level environments with heavy traffic. Additional optimizations such as increasing worker count, enabling caching, or using load balancers are recommended.

---

## 2. Minimum Requirements (Not Recommended for Production)

| Item       | Minimum Specification |
| ---------- | --------------------- |
| **CPU**    | 1 core                |
| **Memory** | 1 GB                  |
| **Disk**   | 20 GB SSD / HDD       |

Notes:
This configuration works for local  and personal environments but **is not recommended** for team deployments.

---

## 3. How to Choose the Right Configuration

### 📌 3.1 Relationship Between CPU and uWSGI Workers

By default, MrDoc uses:

* `workers = 4`
* `threads = 2`

General rule:

> **CPU cores ≥ number of uWSGI workers**

If your traffic grows, you can increase worker count or deploy multiple servers behind a load balancer.

---

### 📌 3.2 Memory Consumption

Each uWSGI worker typically consumes **150–250 MB**, plus:

* Django runtime
* Database connections
* Cache
* System overhead

Thus:

* 4 GB is suitable for light usage
* 8 GB supports medium teams
* 16 GB is recommended for high concurrency

---

### 📌 3.3 Disk I/O and Attachments

MrDoc handles:

* Image uploads
* Office documents
* File attachments
* Import/export operations

SSD is **highly recommended** for much better I/O performance.

---

### 📌 3.4 Bandwidth

Network speed affects attachment upload/download and overall responsiveness:

* Light usage: ≥ 2 Mbps
* Active teams: 5–10 Mbps recommended
* For cross-region access, consider higher bandwidth

---

## 4. Frequently Asked Questions (FAQ)

### **Q1: How do I estimate the required CPU and worker count?**

Use this practical formula:

> **Expected concurrent users ÷ 3 ≈ Recommended worker count ≈ CPU cores needed**

Examples:

* 15 concurrent users → ~5 workers → 4–6 CPU cores
* Small teams (3–5 people) → 2 CPU cores are enough

---

### **Q2: Does MrDoc support Docker deployment?**

Yes. The recommended server specs remain the same.
Make sure to:

* Allocate at least **2 GB memory** to the container
* Map storage volumes for data persistence

---

### **Q3: Does the database consume many resources?**

Generally, no.
MySQL / MariaDB / PostgreSQL work efficiently even on small servers.
For larger teams, you may consider using a separate database server.

---

## 5. Summary Table

| Use Case        | CPU     | Memory | Disk           | Bandwidth |
| --------------- | ------- | ------ | -------------- | --------- |
| **Small Team**  | 2 cores | 4 GB   | 40 GB SSD      | ≥ 2 Mbps  |
| **Medium Team** | 4 cores | 8 GB   | 80–200 GB SSD  | ≥ 5 Mbps  |
| **Large Team**  | 8 cores | 16 GB  | 200–500 GB SSD | ≥ 10 Mbps |

These recommended configurations ensure stable and reliable performance when running MrDoc in production environments.