diff --git a/README.md b/README.md index 2200e6ec..b8647536 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,8 @@ MinDoc 使用MySQL储存数据,且编码必须是`utf8mb4_general_ci`。请在 如果 MinDoc 根目录下存在 install.lock 文件表示已经初始化过数据库,想要重新初始化数据库,只需要删除该文件重新启动程序即可。 +**默认程序会自动创建表,同时初始化一个超级管理员用户:admin 密码:123456 。请登录后重新设置密码。** + ## Linux 下后台运行 在 Linux 如果想让程序后台运行可以执行如下命令: @@ -46,11 +48,54 @@ nohup ./godoc & Windows 下后台运行需要借助 CMD 命令行命令: +```bash +#在MinDoc跟目录下新建一个slave.vbs文件: + +Set ws = CreateObject("Wscript.Shell") +ws.run "cmd /c start.bat",vbhide + +#再建一个start.bat文件: +@echo off + +godoc_windows_amd64.exe + +``` + +启动时双击slave.vbs即可,等待程序初始化完数据库会在该目录下创建一个install.lock文件,标识已安装成功。 + +如果是自己编译,可以用以下命令即可编译出不依赖cmd命令的后台运行的程序: + ```bash go build -ldflags "-H=windowsgui" ``` -通过该命令编译的Golang程序在Windows上默认后台运行。同时将 MinDoc 加入开机启动列表,可以使程序开机启动。 +通过该命令编译的Golang程序在Windows上默认后台运行。 + +请将将 MinDoc 加入开机启动列表,使程序开机启动。 + +## 密码找回功能 + +密码找回功能依赖邮件服务,因此,需要配置邮件服务才能使用该功能,该配置位于 `conf/app.conf` 中: + +```bash + +#邮件配置 +#是否启用邮件 +enable_mail=true +#smtp服务器的账号 +smtp_user_name=admin@iminho.me +#smtp服务器的地址 +smtp_host=smtp.ym.163.com +#密码 +smtp_password=1q2w3e__ABC +#端口号 +smtp_port=25 +#邮件发送人的地址 +form_user_name=admin@iminho.me +#邮件有效期30分钟 +mail_expired=30 +``` + # 使用Docker部署