配置文件说明

>w **警告提示**
>
>如果使用 Windows 自带的记事本编辑配置文件，一定要保存为「UTF-8 无 BOM」的格式。

MrDoc 无需配置、开箱即用。

同时，MrDoc 还支持使用配置文件自定义站点的一些配置项。
## 配置文件位置
配置文件位于项目（`MrDoc/config/`） 文件夹内，名为`config.ini`。

>d  **如果文件夹内无此文件，可以自行创建**

>i **提示：如果应用已经运行，修改配置文件后，必须重启应用（Docker 部署方式重启 Docker 容器）。**
>**提示：如果应用已经运行，修改配置文件后，必须重启应用（Docker 部署方式重启 Docker 容器）。**
>**提示：如果应用已经运行，修改配置文件后，必须重启应用（Docker 部署方式重启 Docker 容器）。**

## 开启站点调试
默认情况下，站点为「非调试」模式，如果你需要开启站点调试模式，那么可以在配置文件中写入如下内容：
```配置内容
[site]
# True表示开启站点调试模式，False表示关闭站点调试模式
debug = True

```
>d **修改配置文件后，请重启应用/Docker容器。**
## 数据库配置

>i **信息提示**
>
>官方 Docker 镜像已包含 MySQL、PostgreSQL数据库依赖，Docker 部署方式无需额外安装
- PostgreSQL 数据库请安装psycopg，PostgreSQL >= 12
- MySQL 数据库请安装mysqlclient，MySQL >= 8.0
- Oracle 数据库请安装cx_Oracle，Oracle >= 19c

除 SQLite 外，MrDoc 还支持如下数据库：

- MySQL
- Oracle
- PostgreSQL
具体配置项如下所示：

```数据库配置
[database]
# engine，指定数据库类型，接受sqlite、mysql、oracle、postgresql
engine = mysql
# name表示数据库的名称
name = db_name
# user表示数据库用户名
user = db_user
# password表示数据库用户密码
password = db_pwd
# host表示数据库主机地址
host = db_host
# port表示数据库端口
port = db_port

```
>d **修改配置文件后，请重启应用/Docker容器。**
## 站点语言和时区配置
默认情况下，站点语言为「中文简体」，时区为`Asia/Shanghai`。

目前，MrDoc 支持如下语言：

- 中文简体(zh-hans)
- 中文繁體(zh-hant)
- English(en)
  
如果需要有其他语言和时区，可以进行如下配置：
```语言和时区配置
[locale]
# 语言
language = zh-hant
# 时区
timezone = America/Chicago
# 强制使用设置的语言，默认为False
force = True

```
>d **修改配置文件后，请重启应用/Docker容器。**
## Session 会话配置
```Session配置
[session]
# 会话过期时间，单位为秒，默认为1周
cookie_age = 604800
# 浏览器关闭即过期，默认为False
browser_close = True
# 安全Cookie，默认为False
cookie_secure = False
# HttpOnly，默认为True
cookie_httponly = True

```
>d **修改配置文件后，请重启应用/Docker容器。**
## PDF下载配置

>i **MrDoc 官方 docker 运行环境镜像无需配置**

MrDoc 内置了一个文集导出 PDF 的功能，这个功能依赖于 Chromium 和 chromedriver 程序。如果需要实现 PDF 导出功能，请先在计算机上安装 Chromium 或 Chrome，然后在配置文件中进行配置：

```PDF下载配置
[selenium]
# 在Windows环境下测试或使用，请配置driver = Chrome，否则不用配置 driver 参数
driver = Chrome
# 如果系统无法正确安装或识别chromedriver，请指定chromedriver在计算机上的绝对路径
driver_path = driver_path

```
>d **修改配置文件后，请重启应用/Docker容器。**
## 图片上传格式
默认情况下，MrDoc 允许`jpg,jpeg,gif,png,bmp,webp`这些格式的图片进行上传。如果你需要自定义允许上传图片的格式，可以在配置文件中写入（格式之间以英文逗号,分隔）：

```图片格式配置
[image_upload]
# 允许上传的图片格式
suffix_name = jpg,jpeg,gif,png,bmp,webp

```

>w **警告：SVG等支持嵌入代码的格式图片会带来极大的安全风险，请谨慎允许此类格式的图片上传。**

>d **修改配置文件后，请重启应用/Docker容器。**
## 扩展媒体目录
默认情况下，MrDoc 从media目录中寻找用户上传的媒体文件（图片、附件等），如果你的文档里的图片或文件使用的是别的目录，可以将目录复制到 MrDoc 的根目录之后，在配置文件中指定一个新的媒体目录：

```扩展媒体目录配置
[extend_media]
# 状态，默认为False
is_enable = True
# 目录路径
root_path = images

```
>d此功能只能作为临时之用途，站点中新上传的图片和附件还是会上传到 media 目录中。

>d **修改配置文件后，请重启应用/Docker容器。**

## CSRF 可信来源配置
HTTPS 的协议头没有传递给后端应用，导致 CSRF 验证失败可以用这个方法解决
```配置
[csrf_origin]
allow = 主机名

```
如果存在多个主机用英文逗号分隔，例如：
```实例
[csrf_origin]
allow = https://doc.xvzkl.com,http://doc.xvzkl.com

```