MinDoc 的配置文件是 ini 格式。支持从环境变量中读取配置，例如：

  1. httpport="${MINDOC_PORT||8181}"

系统会优先从环境变量 MINDOC_PORT 中读取端口号，如果不存在，则默认使用8181端口。在使用 Docker 部署时，可以不用修改配置文件，直接传递环境变量即可。如果非 Docker 部署，又没有使用环境变量，可直接设置值即可：httpport=8181。

详细配置如下：

  1. appname = mindoc
  3. #默认监听的网卡,为空则监听所有
  4. httpaddr="${MINDOC_ADDR}"
  5. httpport = "${MINDOC_PORT||8181}"
  6. runmode = "${MINDOC_RUN_MODE||dev}"
  7. sessionon = true
  8. sessionname = mindoc_id
  9. copyrequestbody = true
  11. #系统完整 URL(http://doc.iminho.me),如果该项不设置，会从请求头中获取地址。
  12. baseurl="${MINDOC_BASE_URL}"
  15. #########代码高亮样式################
  16. #样式演示地址：https://highlightjs.org/static/demo/
  17. highlight_style="${MINDOC_HIGHLIGHT_STYLE||github}"
  19. ########配置文件自动加载##################
  20. #大于0时系统会自动检测配置文件是否变动，变动后自动加载并生效,单位是秒。监听端口和数据库配置无效
  21. config_auto_delay="${MINDOC_CONFIG_AUTO_DELAY||20}"
  24. ########Session 储存方式##############
  26. #默认 Session 生成 Key 的秘钥
  27. beegoserversessionkey=NY1B$28pms12JM&c
  28. sessionprovider="${MINDOC_SESSION_PROVIDER||file}"
  29. sessionproviderconfig="${MINDOC_SESSION_PROVIDER_CONFIG||./runtime/session}"
  30. #默认的过期时间
  31. sessiongcmaxlifetime="${MINDOC_SESSION_MAX_LIFETIME||3600}"
  33. #以文件方式储存
  34. #sessionprovider=file
  35. #sessionproviderconfig=./runtime/session
  37. #以 redis 方式储存
  38. #sessionprovider=redis
  39. #sessionproviderconfig=127.0.0.1:6379
  41. #以 memcache 方式储存
  42. #sessionprovider=memcache
  43. #sessionproviderconfig=127.0.0.1:11211
  45. #以内存方式托管 Session
  46. #sessionprovider=memory
  48. #时区设置
  49. timezone = Asia/Shanghai
  53. ####################MySQL 数据库配置###########################
  54. #支持 MySQL 和 sqlite3 两种数据库，如果是 sqlite3 则 db_database 标识数据库的物理目录
  55. db_adapter="${MINDOC_DB_ADAPTER||mysql}"
  56. db_host="${MINDOC_DB_HOST||127.0.0.1}"
  57. db_port="${MINDOC_DB_PORT||3306}"
  58. db_database="${MINDOC_DB_DATABASE||mindoc_db}"
  59. db_username="${MINDOC_DB_USERNAME||root}"
  60. db_password="${MINDOC_DB_PASSWORD||123456}"
  62. ####################sqlite3 数据库配置###########################
  63. #db_adapter=sqlite3
  64. #db_database=./database/mindoc.db
  66. #项目默认封面
  67. cover=/static/images/book.jpg
  69. #默认头像
  70. avatar=/static/images/headimgurl.jpg
  72. #默认阅读令牌长度
  73. token_size=12
  75. #上传文件的后缀,如果不限制后缀可以设置为 *
  76. upload_file_ext=txt|doc|docx|xls|xlsx|ppt|pptx|pdf|7z|rar|jpg|jpeg|png|gif
  78. #上传的文件大小限制,如果不填写,默认不限制，单位可以是 GB KB MB
  79. upload_file_size=10MB
  81. ####################邮件配置######################
  82. #是否启用邮件
  83. enable_mail="${MINDOC_ENABLE_MAIL||false}"
  84. #每小时限制指定邮箱邮件发送次数
  85. mail_number="${MINDOC_MAIL_NUMBER||5}"
  86. #smtp 服务用户名
  87. smtp_user_name="${MINDOC_SMTP_USER_NAME||admin@iminho.me}"
  88. #smtp 服务器地址
  89. smtp_host="${MINDOC_SMTP_HOST||smtp.163.com}""
  90. #smtp 密码
  91. smtp_password="${MINDOC_SMTP_PASSWORD}"
  92. #端口号
  93. smtp_port="${MINDOC_SMTP_PORT||25}""
  94. #发送邮件的显示名称
  95. form_user_name="${MINDOC_FORM_USERNAME||admin@iminho.me}"
  96. #邮件有效期30分钟
  97. mail_expired="${MINDOC_EXPIRED||30}"
  98. #加密类型 NONE 无认证、SSL 加密、LOGIN 普通用户登录
  99. secure="${MINDOC_MAIL_SECURE||LOGIN}"
  101. ###############配置导出项目###################
  102. enable_export="${MINDOC_ENABLE_EXPORT||false}"
  103. #同一个项目同时运行导出程序的并行数量，取值1-4之间，取值越大导出速度越快，越占用资源
  104. export_process_num="${MINDOC_EXPORT_PROCESS_NUM||1}"
  106. #并发导出的项目限制，指同一时间限制的导出项目数量，如果为0则不限制。设置的越大，越占用资源
  107. export_limit_num="${MINDOC_EXPORT_LIMIT_NUM||5}"
  109. #指同时等待导出的任务数量
  110. export_queue_limit_num="${MINDOC_EXPORT_QUEUE_LIMIT_NUM||100}"
  112. #导出项目的缓存目录配置
  113. export_output_path="${MINDOC_EXPORT_OUTPUT_PATH||./runtime/cache}"
  115. ################百度地图密钥#################
  116. baidumapkey=
  118. ################Active Directory/LDAP################
  119. #是否启用 ldap
  120. ldap_enable=false
  121. #ldap 主机名
  122. ldap_host=ad.example.com
  123. #ldap 端口
  124. ldap_port=3268
  125. #ldap 内哪个属性作为用户名
  126. ldap_attribute=sAMAccountName
  127. #搜索范围
  128. ldap_base=DC=example,DC=com
  129. #第一次绑定 ldap 用户 dn
  130. ldap_user=CN=ldap helper,OU=example.com,DC=example,DC=com
  131. #第一次绑定 ldap 用户密码
  132. ldap_password=superSecret
  133. #自动注册用户角色：0 超级管理员 /1 管理员/ 2 普通用户 
  134. ldap_user_role=2
  135. #ldap 搜索 filter 规则,AD 服务器: objectClass=User, openldap 服务器: objectClass=posixAccount ,也可以定义为其他属性,如: title=mindoc
  136. ldap_filter=objectClass=posixAccount
  138. ###############配置 CDN 加速##################
  139. cdn="${MINDOC_CDN_URL}"
  140. cdnjs="${MINDOC_CDN_JS_URL}"
  141. cdncss="${MINDOC_CDN_CSS_URL}"
  142. cdnimg="${MINDOC_CDN_IMG_URL}"
  144. ######################缓存配置###############################
  146. #是否开启缓存，true 开启 / false 不开启
  147. cache="${MINDOC_CACHE||false}"
  149. #缓存方式:memory/memcache/redis/file
  150. cache_provider="${MINDOC_CACHE_PROVIDER||memory}"
  152. #当配置缓存方式为 memory 时,内存回收时间,单位是秒
  153. cache_memory_interval="${MINDOC_CACHE_MEMORY_INTERVAL||120}"
  155. #当缓存方式配置为 file 时,缓存的储存目录
  156. cache_file_path="${MINDOC_CACHE_FILE_PATH||./runtime/cache/}"
  158. #缓存文件后缀
  159. cache_file_suffix="${MINDOC_CACHE_FILE_SUFFIX||.bin}"
  161. #文件缓存目录层级
  162. cache_file_dir_level="${MINDOC_CACHE_FILE_DIR_LEVEL||2}"
  164. #文件缓存的默认过期时间
  165. cache_file_expiry="${MINDOC_CACHE_FILE_EXPIRY||3600}"
  167. #memcache 缓存服务器地址
  168. cache_memcache_host="${MINDOC_CACHE_MEMCACHE_HOST||127.0.0.1:11211}"
  170. #redis 服务器地址
  171. cache_redis_host="${MINDOC_CACHE_REDIS_HOST||127.0.0.1:6379}"
  173. #redis 数据库索引
  174. cache_redis_db="${MINDOC_CACHE_REDIS_DB||0}"
  176. #redis 服务器密码
  177. cache_redis_password="${MINDOC_CACHE_REDIS_PASSWORD}"
  179. #缓存键的前缀
  180. cache_redis_prefix="${MINDOC_CACHE_REDIS_PREFIX||mindoc::cache}"
  183. #########日志储存配置##############
  185. #日志保存路径，在 linux 上，自动创建的日志文件请不要删除，否则将无法写入日志
  186. log_path="${MINDOC_LOG_PATH||./runtime/logs}"
  188. #每个文件保存的最大行数，默认值 1000000
  189. log_maxlines="${MINDOC_LOG_MAX_LINES||1000000}"
  191. # 每个文件保存的最大尺寸，默认值是 1 << 28, //256 MB
  192. log_maxsize="${MINDOC_LOG_MAX_SIZE}"
  194. # 是否按照每天 logrotate，默认是 true
  195. log_daily="${MINDOC_LOG_DAILY||true}"
  197. # 文件最多保存多少天，默认保存 7 天
  198. log_maxdays="${MINDOC_LOG_MAX_DAYS||30}"
  200. # 日志保存的时候的级别，默认是 Trace 级别,可选值： Emergency/Alert/Critical/Error/Warning/Notice/Informational/Debug/Trace
  201. log_level="${MINDOC_LOG_LEVEL||Trace}"
  203. # 是否异步生成日志，默认是 true
  204. log_is_async="${MINDOC_LOG_IS_ASYNC||TRUE}"