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.

Sign up for GitHub

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

📝 docs: add deployment on btpanel #4528

Merged
merged 8 commits into from
Oct 31, 2024
Merged

📝 docs: add deployment on btpanel #4528

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
619bf98
Create btpanel.zh-CN.mdx
bestlaw66 Oct 29, 2024
6c75583
📝 docs: Add documentation for deploying with aaPanel
KincaidYang Oct 30, 2024
499fce6
Merge pull request #1 from KincaidYang/patch-2
bestlaw66 Oct 30, 2024
bafb2ae
Update btpanel.mdx
bestlaw66 Oct 30, 2024
755d3ea
docs: Add documentation for deploying with aaPanel
KincaidYang Oct 30, 2024
5111b87
📝 docs: Add documentation for deploying with aaPanel
KincaidYang Oct 30, 2024
edd75be
Merge pull request #2 from KincaidYang/patch-3
bestlaw66 Oct 30, 2024
a9e21cb
Merge pull request #3 from bestlaw66/main
bestlaw66 Oct 30, 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
43 changes: 43 additions & 0 deletions docs/self-hosting/platform/btpanel.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Deploy LobeChat using aaPanel
description: Learn how to deploy the LobeChat service using aaPanel-Docker, including installing the Docker container environment and using the command to start the service with one click. Detailed instructions on how to configure environment variables and use proxy addresses.
tags:
- Docker
- LobeChat
- Deployment guidelines
---

## 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

1. Log in to aaPanel and click `Docker` in the menu bar
![install](https://github.com/user-attachments/assets/f67180c2-47ba-4b04-9f12-d274c7821085)

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.
![install2](https://github.com/user-attachments/assets/e269bd27-d323-43ba-811b-c0f5e4137903)

3. After the installation is complete, find `LobeChat` in `One-Click Install` and click `install`
![install-LobeChat](https://github.com/user-attachments/assets/9f989104-bb8e-4acd-9721-6b1db1017d2b)

4. configure basic information such as the domain name, OpenAI API key, and port to complete the installation
Note:
The domain name is optional, if the domain name is filled, it can be managed through [Website]--> [Proxy Project], and you do not need to check [Allow external access] after filling in the domain name, otherwise you need to check it before you can access it through the port
![addLobeChat](https://github.com/user-attachments/assets/f0b2e72d-9eee-46a8-b094-4834b78764df)
5. After installation, enter the domain name or IP+ port set in the previous step in the browser to access.
- Name: application name, default `LobeChat-random 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.
- Port: Default `3210`, can be modified by yourself

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.


## Visit LobeChat
- If you have set a domain name, please directly enter the domain name in the browser address bar, such as `http://demo.lobechat`, to access the `LobeChat` console.
- If you choose to access through `IP+Port`, please enter the domain name in the browser address bar to access `http://<aaPanelIP>:3210` to access the `HertzBeat` console.
![console](https://github.com/user-attachments/assets/a1af5778-f47a-4fdc-baf5-ca2a1e66f48e)

49 changes: 49 additions & 0 deletions docs/self-hosting/platform/btpanel.zh-CN.mdx
View file
Open in desktop
arvinxx marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: 通过 宝塔面板Docker应用商店 部署 LobeChat
description: 学习如何使用 宝塔面板Docker应用 部署 LobeChat 服务，包括安装 Docker 容器环境和使用指令一键启动服务。详细说明如何配置环境变量和使用代理地址。
tags:
- Docker
- LobeChat
- 部署指引
---

# 宝塔面板部署

## 前提
- 仅适用于宝塔面板9.2.0及以上版本
- 安装宝塔面板，前往[宝塔面板](https://www.bt.cn/new/download.html)官网，选择正式版的脚本下载安装


## 部署

1. 登录宝塔面板，在左侧菜单栏中点击 `Docker`
![Docker](https://github.com/user-attachments/assets/15d92756-92f0-45da-8f95-bfe725d13003)

2. 首次会提示安装`Docker`和`Docker Compose`服务，点击立即安装，若已安装请忽略。
![安装环境](https://github.com/user-attachments/assets/6e383b75-09e3-42d1-8a6c-5fb7cf558f00)

3. 安装完成后在`Docker-应用商店-AI/大模型`中找到 `LobeChat`，点击`安装`
![安装](https://github.com/user-attachments/assets/db59a5e7-32ed-49d7-a791-8f8ee6618c01)

4. 设置域名等基本信息，点击`确定`
![设置](https://github.com/user-attachments/assets/37251adf-949b-4aec-bc49-bf4647e119da)
- 名称：应用名称，默认`lobechat_随机字符`
- 版本选择：默认`latest`
- 域名：如您需要通过域名访问，请在此处填写您的域名
- 允许外部访问：如您需通过`IP+Port`直接访问，请勾选，如您已经设置了域名，请不要勾选此处
- 端口：默认`3210`，可自行修改
- 访问密码：默认随机生成
- OpenAI API 密钥：请输入您的 Open API 密钥
- OpenAI 代理 URL：默认为官方地址
- OpenAI 模型列表：输入使用的模型
- CPU 核心数限制：0为不限制，根据实际需要设置
- 内存限制：0为不限制，根据实际需要设置


5. 提交后面板会自动进行应用初始化，大概需要`1-3`分钟，初始化完成后即可访问。


## 访问 LobeChat
- 如果您填写域名，请在浏览器输入您的域名访问，如`http://demo.lobechat`，即可访问 `LobeChat` 页面。
- 请在浏览器地址栏中输入域名访问 `http://<宝塔面板IP>:3210`，即可访问 `LobeChat` 页面。
![LobeChat](https://github.com/user-attachments/assets/808f8849-5738-4a60-8ccf-01e300b0dc88)
Loading