diff --git a/docs/en/_sidebar.md b/docs/en/_sidebar.md index 66c9b5ba1cf..b4e607aeedb 100644 --- a/docs/en/_sidebar.md +++ b/docs/en/_sidebar.md @@ -13,6 +13,7 @@ - [Distributed Deployment Guide](en/deployment/distributed-deployment-guide.md) - Deployment By Third-party Tool - [Install the HA Apollo cluster in Rainbond with one-click](en/deployment/third-party-tool-rainbond.md) + - [Quickly deploy Apollo based on the aaPanel](en/deployment/third-party-tool-btpanel.md) - Admin Guide - [Apollo Usage Guide](en/portal/apollo-user-guide.md) diff --git a/docs/en/deployment/third-party-tool-btpanel.md b/docs/en/deployment/third-party-tool-btpanel.md new file mode 100644 index 00000000000..31c9f16047b --- /dev/null +++ b/docs/en/deployment/third-party-tool-btpanel.md @@ -0,0 +1,73 @@ +## aaPanel Docker One-Click Install + +Go to [aaPanel official website](https://www.aapanel.com/new/download.html), Select the script to download and install(Skip this step if you already have it installed) + +# Deploy Apollo using aaPanel + +## Prerequisite + +To install aaPanel, go to the [aaPanel](https://www.aapanel.com/new/download.html#install) official website and select the corresponding script to download and install. + +## Deployment + +aaPanel(Applicable versions 7.0.11 and above) Deployment guidelines + +1. Log in to aaPanel and click `Docker` in the menu bar + + ![Docker](../images/deployment/btpanel/install.png) + +2. The first time you will be prompted to install the `Docker` and `Docker Compose` services, click Install Now. If it is already installed, please ignore it. + + ![install](../images/deployment/btpanel/install2.png) + +3. After the installation is complete, find `Apollo` in `One-Click Install` and click `install` + + ![install-Apollo](../images/deployment/btpanel/install-Apollo.png) + +4. configure basic information such as the domain name, ports to complete the installation + + Note: + The domain is optional. If a domain is provided, it can be managed through [Website] --> [Proxy Project]. In this case, you do not need to check [Allow external access]. However, if no domain is provided, you must check [Allow external access] to enable port-based access. + + ![addApollo](../images/deployment/btpanel/addApollo.png) + +5. After installation, enter the domain name or IP+ port set in the previous step in the browser to access. +- Name: application name, default `Apollo-characters` +- Version selection: default `latest` +- Domain name: If you need to access directly through the domain name, please configure the domain name here and resolve the domain name to the server +- Allow external access: If you need direct access through `IP+Port`, please check. If you have set up a domain name, please do not check here. +- Web port: Default `8070`, can be modified by yourself +- Communication port: Default `8080`, can be modified by yourself +- Metadata port: Default `8090`, can be modified by yourself +- **Security Note:** + - Ensure these ports are not exposed directly to the internet + - Configure your firewall to restrict access to these ports + - Verify that these ports are not already in use by other services + +6. After submission, the panel will automatically initialize the application, which will take about `1-3` minutes. It can be accessed after the initialization is completed. + + +## Access Methods + +1. **Domain Name Access** + - URL Format: `http://` + - Example: `http://demo.apollo.org` + + **Enable HTTPS (Suggestion):** + 1. Obtain an SSL certificate (recommended providers: Let's Encrypt, Certbot) + 2. In aaPanel, go to [Website] -> [SSL] + 3. Install your SSL certificate + 4. Force HTTPS redirect for enhanced security + + After SSL configuration: + - URL Format: `https://` + - Example: `https://demo.apollo.org` + +2. **IP and Port Access** + - URL Format: `http://:8070` + - Note: Requires "Allow external access" to be enabled + +![console](../images/deployment/btpanel/console.png) + +> Default credentials: username `apollo`, password `admin`, please change the default password immediately. + diff --git a/docs/en/images/deployment/btpanel/addApollo.png b/docs/en/images/deployment/btpanel/addApollo.png new file mode 100644 index 00000000000..e8b9db7ae5c Binary files /dev/null and b/docs/en/images/deployment/btpanel/addApollo.png differ diff --git a/docs/en/images/deployment/btpanel/console.png b/docs/en/images/deployment/btpanel/console.png new file mode 100644 index 00000000000..5fddc00b13e Binary files /dev/null and b/docs/en/images/deployment/btpanel/console.png differ diff --git a/docs/en/images/deployment/btpanel/install-Apollo.png b/docs/en/images/deployment/btpanel/install-Apollo.png new file mode 100644 index 00000000000..10c89bf1ff2 Binary files /dev/null and b/docs/en/images/deployment/btpanel/install-Apollo.png differ diff --git a/docs/en/images/deployment/btpanel/install.png b/docs/en/images/deployment/btpanel/install.png new file mode 100644 index 00000000000..0751fe5294c Binary files /dev/null and b/docs/en/images/deployment/btpanel/install.png differ diff --git a/docs/en/images/deployment/btpanel/install2.png b/docs/en/images/deployment/btpanel/install2.png new file mode 100644 index 00000000000..8fd781d163d Binary files /dev/null and b/docs/en/images/deployment/btpanel/install2.png differ diff --git a/docs/zh/_sidebar.md b/docs/zh/_sidebar.md index 26f563e090f..47e0237258f 100644 --- a/docs/zh/_sidebar.md +++ b/docs/zh/_sidebar.md @@ -13,6 +13,7 @@ - [部署架构](zh/deployment/deployment-architecture.md) - 第三方工具部署 - [基于Rainbond一键安装高可用Apollo集群](zh/deployment/third-party-tool-rainbond.md) + - [基于宝塔面板快速部署 Apollo](zh/deployment/third-party-tool-btpanel.md) - 管理端指南 - [Apollo使用指南](zh/portal/apollo-user-guide.md) diff --git a/docs/zh/deployment/third-party-tool-btpanel.md b/docs/zh/deployment/third-party-tool-btpanel.md new file mode 100644 index 00000000000..8669d56c87f --- /dev/null +++ b/docs/zh/deployment/third-party-tool-btpanel.md @@ -0,0 +1,40 @@ +# 基于宝塔面板部署 Apollo + +## 前提 + +- 仅适用于宝塔面板9.2.0及以上版本 +- 安装宝塔面板,前往[宝塔面板](https://www.bt.cn/new/index.html)官网,选择正式版的脚本下载安装 + +## 部署 + +1. 登录宝塔面板,在左侧菜单栏中点击 `Docker` +![Docker](../images/deployment/btpanel/docker-menu.png) + +2. 首次会提示安装`Docker`和`Docker Compose`服务,点击立即安装,若已安装请忽略。 +![安装环境](../images/deployment/btpanel/install-docker.png) + +3. 安装完成后在`Docker-应用商店`中找到 `Apollo`,点击`安装` +![安装](../images/deployment/btpanel/search-apollo.png) + +4. 设置域名等基本信息,点击`确定` +- 名称:应用名称,默认`apollo_随机字符` +- 版本选择:默认`latest` +- 允许外部访问:如您需通过`IP+Port`直接访问,请勾选,如您已经设置了域名,请不要勾选此处 +- WEB 端口:默认`8070`,可自行修改 +- 通信端口:默认`8080`,可自行修改 +- 元数据端口:默认`8090`,可自行修改 +- **安全须知:** + - 请确保这些端口没有直接暴露在互联网上 + - 配置您的防火墙以限制对这些端口的访问 + - 验证这些端口没有被其他服务占用 + +5. 提交后面板会自动进行应用初始化,大概需要`1-3`分钟,初始化完成后即可访问 + + + +## 访问 Apollo +- 请在浏览器地址栏中输入域名访问 `http://<宝塔面板IP>:8070`,即可访问 `Apollo` 控制台。 +![控制台](../images/deployment/btpanel/console.png) + +> 默认登录信息: username `apollo`, password `admin`,为了服务器安全,请在登陆后立即修改密码。 + diff --git a/docs/zh/images/deployment/btpanel/console.png b/docs/zh/images/deployment/btpanel/console.png new file mode 100644 index 00000000000..5fddc00b13e Binary files /dev/null and b/docs/zh/images/deployment/btpanel/console.png differ diff --git a/docs/zh/images/deployment/btpanel/docker-menu.png b/docs/zh/images/deployment/btpanel/docker-menu.png new file mode 100644 index 00000000000..ae68589723b Binary files /dev/null and b/docs/zh/images/deployment/btpanel/docker-menu.png differ diff --git a/docs/zh/images/deployment/btpanel/install-docker.png b/docs/zh/images/deployment/btpanel/install-docker.png new file mode 100644 index 00000000000..86c41a5e5d3 Binary files /dev/null and b/docs/zh/images/deployment/btpanel/install-docker.png differ diff --git a/docs/zh/images/deployment/btpanel/search-apollo.png b/docs/zh/images/deployment/btpanel/search-apollo.png new file mode 100644 index 00000000000..f8b9803bebb Binary files /dev/null and b/docs/zh/images/deployment/btpanel/search-apollo.png differ