doc: update install

This commit is contained in:
sy-records 2022-10-24 09:35:20 +08:00
parent b851f5fb12
commit d8f3d40db6
No known key found for this signature in database
GPG Key ID: C3BB4FF13CD72ACE
2 changed files with 20 additions and 20 deletions

View File

@ -37,15 +37,14 @@ vim /var/data/conf/config.yaml
# After configuring the configuration file, you can start the mirror again to start the service # After configuring the configuration file, you can start the mirror again to start the service
$ docker start answer $ docker start answer
``` ```
## Binary for Answer ## Binary for Answer
## Install Answer using binary ## Install Answer using binary
1. Unzip the compressed package. 1. Unzip the compressed package
2. Use the command cd to enter the directory you just created. 2. Use the command cd to enter the directory you just created
3. Execute the command ./answer init. 3. Execute the command ./answer init
4. Answer will generate a ./data directory in the current directory 4. Answer will generate a ./data directory in the current directory
5. Enter the data directory and modify the config.yaml file 5. Enter the data directory and modify the config.yaml file
6. Modify the database connection address to your database connection address 6. Modify the database connection address to your database connection address
@ -84,8 +83,8 @@ service_config:
secret_key: "answer" #encryption key secret_key: "answer" #encryption key
web_host: "http://127.0.0.1" #Page access using domain name address web_host: "http://127.0.0.1" #Page access using domain name address
upload_path: "./upfiles" #upload directory upload_path: "./upfiles" #upload directory
``` ```
## Compile the image ## Compile the image
If you have modified the source files and want to repackage the image, you can use the following statement to repackage the image If you have modified the source files and want to repackage the image, you can use the following statement to repackage the image
``` ```

View File

@ -1,20 +1,20 @@
# Answer 安装指引 # Answer 安装指引
安装 Answer 之前,您需要先安装基本环境。 安装 Answer 之前您需要先安装基本环境。
- 数据库 - 数据库
- [MySQL](http://dev.mysql.com):版本 >= 5.7 - [MySQL](http://dev.mysql.com):版本 >= 5.7
然后,您可以通过以下几种方式来安装 Answer 然后,您可以通过以下几种方式来安装 Answer
- 采用 Docker 部署 - 采用 Docker 部署
- 二进制安装 - 二进制安装
- 源码安装 - 源码安装
## 使用Docker 安装 Answer ## 使用Docker 安装 Answer
可以从 Docker Hub 或者 GitHub Container registry 下载最新的tags 镜像 可以从 Docker Hub 或者 GitHub Container registry 下载最新的 tags 镜像
### 用法 ### 用法
将配置和存储目录挂在到镜像之外 volume (/var/data -> /data),你可以修改外部挂载地址 将配置和存储目录挂在到镜像之外 volume (/var/data -> /data)你可以修改外部挂载地址
``` ```
# 将镜像从 docker hub 拉到本地 # 将镜像从 docker hub 拉到本地
@ -27,7 +27,7 @@ $ mkdir -p /var/data
$ docker run --name=answer -p 9080:80 -v /var/data:/data answer/answer $ docker run --name=answer -p 9080:80 -v /var/data:/data answer/answer
# 第一次启动后会在/var/data 目录下生成配置文件 # 第一次启动后会在/var/data 目录下生成配置文件
π# /var/data/conf/config.yaml # /var/data/conf/config.yaml
# 需要修改配置文件中的Mysql 数据库地址 # 需要修改配置文件中的Mysql 数据库地址
vim /var/data/conf/config.yaml vim /var/data/conf/config.yaml
@ -37,20 +37,21 @@ vim /var/data/conf/config.yaml
# 配置好配置文件后可以再次启动镜像即可启动服务 # 配置好配置文件后可以再次启动镜像即可启动服务
$ docker start answer $ docker start answer
``` ```
## 使用二进制 安装 Answer ## 使用二进制 安装 Answer
可以使用编译完成的各个平台的二进制文件运行 Answer 项目 可以使用编译完成的各个平台的二进制文件运行 Answer 项目
### 用法 ### 用法
从GitHub 最新版本的tag中下载对应平台的二进制文件压缩包 GitHub 最新版本的tag中下载对应平台的二进制文件压缩包
1. 解压压缩包 1. 解压压缩包
2. 使用命令 cd 进入到刚刚创建的目录 2. 使用命令 cd 进入到刚刚创建的目录
3. 执行命令 ./answer init 3. 执行命令 ./answer init
4. Answer 会在当前目录生成./data 目录 4. Answer 会在当前目录生成 ./data 目录
5. 进入data目录修改config.yaml文件 5. 进入 data 目录修改 config.yaml 文件
6. 将数据库连接地址修改为你的数据库连接地址 6. 将数据库连接地址修改为你的数据库连接地址
connection: [username]:[password]@tcp([host]:[port])/[DbName] connection: [username]:[password]@tcp([host]:[port])/[DbName]
7. 退出data 目录 执行 ./answer run -c ./data/conf/config.yaml 7. 退出 data 目录,执行 ./answer run -c ./data/conf/config.yaml
## 当前支持的命令 ## 当前支持的命令
用法: answer [command] 用法: answer [command]
@ -75,7 +76,7 @@ data:
i18n: i18n:
bundle_dir: "/data/i18n" #国际化文件存放目录 bundle_dir: "/data/i18n" #国际化文件存放目录
swaggerui: swaggerui:
show: true #是否显示swaggerapi文档,地址 /swagger/index.html show: true #是否显示swaggerapi文档地址 /swagger/index.html
protocol: http #swagger 协议头 protocol: http #swagger 协议头
host: 127.0.0.1 #可被访问的ip地址或域名 host: 127.0.0.1 #可被访问的ip地址或域名
address: ':80' #可被访问的端口号 address: ':80' #可被访问的端口号
@ -83,12 +84,12 @@ service_config:
secret_key: "answer" #加密key secret_key: "answer" #加密key
web_host: "http://127.0.0.1" #页面访问使用域名地址 web_host: "http://127.0.0.1" #页面访问使用域名地址
upload_path: "./upfiles" #上传目录 upload_path: "./upfiles" #上传目录
``` ```
## 编译镜像 ## 编译镜像
如果修改了源文件并且要重新打包镜像可以使用以下语句重新打包镜像 如果修改了源文件并且要重新打包镜像可以使用以下语句重新打包镜像
``` ```
docker build -t answer:v1.0.0 . docker build -t answer:v1.0.0 .
``` ```
## 常见问题 ## 常见问题
1. 项目无法启动,answer主程序启动依赖配置文件config.yaml 、国际化翻译目录 /i18n 、上传文件存放目录/upfiles 需要确保项目启动时加载了配置文件 answer run -c config.yaml 以及在config.yaml 正确的指定i18n 和 upfiles 目录的配置项 1. 项目无法启动answer 主程序启动依赖配置文件 config.yaml 、国际化翻译目录 /i18n 、上传文件存放目录 /upfiles需要确保项目启动时加载了配置文件 answer run -c config.yaml 以及在 config.yaml 正确的指定 i18n 和 upfiles 目录的配置项