diff --git a/install/v3/install-built-in.md b/install/v3/install-built-in.md index 01f0109..b7f8c81 100644 --- a/install/v3/install-built-in.md +++ b/install/v3/install-built-in.md @@ -14,8 +14,8 @@ meta: 在正式安装 kuboard v3 之前，需做好一个简单的部署计划的设计，在本例中，各组件之间的连接方式，如下图所示： -* 假设用户通过 http://外网IP:10080 访问 Kuboard v3； -* 安装在 Kubernetes 中的 Kuboard Agent 通过 `内网IP` 访问 Kuboard 的 Web 服务端口 10080 和 Kuboard Agent Server 端口 10081。 +* 假设用户通过 http://外网IP:80 访问 Kuboard v3； +* 安装在 Kubernetes 中的 Kuboard Agent 通过 `内网IP` 访问 Kuboard 的 Web 服务端口 80 和 Kuboard Agent Server 端口 10081。

@@ -38,10 +38,10 @@ meta: 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 \ - -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" \ -v /root/kuboard-data:/data \ @@ -61,7 +61,7 @@ sudo docker run -d \ ::: tip 参数解释 * 建议将此命令保存为一个 shell 脚本，例如 `start-kuboard.sh`，后续升级 Kuboard 或恢复 Kuboard 时，需要通过此命令了解到最初安装 Kuboard 时所使用的参数； -* 第 4 行，将 Kuboard Web 端口 80 映射到宿主机的 `10080` 端口（您可以根据自己的情况选择宿主机的其他端口）； +* 第 4 行，将 Kuboard Web 端口 80 映射到宿主机的 `80` 端口（您可以根据自己的情况选择宿主机的其他端口）； * 第 5、6 行，将 Kuboard Agent Server 的端口 `10081/udp`、`10081/tcp` 映射到宿主机的 `10081` 端口（您可以根据自己的情况选择宿主机的其他端口）； * 第 7 行，指定 KUBOARD_ENDPOINT 为 `http://内网IP`，如果后续修改此参数，需要将已导入的 Kubernetes 集群从 Kuboard 中删除，再重新导入； * 第 8、9 行，指定 KUBOARD_AGENT_SERVER 的端口为 `10081`，此参数与第 5、6 行中的宿主机端口应保持一致，修改此参数不会改变容器内监听的端口 `10081`； @@ -70,7 +70,7 @@ sudo docker run -d \ ## 访问 Kuboard v3.x -在浏览器输入 `http://your-host-ip:10080` 即可访问 Kuboard v3.x 的界面，登录方式： +在浏览器输入 `http://your-host-ip:80` 即可访问 Kuboard v3.x 的界面，登录方式： * 用户名： `admin` * 密 码： `Kuboard123` diff --git a/install/v3/install-github.md b/install/v3/install-github.md index 4249471..fc411e2 100644 --- a/install/v3/install-github.md +++ b/install/v3/install-github.md @@ -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) diff --git a/install/v3/install-gitlab.md b/install/v3/install-gitlab.md index 67f081c..bdad99c 100644 --- a/install/v3/install-gitlab.md +++ b/install/v3/install-gitlab.md @@ -30,9 +30,9 @@ Kuboard 支持多种认证方式： 在正式安装 kuboard v3 之前，需做好一个简单的部署计划的设计，在本例中，各组件之间的连接方式，如下图所示： * 用户通过 http://gitlab.this-is-a-sample.com 访问 gitlab； -* 用户通过 http://外网IP:10080 访问 Kuboard v3； +* 用户通过 http://外网IP:80 访问 Kuboard v3； * Kuboard 通过 http://gitlab.this-is-a-sample.com 访问 GitLab API； -* 安装在 Kubernetes 中的 Kuboard Agent 通过 `内网IP:10080` 访问 Kuboard 的 Web 服务端口 10080 和 Kuboard Agent Server 端口 10081。 +* 安装在 Kubernetes 中的 Kuboard Agent 通过 `内网IP:80` 访问 Kuboard 的 Web 服务端口 80 和 Kuboard Agent Server 端口 10081。 ![image-20210109224438846](./install-gitlab.assets/image-20210120224425355.png) @@ -54,7 +54,7 @@ Kuboard 支持多种认证方式： | 字段名称 | 字段取值 | 字段说明 | | ------------ | ------------------------------------------ | ------------------------------------------------------------ | | Name | kuboad-v3 | 应用程序在 GitLab 中的标识，例如，此处填写了 kuboard-v3 | -| Redirect URI | http://外网IP:10080/sso/callback | 登录成功后的回调 URL，必须填写绝对路径，且必须指定到 kuboard 的 `/sso/callback` 路径 | +| Redirect URI | http://外网IP:80/sso/callback | 登录成功后的回调 URL，必须填写绝对路径，且必须指定到 kuboard 的 `/sso/callback` 路径 | | Scopes | read_user / openid / profile / email | 应用程序可以访问的 GitLab 接口范围，对于 Kuboard 而言，必须勾选如下几个选项： read_user / openid / profile / email | ![image-20201113212028264](./install-gitlab.assets/image-20201113212028264.png) @@ -72,12 +72,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="gitlab" \ - -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" \ @@ -100,11 +100,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 与 GitLab 进行单点登录集成时，必须指定环境变量 `KUBOARD_LOGIN_TYPE` 为 `gitlab` （适用于 gitlab.com / gitlab-ee / gitlab-ce）； -* 第 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`，使用该 GitLab 用户登录到 Kuboard 以后，该用户具备 Kuboard 的所有权限； * 第 13 行，指定 `GIBLAB_BASE_URL`，（如 [部署计划](#部署计划) 中所描述，本例子中，使用 `http://gitlab.this-is-a-sample.com` 作为通过作为 GitLab 的访问 URL，并假设 GitLab 已经事先准备就绪，如果不指定，该参数默认值为 `https://gitlab.com`）；此参数不能以 `/` 结尾； @@ -114,7 +114,7 @@ sudo docker run -d \ ## 访问 Kuboard 界面 -* 在浏览器中输入 `http://外网IP:10080`，您将被重定向到 GitLab 登录界面； +* 在浏览器中输入 `http://外网IP:80`，您将被重定向到 GitLab 登录界面； * 在 GitLab 登录界面使用 docker run 命令中 `KUBOARD_ROOT_USER` 参数指定的用户完成登录后，GitLab 将提示您是否授权访问 Kuboard，如下图所示： ![image-20201113215827177](./install-gitlab.assets/image-20201113215827177.png) diff --git a/install/v3/install-ldap.md b/install/v3/install-ldap.md index fad58b9..c9a5784 100644 --- a/install/v3/install-ldap.md +++ b/install/v3/install-ldap.md @@ -30,9 +30,9 @@ Kuboard 支持多种认证方式： 在正式安装 kuboard v3 之前，需做好一个简单的部署计划的设计，在本例中，各组件之间的连接方式，如下图所示： -* 用户通过 http://外网IP:10080 访问 Kuboard v3； +* 用户通过 http://外网IP:80 访问 Kuboard v3； * Kuboard 通过 `localhost:389` 和 `localhost:636` 访问 LDAP； -* 安装在 Kubernetes 中的 Kuboard Agent 通过 `内网IP:10080` 访问 Kuboard 的 Web 服务端口 10080 和 Kuboard Agent Server 端口 10081。 +* 安装在 Kubernetes 中的 Kuboard Agent 通过 `内网IP:80` 访问 Kuboard 的 Web 服务端口 80 和 Kuboard Agent Server 端口 10081。 ![image-20210109231936944](./install-ldap.assets/image-20210120224708873.png) @@ -131,12 +131,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 /Users/shaohuanqing/temp/kuboard-data:/data \ -e KUBOARD_LOGIN_TYPE="ldap" \ - -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" \ @@ -170,11 +170,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 与 GitLab 进行单点登录集成时，必须指定环境变量 `KUBOARD_LOGIN_TYPE` 为 `gitlab` （适用于 gitlab.com / gitlab-ee / gitlab-ce）； -* 第 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`，使用该 GitLab 用户登录到 Kuboard 以后，该用户具备 Kuboard 的所有权限； ::: @@ -206,7 +206,7 @@ LDAP 相关的参数相对复杂，本章节以 Kuboard 集成 LDAP 时，对 LD ## 访问 Kuboard 界面 -* 在浏览器中输入 `http://外网IP:10080`，将进入登录界面； +* 在浏览器中输入 `http://外网IP:80`，将进入登录界面； * 在登录界面中输入您在 LDAP 中的用户名、密码，并点击登录按钮，您将可以成功登录 Kuboard。 ::: tip 浏览器兼容性 diff --git a/install/v3/proxy.md b/install/v3/proxy.md index ec9305b..22eb771 100644 --- a/install/v3/proxy.md +++ b/install/v3/proxy.md @@ -45,12 +45,12 @@ http { server_name kuboard.this-is-a-sample.com; # 替换成你的域名 location / { - proxy_pass http://192.168.32.205:10080/; # 替换成你的 Kuboard IP 地址和端口，应该是 IP 地址，而不是 KUBOARD_ENDPOINT 参数的值 + proxy_pass http://192.168.32.205:80/; # 替换成你的 Kuboard IP 地址和端口，应该是 IP 地址，而不是 KUBOARD_ENDPOINT 参数的值 gzip on; } location /k8s-ws/ { - proxy_pass http://192.168.32.205:10080/k8s-ws/; # 替换成你的 Kuboard IP 地址和端口 + proxy_pass http://192.168.32.205:80/k8s-ws/; # 替换成你的 Kuboard IP 地址和端口 proxy_http_version 1.1; proxy_pass_header Authorization; proxy_set_header Upgrade "websocket"; @@ -62,7 +62,7 @@ http { } location /k8s-proxy/ { - proxy_pass http://192.168.32.205:10080/k8s-proxy/; # 替换成你的 Kuboard IP 地址和端口 + proxy_pass http://192.168.32.205:80/k8s-proxy/; # 替换成你的 Kuboard IP 地址和端口 proxy_http_version 1.1; proxy_pass_header Authorization; proxy_set_header Upgrade $http_upgrade;