diff --git a/MinDoc-中的命令.md b/MinDoc-中的命令.md new file mode 100644 index 0000000..1acef07 --- /dev/null +++ b/MinDoc-中的命令.md @@ -0,0 +1,66 @@ +目前截至 v0.4 版本,MinDoc 支持以下的命令: + +### 数据库初始化命令: `install` + +该命令用于初始化数据库,并初始化默认的管理员账号。使用方法如下: + +`./godoc_linux_amd64 install` + +### 数据库升级命令: `migrate` + +该命令用于当升级程序时更新变更的数据库结构。使用方法如下: + +`./godoc_linux_amd64 migrate` + +**版本查看: `version`** + +该命令用于查看当前程序版本和最新程序版本。使用方法如下: + +`./godoc_linux_amd64 version` + +### 自定义配置选项 + +如果你的配置文件不位于默认的 conf/app.conf 中,可以在启动程序时指定配置文件路径: + +``` +./godoc_linux_amd64 -config="/var/www/conf/app.conf" +``` + +同理,你初始化数据库时,也可以指定配置文件路径: + +``` +./godoc_linux_amd64 install -config="/var/www/conf/app.conf" +``` + +### 自定义工作路径: + +如果你的静态文件不和程序在同一个目录中,则可以在启动时指定静态文件目录: + +``` +./godoc_linux_amd64 -dir="/var/www/mindoc" +``` + +静态文件包括static目录,views目录,uploads目录。 + +### 自定义日志目录 + +默认的日志文件位于工作目录下的logs目录中,如果你想自定义日志目录,除了通过Linux下的日志重定向功能外,可以通过指定日志目录功能实现自定义日志目录功能: + +``` +./godoc_linux_amd64 -log="/var/www/mindoc/logs" +``` + +### 服务相关命令 + +MinDoc 支持在Linux和Windows上以服务的方式后台执行,命令如下: + +``` +#安装服务 +./godoc_linux_amd64 service install + +#卸载服务 +./godoc_linux_amd64 service remove +``` + +执行服务安装后,会创建一个以 `mindocd` 为服务名的服务。 +