MrDoc安装手册
简易运行
部署指南
Docker 部署 MrDoc(推荐)
官方 Docker 镜像部署
Linux 部署 MrDoc
使用 Nginx + uWSGI 部署 MrDoc
一键部署脚本
宝塔面板「Python 项目管理器1.9」部署
Windows 部署 MrDoc
使用 Waitress 部署
Windows 部署面板
更新升级说明
系统依赖库说明
开源版>专业版数据迁移步骤
原生部署转 Docker 部署
配置指南
配置文件说明
自定义数据库配置
文集生成 PDF 文件的配置
全文搜索配置
centos 7 下升级自带 sqlite3
配置站点语言
Docker 下使用 MySQL 数据库
MySQL 数据库支持 emoji 的配置
使用 Nginx 托管静态文件资源
使用 Nginx 开启 SSL / 设置 HTTPS
使用 Nginx 配置反向代理/绑定域名
常见问题
提示SQLite3版本错误怎么办?
管理员忘记密码怎么办?
如何进行站点数据备份/站点数据迁移?
开源版数据导出与导入
专业版数据导出与导入
报错:SyntaxError: invalid sysntax
MySQLdb._exceptions.OperationalError: (1366, "Incorrect string value:)
宝塔面板「Python项目管理器」虚拟环境使用问题
如何对站点数据进行备份?
查看日志/日志存储位置
故障排查
开源版与专业版功能对比
打赏赞助记录
专业版咨询/购买
本文档使用「觅思文档专业版」发布
-
+
首页
配置文件说明
MrDoc 无需配置、开箱即用。 同时,MrDoc 还支持使用配置文件自定义站点的一些配置项。 配置文件位于项目的`config`文件夹内,名为`config.ini`,**如果文件夹内无此文件,可以自行创建。** > d 提示:如果应用已经运行,修改配置文件后,需重启应用。 ## 开启站点调试 默认情况下,站点为「非调试」模式,如果你需要开启站点调试模式,那么可以在配置文件中写入如下内容: ``` [site] # True表示开启站点调试模式,False表示关闭站点调试模式 debug = True ``` ## 数据库配置 默认情况下,MrDoc 使用 SQLite 数据库。如果你有使用其他数据库的需求,可以在配置文件中指定数据库相关配置信息。 >d 配置数据库必须在执行`python manage.py makemigrations` 命令之前。否则,原有数据会丢失! >d 部署后更换数据库,务必进行数据导出备份,否则原有数据会丢失! > 除 SQLite 和 MySQL,其他数据库需要额外安装依赖库 除 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 ``` ## 站点语言和时区配置 默认情况下,站点语言为「中文简体」,时区为`Asia/Shanghai`。 目前,MrDoc 支持如下语言: - 中文简体(zh-hans) - 中文繁體(zh-hant) - English(en) 如果需要有其他语言和时区,可以进行如下配置: ``` [locale] language = zh-hant timezone = America/Chicago ``` ## PDF下载配置 > i MrDoc 官方 docker 运行环境镜像无需配置 MrDoc 内置了一个文集导出 PDF 的功能,这个功能依赖于 Chromium 和 chromedriver 程序。如果需要实现 PDF 导出功能,请先在计算机上安装 Chromium 或 Chrome,然后在配置文件中进行配置: ``` [selenium] # 在Windows环境下测试或使用,请配置driver = Chrome,否则不用配置 driver 参数 driver = Chrome # 如果系统无法正确安装或识别chromedriver,请指定chromedriver在计算机上的绝对路径 driver_path = driver_path ``` ## 图片上传格式 默认情况下,MrDoc 允许`jpg,jpeg,gif,png,bmp,webp`这些格式的图片进行上传。如果你需要自定义允许上传图片的格式,可以在配置文件中写入(格式之间以英文逗号,分隔): ``` [image_upload] suffix_name = jpg,jpeg,gif,png,bmp,webp ``` >d 警告:SVG等支持嵌入代码的格式图片会带来极大的安全风险,请谨慎允许此类格式的图片上传。 ## 扩展媒体目录 默认情况下,MrDoc 从`media`目录中寻找用户上传的媒体文件(图片、附件等),如果你的文档里的图片或文件使用的是别的目录,可以将目录复制到 MrDoc 的根目录之后,在配置文件中指定一个新的媒体目录: ``` [extend_media] is_enable = True root_path = images ``` > 此功能只能作为临时之用途,站点中新上传的图片和附件还是会上传到 media 目录中。 ## CSRF 可信来源配置 `开源版v0.8.7` `专业版v1.2.5` ``` [csrf_origin] allow = 主机名 ``` 例如: ``` [csrf_origin] allow = doc.mrdoc.pro,mrdoc.mrdoc.com ``` ## 跨域域名配置 ``` [cors_origin] allow = URL ``` 例如: ``` [cors_origin] allow = http://baidu.com,http://192.168.1.1:8008 ``` ## 开启 IFrame 嵌入支持 默认情况下,MrDoc 不支持被嵌入到跨域的`iframe`标签中。如果你需要将 MrDoc 嵌入到跨域的`iframe`标签中,可以进行如下配置: ``` [x_frame] option = ALLOWALL ``` ## 关闭 Sitemap 站点地图 默认情况下,MrDoc 开启网站的站点地图功能,如果你不需要此功能,可以在配置文件中进行关闭: ``` [sitemap] status = False ``` ## 附件预览(专业版) > i MrDoc 官方 docker 运行环境镜像无需配置 ``` [preview] # LibreOffice 程序路径,需自行在服务器上安装 libreoffice_path = C://Program Files//LibreOffice//program//soffice.exe ``` LibreOffice 安装方法见:[《LibreOffice 安装说明》](https://doc.mrdoc.pro/doc/44895/) ## 附件格式白名单校验(专业版) ``` [attachment_suffix] # 是否开启验证,True 表示开启,False表示关闭,默认为True # 关闭后上传的附件将不再验证指定的白名单格式 is_enable = False ``` ## 仓库账号配置(专业版) 在 MrDoc 专业版中,需要配置专业版私有仓库的账号以实现版本的更新检测功能。 ``` [liscense] git_user = 用户名 git_pwd = 用户密码 ```
州的先生
Feb. 8, 2023, 5:31 a.m.
0 条评论
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码
有效期