Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create quick-start-btpanel.md #5274

Merged
merged 48 commits into from
Nov 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
1aa2c6d
Create quick-start-btpanel.md
bestlaw66 Nov 6, 2024
443f135
Update and rename quick-start-btpanel.md to third-party-tool-btpanel.md
bestlaw66 Nov 7, 2024
ab3e29a
docs: Add third-party-tool-btpanel.md
bestlaw66 Nov 7, 2024
e4ff73b
docs: add Default credentials
bestlaw66 Nov 7, 2024
a211a8a
docs: 更新文档说明
bestlaw66 Nov 7, 2024
cbb81ea
docs: add new doc
bestlaw66 Nov 7, 2024
c38f2cd
Update _sidebar.md
bestlaw66 Nov 7, 2024
b266c4c
Merge pull request #1 from bestlaw66/patch-2
bestlaw66 Nov 7, 2024
466bbda
docs: Improve sentence structure
bestlaw66 Nov 8, 2024
2974b1e
docs: Fix step numbering sequence.
bestlaw66 Nov 8, 2024
eb2d147
docs: upload bt-panel image
bestlaw66 Nov 8, 2024
9cca7c4
Delete docs/zh/deployment/20241010104431.png
bestlaw66 Nov 8, 2024
bd637d1
Delete docs/zh/deployment/20241010103723.png
bestlaw66 Nov 8, 2024
c7ef2bc
Delete docs/zh/deployment/console.png
bestlaw66 Nov 8, 2024
450c6b5
Delete docs/zh/deployment/企业微信截图_20241108095126.png
bestlaw66 Nov 8, 2024
c000e81
创建目录
bestlaw66 Nov 8, 2024
7fee130
docs: add btpanel image
bestlaw66 Nov 8, 2024
625b691
Delete docs/zh/images/deployment/btpanel/123
bestlaw66 Nov 8, 2024
121d735
docs: Uploading images to the repository's assets directory
bestlaw66 Nov 8, 2024
ddc89c4
docs: 创建目录
bestlaw66 Nov 8, 2024
24c3e97
docs: upload
bestlaw66 Nov 8, 2024
b3ed779
Delete docs/en/images/deployment/btpanel/123
bestlaw66 Nov 8, 2024
a9cfa37
docs: 替换图像链接
bestlaw66 Nov 8, 2024
765dd47
docs: 添加安全警示
bestlaw66 Nov 8, 2024
5dcf002
docs: 添加立即修改密码的警告
bestlaw66 Nov 8, 2024
f92bb4e
Merge pull request #2 from bestlaw66/patch-2
bestlaw66 Nov 8, 2024
e99bc00
docs: Improve access instructions formatting
bestlaw66 Nov 8, 2024
552aa79
Merge pull request #3 from bestlaw66/patch-2
bestlaw66 Nov 8, 2024
9fa4d78
docs: 优化代码格式
bestlaw66 Nov 8, 2024
bcced90
docs: Modify image path
bestlaw66 Nov 12, 2024
2e351a6
docs: Modify image path
bestlaw66 Nov 12, 2024
36f5c9a
Merge pull request #4 from bestlaw66/patch-2
bestlaw66 Nov 12, 2024
76cf54a
docs: Add security prompt
bestlaw66 Nov 12, 2024
bcc6849
docs: Add suggestion to set up SSL
bestlaw66 Nov 12, 2024
cc80c8b
docs: Add security prompt
bestlaw66 Nov 12, 2024
9212527
Merge pull request #5 from bestlaw66/patch-2
bestlaw66 Nov 12, 2024
cec7ae0
Merge branch 'master' into patch-1
bestlaw66 Nov 12, 2024
e8e3381
docs: Fix formatting and remove duplicate content
bestlaw66 Nov 13, 2024
747e339
Merge branch 'apolloconfig:master' into patch-2
bestlaw66 Nov 13, 2024
389901a
Merge branch 'patch-1' into patch-2
bestlaw66 Nov 13, 2024
b29a5ee
Merge pull request #6 from bestlaw66/patch-2
bestlaw66 Nov 13, 2024
faa2b4f
Update third-party-tool-btpanel.md
bestlaw66 Nov 18, 2024
23ca01d
Update third-party-tool-btpanel.md
bestlaw66 Nov 18, 2024
073bc82
Merge pull request #7 from bestlaw66/patch-2
bestlaw66 Nov 18, 2024
4feb42c
Merge branch 'master' into patch-1
nobodyiam Nov 20, 2024
88b0423
docs: Modify image path
bestlaw66 Nov 21, 2024
f876914
Add files via upload
bestlaw66 Nov 21, 2024
d95ed87
docs: Modify image path
bestlaw66 Nov 21, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/en/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
73 changes: 73 additions & 0 deletions docs/en/deployment/third-party-tool-btpanel.md
Original file line number Diff line number Diff line change
@@ -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.
bestlaw66 marked this conversation as resolved.
Show resolved Hide resolved

## 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://<your-domain>`
- Example: `http://demo.apollo.org`

bestlaw66 marked this conversation as resolved.
Show resolved Hide resolved
**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://<your-domain>`
- Example: `https://demo.apollo.org`

2. **IP and Port Access**
- URL Format: `http://<aaPanelIP>: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.

Binary file added docs/en/images/deployment/btpanel/addApollo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en/images/deployment/btpanel/console.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en/images/deployment/btpanel/install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en/images/deployment/btpanel/install2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/zh/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
40 changes: 40 additions & 0 deletions docs/zh/deployment/third-party-tool-btpanel.md
Original file line number Diff line number Diff line change
@@ -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`,为了服务器安全,请在登陆后立即修改密码。

Binary file added docs/zh/images/deployment/btpanel/console.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading