Skip to content

Commit 2e041e5

Browse files
committed
docs: update deployment documentation and add Compshare integration
1 parent b3c2138 commit 2e041e5

File tree

15 files changed

+196
-622
lines changed

15 files changed

+196
-622
lines changed

.vitepress/config.mjs

Lines changed: 60 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export default defineConfig({
1717

1818
lastUpdated: true,
1919
ignoreDeadLinks: true,
20-
20+
2121
locales: {
2222
root: {
2323
label: "简体中文",
@@ -49,33 +49,50 @@ export default defineConfig({
4949
base: "/deploy/astrbot",
5050
collapsed: false,
5151
items: [
52-
{ text: "🦈 Docker 部署", link: "/docker" },
53-
{ text: "☸️ Kubernetes 部署", link: "/kubernetes" },
54-
{ text: "☁️ 雨云一键云部署(NEW)", link: "/rainyun" },
55-
{ text: "💻 启动器一键部署", link: "/windows" },
56-
{ text: "👍 手动部署", link: "/cli" },
57-
{ text: "😁 宝塔面板部署", link: "/btpanel" },
58-
{ text: "🥇 1Panel 部署", link: "/1panel" },
59-
{ text: "😊 CasaOS 部署", link: "/casaos" },
60-
{ text: "🤗 安卓 Termux 部署", link: "/termux" },
61-
{ text: "🍉 优云智算 GPU 部署", link: "/compshare" },
62-
{ text: "⭐️ 社区提供的部署方式", link: "/community-deployment" },
52+
{ text: "包管理器部署", link: "/package" },
53+
{ text: "雨云一键云部署", link: "/rainyun" },
54+
{ text: "启动器一键部署", link: "/windows" },
55+
{ text: "Docker 部署", link: "/docker" },
56+
{ text: "Kubernetes 部署", link: "/kubernetes" },
57+
{ text: "宝塔面板部署", link: "/btpanel" },
58+
{ text: "1Panel 部署", link: "/1panel" },
59+
{ text: "手动部署", link: "/cli" },
60+
{
61+
text: "其他部署方式",
62+
link: "/other-deployments",
63+
collapsed: true,
64+
items: [
65+
{ text: "CasaOS 部署", link: "/casaos" },
66+
{ text: "优云智算 GPU 部署", link: "/compshare" },
67+
{ text: "社区提供的部署方式", link: "/community-deployment" },
68+
],
69+
},
6370
],
6471
},
6572
{
66-
text: "接入到消息平台",
73+
text: "接入消息平台",
6774
base: "/deploy/platform",
6875
collapsed: false,
6976
items: [
7077
{
71-
text: "QQ 官方接口",
78+
text: "QQ 官方机器人",
7279
base: "/deploy/platform/qqofficial",
7380
collapsed: true,
7481
items: [
7582
{ text: "Webhook 方式", link: "/webhook" },
7683
{ text: "Websockets 方式", link: "/websockets" },
7784
],
7885
},
86+
{ text: "企微应用", link: "/wecom" },
87+
{ text: "企微智能机器人", link: "/wecom_ai_bot" },
88+
{ text: "微信公众号", link: "/weixin-official-account" },
89+
{ text: "飞书", link: "/lark" },
90+
{ text: "钉钉", link: "/dingtalk" },
91+
{ text: "Telegram", link: "/telegram" },
92+
{ text: "LINE", link: "/line" },
93+
{ text: "Slack", link: "/slack" },
94+
{ text: "Misskey", link: "/misskey" },
95+
{ text: "Discord", link: "/discord" },
7996
{
8097
text: "OneBot v11",
8198
base: "/deploy/platform/aiocqhttp",
@@ -86,19 +103,6 @@ export default defineConfig({
86103
{ text: "其他端", link: "/others" },
87104
],
88105
},
89-
{ text: "企微应用", link: "/wecom" },
90-
{ text: "企微智能机器人", link: "/wecom_ai_bot" },
91-
{ text: "微信公众平台", link: "/weixin-official-account" },
92-
{ text: "飞书", link: "/lark" },
93-
{ text: "钉钉", link: "/dingtalk" },
94-
{ text: "Telegram", link: "/telegram" },
95-
{ text: "LINE", link: "/line" },
96-
{ text: "Slack", link: "/slack" },
97-
{ text: "Misskey", link: "/misskey" },
98-
{ text: "Discord", link: "/discord" },
99-
{ text: "Matrix", link: "/matrix" },
100-
{ text: "KOOK", link: "/kook" },
101-
{ text: "VoceChat", link: "/vocechat" },
102106
{
103107
text: "Satori",
104108
base: "/deploy/platform/satori",
@@ -108,6 +112,15 @@ export default defineConfig({
108112
{ text: "使用 server-satori", link: "/server-satori" },
109113
],
110114
},
115+
{
116+
text: "社区提供",
117+
collapsed: false,
118+
items: [
119+
{ text: "Matrix", link: "/matrix" },
120+
{ text: "KOOK", link: "/kook" },
121+
{ text: "VoceChat", link: "/vocechat" },
122+
],
123+
},
111124
],
112125
},
113126
{
@@ -282,12 +295,22 @@ export default defineConfig({
282295
base: "/en/deploy/astrbot",
283296
collapsed: true,
284297
items: [
298+
{ text: "📦 Package Manager Deployment", link: "/package" },
285299
{ text: "🦈 Docker Deployment", link: "/docker" },
286300
{ text: "☸️ Kubernetes Deployment", link: "/kubernetes" },
287301
{ text: "👍 Manual Deployment", link: "/cli" },
288302
{ text: "😁 BT Panel Deployment", link: "/btpanel" },
289303
{ text: "🥇 1Panel Deployment", link: "/1panel" },
290-
{ text: "😊 CasaOS Deployment", link: "/casaos" },
304+
{
305+
text: "Other Deployments",
306+
link: "/other-deployments",
307+
collapsed: true,
308+
items: [
309+
{ text: "CasaOS Deployment", link: "/casaos" },
310+
{ text: "Compshare GPU Deployment", link: "/compshare" },
311+
{ text: "Community Deployments", link: "/community-deployment" },
312+
],
313+
},
291314
],
292315
},
293316
{
@@ -324,9 +347,15 @@ export default defineConfig({
324347
{ text: "Slack", link: "/slack" },
325348
{ text: "Misskey", link: "/misskey" },
326349
{ text: "Discord", link: "/discord" },
327-
{ text: "Matrix", link: "/matrix" },
328-
{ text: "KOOK", link: "/kook" },
329-
{ text: "VoceChat", link: "/vocechat" },
350+
{
351+
text: "Community-provided",
352+
collapsed: false,
353+
items: [
354+
{ text: "Matrix", link: "/matrix" },
355+
{ text: "KOOK", link: "/kook" },
356+
{ text: "VoceChat", link: "/vocechat" },
357+
],
358+
},
330359
{
331360
text: "Satori",
332361
base: "/en/deploy/platform/satori",

en/deploy/astrbot/community-deployment.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,6 @@
33
> [!WARNING]
44
> AstrBot official does not guarantee the security and stability of these deployment methods.
55
6-
# Linux Comprehensive Installation Script
7-
8-
Integrates almost all installation methods found in the documentation.
9-
10-
Also includes many practical Linux tools.
11-
12-
AstrBot is categorized under `Basic Tools / Bot Installation / AstrBot`.
13-
14-
```bash
15-
bash -c "$(curl -L https://gitee.com/nasyt/nasyt-linux-tool/raw/master/nasyt.sh)"
16-
```
17-
186
## Linux One-Click Deployment Script
197

208
Use `curl` to download the script and execute it using `bash`:

en/deploy/astrbot/compshare.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Deploy via Compshare
2+
3+
Compshare is UCloud's GPU compute rental and LLM API platform, offering compute resources for AI, deep learning, and scientific workloads.
4+
5+
AstrBot provides an Ollama + AstrBot one-click self-deployment image on Compshare, and also supports Compshare model APIs.
6+
7+
## Use the Ollama + AstrBot One-Click Image
8+
9+
> Default image spec: RTX 3090 24GB + Intel 16-core + 64GB RAM + 200GB system disk. Billing is pay-as-you-go, so please monitor your balance.
10+
11+
1. Register a Compshare account via [this link](https://passport.compshare.cn/register?referral_code=FV7DcGowN4hB5UuXKgpE74).
12+
2. Open the [AstrBot image page](https://www.compshare.cn/images/0oX7xoGrzfre) and create an instance.
13+
3. After deployment, open `JupyterLab` from the [console](https://console.compshare.cn/light-gpu/console/resources).
14+
4. In JupyterLab, create a new terminal and run:
15+
16+
```bash
17+
cd
18+
./astrbot_booter.sh
19+
```
20+
21+
If startup succeeds, you should see output similar to:
22+
23+
```txt
24+
(py312) root@f8396035c96d:/workspace# cd
25+
./astrbot_booter.sh
26+
Starting AstrBot...
27+
Starting ollama...
28+
Both services started in the background.
29+
```
30+
31+
After startup, open `http://<instance-public-ip>:6185` in your browser to access the AstrBot dashboard.
32+
You can find the public IP in Console -> Basic Network (Public).
33+
34+
> It may take around 30 seconds before the page becomes reachable.
35+
36+
![WebUI](https://www-s.ucloud.cn/2025/07/7e9fc6edc1dfa916abc069f4cecc24cf_1753940381771.png)
37+
38+
Login with username `astrbot` and password `astrbot`.
39+
40+
After logging in, you can reset your password and continue setup.
41+
42+
The instance imports `Ollama-DeepSeek-R1-32B` by default.
43+
44+
## Use Other Models
45+
46+
### Pull Models with Ollama
47+
48+
The image includes Ollama. You can pull any model and host it locally on the instance.
49+
50+
1. Choose a model from [Ollama Search](https://ollama.com/search).
51+
2. Connect to the instance terminal via SSH (from Compshare Console -> Instance List -> Console Command and Password).
52+
3. Run `ollama pull <model-name>` and wait for completion.
53+
4. In AstrBot Dashboard -> Providers, edit `ollama_deepseek-r1`, update the model name, and save.
54+
55+
![image](https://files.astrbot.app/docs/source/images/compshare/image-1.png)
56+
57+
### Use Compshare Model API
58+
59+
AstrBot supports direct access to model APIs provided by Compshare.
60+
61+
1. Find the model you want at [Compshare Model Center](https://console.compshare.cn/light-gpu/model-center).
62+
2. In AstrBot Dashboard -> Providers, click `+ Add Provider`, then choose Compshare.
63+
If Compshare is not listed, choose OpenAI-compatible access and set API Base URL to `https://api.modelverse.cn/v1`.
64+
Enter the model name in model configuration and save.
65+
66+
### Test
67+
68+
In AstrBot Dashboard, click `Chat` and run `/provider` to view and switch your active provider.
69+
70+
Then send a normal message to test whether the model works.
71+
72+
![image](https://files.astrbot.app/docs/source/images/compshare/image-2.png)
73+
74+
## Connect to Messaging Platforms
75+
76+
You can follow the latest platform integration guides in the [AstrBot Documentation](https://docs.astrbot.app/en/what-is-astrbot.html).
77+
Open the docs and check the left sidebar under Deployment -> Connect to Messaging Platforms.
78+
79+
- Lark: [Connect to Lark](https://docs.astrbot.app/en/deploy/platform/lark.html)
80+
- LINE: [Connect to LINE](https://docs.astrbot.app/en/deploy/platform/line.html)
81+
- DingTalk: [Connect to DingTalk](https://docs.astrbot.app/en/deploy/platform/dingtalk.html)
82+
- WeCom: [Connect to WeCom](https://docs.astrbot.app/en/deploy/platform/wecom.html)
83+
- WeChat Official Account: [Connect to WeChat Official Account](https://docs.astrbot.app/en/deploy/platform/weixin-official-account.html)
84+
- QQ Official Bot: [Connect to QQ Official API](https://docs.astrbot.app/en/deploy/platform/qqofficial/webhook.html)
85+
- KOOK: [Connect to KOOK](https://docs.astrbot.app/en/deploy/platform/kook.html)
86+
- Slack: [Connect to Slack](https://docs.astrbot.app/en/deploy/platform/slack.html)
87+
- Discord: [Connect to Discord](https://docs.astrbot.app/en/deploy/platform/discord.html)
88+
- More methods: [AstrBot Documentation](https://docs.astrbot.app/en/what-is-astrbot.html)
89+
90+
## More Features
91+
92+
For more capabilities, see the [AstrBot Documentation](https://docs.astrbot.app/en/what-is-astrbot.html).
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Other Deployments
2+
3+
- [CasaOS Deployment](./casaos.md)
4+
- [Compshare GPU Deployment](./compshare.md)
5+
- [Community Deployments](./community-deployment.md)

en/deploy/astrbot/package.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Package Manager Deployment (uv)
2+
3+
Use `uv` to install and run AstrBot quickly.
4+
5+
## Before You Start
6+
7+
If `uv` is not installed, install it first by following the official guide:
8+
<https://docs.astral.sh/uv/>
9+
10+
`uv` supports Linux, Windows, and macOS.
11+
12+
## Install and Start
13+
14+
```bash
15+
uv tool install astrbot
16+
astrbot
17+
```

0 commit comments

Comments
 (0)