mirror of https://gitee.com/answerdev/answer.git
docs(README): Update CONTRIBUTING and Installation link address in README.md
This commit is contained in:
LinkinStar
parent
012bcdc071
commit
2cc8523483
|
|
@ -1,8 +0,0 @@
|
|||
# Contributing to answer
|
||||
## Coding and documentation Style
|
||||
|
||||
To be developed.
|
||||
|
||||
## Submitting Modifications
|
||||
|
||||
To be developed.
|
||||
70
INSTALL.md
70
INSTALL.md
|
|
@ -1,70 +0,0 @@
|
|||
# Answer installation guide
|
||||
## Environment Preparation
|
||||
- Memory >= 512M
|
||||
- If using MySQL version >= 5.7
|
||||
|
||||
## Installing with docker
|
||||
### Step 1: Start the project with the docker command
|
||||
```bash
|
||||
docker run -d -p 9080:80 -v answer-data:/data --name answer answerdev/answer:latest
|
||||
```
|
||||
|
||||
### Step 2: Visit the installation url
|
||||
[http://127.0.0.1:9080/install](http://127.0.0.1:9080/install)
|
||||
|
||||
After selecting the language click next to select the appropriate database, if you just want to experience it currently, it is recommended to select sqlite as the database directly, as shown below
|
||||
|
||||
|
||||
|
||||
Then click next to create the configuration file, click next to enter the basic website information and administrator information, as shown below
|
||||
|
||||
|
||||
|
||||
Click Next to complete the installation
|
||||
|
||||
### Step 3: After installation, visit the project path to start using
|
||||
[http://127.0.0.1:9080/](http://127.0.0.1:9080/)
|
||||
|
||||
Login with the administrator username and password you just created.
|
||||
|
||||
## Installing with docker-compose
|
||||
### Step 1: Start the project with the docker-compose command
|
||||
```bash
|
||||
mkdir answer && cd answer
|
||||
wget https://raw.githubusercontent.com/answerdev/answer/main/docker-compose.yaml
|
||||
docker-compose up
|
||||
```
|
||||
|
||||
### Step 2: Visit the installation url
|
||||
[http://127.0.0.1:9080/install](http://127.0.0.1:9080/install)
|
||||
|
||||
The exact configuration is the same as for docker use
|
||||
|
||||
### Step 3: After installation, visit home page
|
||||
[http://127.0.0.1:9080/](http://127.0.0.1:9080/)
|
||||
|
||||
## Install with binary
|
||||
### Step 1: Download the binaries
|
||||
[https://github.com/answerdev/answer/releases](https://github.com/answerdev/answer/releases)
|
||||
Download the version you need for your current system
|
||||
|
||||
### Step 2: Install using command line
|
||||
> The following command -C specifies the data directory required for answer, you can modify it as you see fit
|
||||
|
||||
```bash
|
||||
INSTALL_PORT=9080 ./answer init -C ./answer-data/
|
||||
```
|
||||
|
||||
Then visit: [http://127.0.0.1:9080/install](http://127.0.0.1:9080/install) to install, the configuration is the same as using docker installation
|
||||
|
||||
### Step 3: Start with command line
|
||||
After the installation is complete, the program will exit, so use the command to start the project formally
|
||||
```bash
|
||||
./answer run -C ./answer-data/
|
||||
```
|
||||
*Note*: You may want to check `./answer-data/conf/config.yaml` and confirm the settings there before running.
|
||||
|
||||
After normal startup you can access [http://127.0.0.1:9080/](http://127.0.0.1:9080/) to log in using the administrator username password specified during installation
|
||||
|
||||
## Installation FAQ
|
||||
- Having trouble reinstalling using docker? The default command we give is to use `answer-data` to name the volume, so if you don't need the original data again, please delete it voluntarily `docker volume rm answer-data`
|
||||
|
|
@ -1,68 +0,0 @@
|
|||
# Answer 安装指引
|
||||
## 环境准备
|
||||
- 内存 >= 512M
|
||||
- 如果使用 MySQL 版本 >= 5.7
|
||||
|
||||
## 使用 docker 安装
|
||||
### 步骤 1: 使用 docker 命令启动项目
|
||||
```bash
|
||||
docker run -d -p 9080:80 -v answer-data:/data --name answer answerdev/answer:latest
|
||||
```
|
||||
### 步骤 2: 访问安装路径进行项目安装
|
||||
[http://127.0.0.1:9080/install](http://127.0.0.1:9080/install)
|
||||
|
||||
选择语言后点击下一步选择合适的数据库，如果当前只是想体验，建议直接选择 sqlite 作为数据库，如下图所示
|
||||
|
||||
|
||||
|
||||
然后点击下一步会进行配置文件创建等操作，点击下一步输入网站基本信息和管理员信息，如下图所示
|
||||
|
||||
|
||||
|
||||
点击下一步即可安装完成
|
||||
|
||||
### 步骤 3：安装完成后访问项目路径开始使用
|
||||
[http://127.0.0.1:9080/](http://127.0.0.1:9080/)
|
||||
|
||||
使用刚才创建的管理员用户名密码即可登录。
|
||||
|
||||
## 使用 docker-compose 安装
|
||||
### 步骤 1: 使用 docker-compose 命令启动项目
|
||||
```bash
|
||||
mkdir answer && cd answer
|
||||
wget https://raw.githubusercontent.com/answerdev/answer/main/docker-compose.yaml
|
||||
docker-compose up
|
||||
```
|
||||
|
||||
### 步骤 2: 访问安装路径进行项目安装
|
||||
[http://127.0.0.1:9080/install](http://127.0.0.1:9080/install)
|
||||
|
||||
具体配置与 docker 使用时相同
|
||||
|
||||
### 步骤 3：安装完成后访问项目路径开始使用
|
||||
[http://127.0.0.1:9080/](http://127.0.0.1:9080/)
|
||||
|
||||
## 使用 二进制 安装
|
||||
### 步骤 1: 下载二进制文件
|
||||
[https://github.com/answerdev/answer/releases](https://github.com/answerdev/answer/releases)
|
||||
请下载您当下系统所需要的对应版本
|
||||
|
||||
### 步骤 2: 使用命令行安装
|
||||
> 以下命令中 -C 指定的是 answer 所需的数据目录，您可以根据实际需要进行修改
|
||||
|
||||
```bash
|
||||
./answer init -C ./answer-data/
|
||||
```
|
||||
|
||||
然后访问：[http://127.0.0.1:9080/install](http://127.0.0.1:9080/install) 进行安装，具体配置与使用 docker 安装相同
|
||||
|
||||
### 步骤 3: 使用命令行启动
|
||||
安装完成之后程序会退出，请使用命令正式启动项目
|
||||
```bash
|
||||
./answer run -C ./answer-data/
|
||||
```
|
||||
|
||||
正常启动后可以访问 [http://127.0.0.1:9080/](http://127.0.0.1:9080/) 使用安装时指定的管理员用户名密码进行登录
|
||||
|
||||
## 安装常见问题
|
||||
- 使用 docker 重新安装遇到问题？默认我们给出的命令是使用 `answer-data` 命名卷，所以如果重新不需要原来的数据，请主动进行删除 `docker volume rm answer-data`
|
||||
|
|
@ -26,13 +26,13 @@ To learn more about the project, visit [answer.dev](https://answer.dev).
|
|||
docker run -d -p 9080:80 -v answer-data:/data --name answer answerdev/answer:latest
|
||||
```
|
||||
|
||||
For more information, see [INSTALL.md](./INSTALL.md)
|
||||
For more information, see [Installation](https://answer.dev/docs/installation)
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are always welcome!
|
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) for ways to get started.
|
||||
See [CONTRIBUTING](https://answer.dev/docs/development/contributing/) for ways to get started.
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
|
|
@ -26,13 +26,13 @@
|
|||
docker run -d -p 9080:80 -v answer-data:/data --name answer answerdev/answer:latest
|
||||
```
|
||||
|
||||
其他安装配置细节请参考 [INSTALL_CN.md](./INSTALL_CN.md)
|
||||
其他安装配置细节请参考 [Installation](https://answer.dev/docs/installation)
|
||||
|
||||
## 贡献
|
||||
|
||||
我们随时欢迎你的贡献!
|
||||
|
||||
参考 [CONTRIBUTING.md](CONTRIBUTING.md) 开始贡献。
|
||||
参考 [CONTRIBUTING](https://answer.dev/docs/development/contributing/) 开始贡献。
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue