10080 - 80

This commit is contained in:
Shao Huan Qing
2021-06-02 16:23:05 +08:00
parent 84413d6466
commit d567aa9e0e
5 changed files with 33 additions and 33 deletions

View File

@ -31,9 +31,9 @@ Kuboard 支持多种认证方式:
在正式安装 kuboard v3 之前,需做好一个简单的部署计划的设计,在本例中,各组件之间的连接方式,如下图所示:
* 用户通过 https://github.com 访问 github.com
* 用户通过 `http://外网IP:10080` 访问 Kuboard v3
* 用户通过 `http://外网IP:80` 访问 Kuboard v3
* Kuboard 通过 https://github.com 访问 GitHub API
* 安装在 Kubernetes 中的 Kuboard Agent 通过 `内网IP:10080` 访问 Kuboard 的 Web 服务端口 80 / 443 和 Kuboard Agent Server 端口 10081。
* 安装在 Kubernetes 中的 Kuboard Agent 通过 `内网IP:80` 访问 Kuboard 的 Web 服务端口 80 / 443 和 Kuboard Agent Server 端口 10081。
![image-20210109224747134](./install-github.assets/image-20210120224541968.png)
@ -60,9 +60,9 @@ Kuboard 支持多种认证方式:
| 字段名称 | 字段取值 | 字段描述 |
| -------------------------- | ----------------------------------------- | ------------------------------------------------------------ |
| Application name | kuboard-v3 | 标识用,填写任意名称即可 |
| Homepage URL | http://外网IP:10080 | 根据 [部署计划](#部署计划),此处应该填写 http://外网IP:10080 |
| Homepage URL | http://外网IP:80 | 根据 [部署计划](#部署计划),此处应该填写 http://外网IP:80 |
| Application description | Kuboard v3.x | 描述,可以为空 |
| Authorization callback URL | http://外网IP:10080/sso/callback | 根据 [部署计划](#部署计划),此处应该填写 http://外网IP:10080/sso/callback`/sso/callback` 为 Kuboard 中处理 OAuth 回调的 URL 路径 |
| Authorization callback URL | http://外网IP:80/sso/callback | 根据 [部署计划](#部署计划),此处应该填写 http://外网IP:80/sso/callback`/sso/callback` 为 Kuboard 中处理 OAuth 回调的 URL 路径 |
![image-20210109221355583](./install-github.assets/image-20210109221355583.png)
@ -79,12 +79,12 @@ Kuboard 支持多种认证方式:
sudo docker run -d \
--restart=unless-stopped \
--name=kuboard \
-p 10080:80/tcp \
-p 80:80/tcp \
-p 10081:10081/udp \
-p 10081:10081/tcp \
-v /root/kuboard-data:/data \
-e KUBOARD_LOGIN_TYPE="github" \
-e KUBOARD_ENDPOINT="http://内网IP:10080" \
-e KUBOARD_ENDPOINT="http://内网IP:80" \
-e KUBOARD_AGENT_SERVER_UDP_PORT="10081" \
-e KUBOARD_AGENT_SERVER_TCP_PORT="10081" \
-e KUBOARD_ROOT_USER="shaohq" \
@ -106,11 +106,11 @@ sudo docker run -d \
::: tip 参数说明
* 建议将此命令保存为一个 shell 脚本,例如 `start-kuboard.sh`,后续升级 Kuboard 或恢复 Kuboard 时,需要通过此命令了解到最初安装 Kuboard 时所使用的参数;
* 第 4 行Kuboard v3.x 需要暴露 `80` 端口,如安装指令的第三行所示,默认映射到了宿主机的 `10080` 端口,您可以根据自己的情况选择宿主机的其他端口;
* 第 4 行Kuboard v3.x 需要暴露 `80` 端口,如安装指令的第三行所示,默认映射到了宿主机的 `80` 端口,您可以根据自己的情况选择宿主机的其他端口;
* 第 5、6 行Kuboard v3.x 需要暴露 `10081` 端口 TCP / UDP默认映射到了宿主机的 `10081` 端口,您可以根据自己的情况选择宿主机的其他端口;
* 第 7 行Kuboard v3.x 的持久化数据存储在 `/data` 目录,默认映射到了宿主机的 `/root/kuboard-data` 路径,请根据您自己的情况进行调整;
* 第 8 行,将 Kuboard v3.x 与 GitHub 进行单点登录集成时,必须指定环境变量 `KUBOARD_LOGIN_TYPE` 为 `github` (适用于 github.com / github-ee
* 第 9 行,必须指定 `KUBOARD_ENDPOINT` 环境变量为访问 Kuboard 界面的 URL如 [部署计划](#部署计划) 中所描述,本例子中,使用 `http://内网IP:10080` 作为通过执行此命令启动的 Kuboard 的访问 URL此参数不能以 `/` 结尾;
* 第 9 行,必须指定 `KUBOARD_ENDPOINT` 环境变量为访问 Kuboard 界面的 URL如 [部署计划](#部署计划) 中所描述,本例子中,使用 `http://内网IP:80` 作为通过执行此命令启动的 Kuboard 的访问 URL此参数不能以 `/` 结尾;
* 第 10、11 行,指定 KUBOARD_AGENT_SERVER 的端口为 `10081`,此参数与第 5、6 行中的宿主机端口应保持一致,修改此参数不会改变容器内监听的端口 `10081`
* 第 12 行,必须指定 `KUBOARD_ROOT_USER`,使用该 GitHub 用户登录到 Kuboard 以后,该用户具备 Kuboard 的所有权限;
* 第 13 行,必须指定 `GITHUB_CLIENT_ID`,该参数来自于 [准备 GitHub](#准备-github) 步骤中创建的 GitHub OAuth Application 的 `Client ID` 字段
@ -133,7 +133,7 @@ sudo docker run -d \
## 访问 Kuboard 界面
* 在浏览器中输入 `http://外网IP:10080`,您将被重定向到 GitHub 登录界面;
* 在浏览器中输入 `http://外网IP:80`,您将被重定向到 GitHub 登录界面;
* 在 GitHub 登录界面使用 docker run 命令中 `KUBOARD_ROOT_USER` 参数指定的用户完成登录后GitHub 将提示您是否授权访问 Kuboard如下图所示
![image-20201114164729229](./install-github.assets/image-20201114164729229.png)