🔅写在前面

>i 在开始前,你需要了解的事项

# 环境要求

这里讲述运行 mrdoc 所要求的一些软硬件配置,我们建议您在运行或者部署之前先浏览一遍此页面.

# 硬件配置

### CPU

无特别要求,但是我们的 [Docker镜像](https://hub.docker.com/r/jonnyan404/mrdoc-alpine) 目前仅支持amd64和arm64平台.

### 内存

为了获得更好的体验,我们建议至少配置256M的RAM

### 网络

可以离线运行,不依赖外网.

# 软件环境

mrdoc 理论上可以运行在任何支持 Python 的平台

### python版本

必须运行在 `Python ≥ 3.5` 上,这是运行 mrdoc 所要求的最低环境要求.如果您使用 Docker 运行 mrdoc,可忽略此要求.

### mysql (可选)

这并不是 mrdoc 必须依赖的，mrdoc 默认使用自带的 `sqlite`，无需单独安装。如果 `sqlite` 不能满足你的要求，您需要在系统内安装并运行好 MySQL。

具体要求：

1. 版本：5.7 +
2. 字符集（Character Set）：utf8mb4
3. 排序规则（Collate）：utf8mb4_bin

综上，建议创建数据库采用下面的命令：
`create database mrdoc character set utf8mb4 collate utf8mb4_bin;`

### web 服务器 (可选)

如果您部署在生产环境，那么你很可能需要进行域名绑定，这时候我们推荐使用诸如 `Nginx+Uwsgi` 之类的 Web 服务器进行反向代理。

# 浏览器支持

主要以 `chrome 内核`为主的主流浏览器支持,例如:chrome/Firefox/Edge/360极速 等.

# 工作目录

指 mrdoc 所依赖的工作目录，在 mrdoc 运行的时候会依赖整个 `MrDoc` 目录。请放置好这个目录到你的指定目录,里面通常包含下列目录或文件：
1. app_admin:管理员相关目录
2. app_api:api接口相关目录
3. app_doc:文集文档相关目录
4. `config`:数据库配置文件目录[备份/迁移]
5. `media`:图片/附件存放的目录[备份/迁移]
6. MrDoc:django相关系统配置目录
7. static:css/js等文件目录
8. template:html相关模板目录
9. manage.py:django入口文件
10. requirements.txt:python依赖包文件

# 问题反馈

- 请参考:<https://www.mrdoc.fun/project-1/doc-172/>