Skip to content

Commit f8d8505

Browse files
authored
Merge pull request #107 from gitplayer4/en/v2
update format
2 parents 50fad47 + 9aca453 commit f8d8505

31 files changed

+133
-92
lines changed

docs/user_manual/ai/agent.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,15 @@
4242
Access the DeepSeek Developer Platform via the link: https://platform.deepseek.com/, first complete personal real-name authentication and registration, and then make a recharge, as shown in the figure below.
4343

4444
![img.png](../../img/ai/DeepSeek_Developer_Platform_Billing_Page.png)
45+
{: .browser-mockup}
4546

4647
### 2.2. Step 2: Obtain the DeepSeek API Key
4748

4849
!!! note ""
4950
As shown in the figure below, enter the API keys page, click "Create API key", and keep the generated API Key in a safe place for subsequent use after creation.
5051

5152
![img.png](../../img/ai/DeepSeek_API_Key_Creation_Page.png)
53+
{: .browser-mockup}
5254

5355
## 3. OpenClaw Installation and Deployment
5456

@@ -61,13 +63,15 @@
6163
Enter the "Agent" management menu under "AI" management, click to enter and switch to "Model Account" management first, then click "Add model account". Select the model provider and enter the model account information as required to complete the model account creation.
6264

6365
![img.png](../../img/ai/1Panel_Add_Model_Account_Page.png)
66+
{: .browser-mockup}
6467

6568
### 3.2. Step 2: Create an Agent
6669

6770
!!! note ""
6871
After preparing the model account, switch to the "Agent" page and click "Create Agent", then enter the relevant parameters as required, as shown in the figure below:
6972

7073
![img.png](../../img/ai/1Panel_Create_Agent_Parameter_Page.png)
74+
{: .browser-mockup}
7175

7276
!!! note ""
7377
The parameter definitions during agent creation are detailed as follows:
@@ -79,11 +83,13 @@
7983
- Model Provider: The currently supported models are shown in the figure. Select the DeepSeek model provider added just now. If the model account for the corresponding model provider has been added, the number of model accounts will be prompted directly.
8084

8185
![img.png](../../img/ai/1Panel_Model_Provider_Select_Page.png)
86+
{: .browser-mockup}
8287

8388
!!! note ""
8489
- Other Model Parameters: After selecting the model provider, the system will automatically retrieve the maintained model accounts, as shown in the figure below. You can also check "Manual input" to enter the model information manually. If no model account has been created, click "Create model account" to complete the creation.
8590

8691
![img.png](../../img/ai/1Panel_Model_Account_Associate_Page.png)
92+
{: .browser-mockup}
8793

8894
!!! note ""
8995
- Token: A token for the OpenClaw Web UI access address, which is automatically generated by the system for direct access in the follow-up.
@@ -93,25 +99,27 @@
9399
After configuring all the above parameters, click "Confirm" directly to start the installation of OpenClaw. The installation is completed when the prompt as shown in the figure below appears.
94100

95101
![img.png](../../img/ai/1Panel_OpenClaw_Installation_Log.png)
102+
{: .browser-mockup}
96103

97104
### 3.3. Step 3: Verify the Successful Deployment of OpenClaw
98105

99106
!!! note ""
100107
After the installation and deployment of OpenClaw are completed, enter the agent list page and click "WebUI" to jump directly to the OpenClaw page, as shown in the figure below.
101108

102109
![img.png](../../img/ai/1Panel_Agent_List_OpenClaw_Page.png)
110+
{: .browser-mockup}
103111

104112
!!! note ""
105113
After entering the OpenClaw page, send a message and check if the AI assistant responds. A normal response, as shown in the figure below, indicates that OpenClaw has been successfully deployed.
106114

107115
![img.png](../../img/ai/OpenClaw_WebUI_Chat_Test_Page.png)
116+
{: .browser-mockup}
108117

109118
## 4. Feishu Channel Configuration
110119

111120
!!! note ""
112121
Up to this point, OpenClaw has been fully deployed. Next, we will configure the Feishu channel. To configure the Feishu channel, we first need to create an available robot in Feishu. Follow the steps below to complete the configuration step by step.
113122

114-
!!! note ""
115123
Note: A personal Feishu account is used in this guide. For enterprise accounts, version release and permission authorization require administrator approval, while other operation steps remain the same.
116124

117125
### 4.1. Step 1: Create a Custom Enterprise App
@@ -120,30 +128,35 @@
120128
First, log in to Feishu and enter the Feishu Open Platform (link: https://open.feishu.cn/app), then access the "Developer Console" and select "Custom Apps", click "Create Custom App", as shown in the figure below.
121129

122130
![img.png](../../img/ai/Feishu_Open_Platform_Custom_Apps_List.png)
131+
{: .browser-mockup}
123132

124133
!!! note ""
125134
As shown in the figure below, enter the relevant app name and basic information as required and click "Create".
126135

127136
![img.png](../../img/ai/Feishu_Create_Custom_App_Page.png)
137+
{: .browser-mockup}
128138

129139
### 4.2. Step 2: Create a Bot
130140

131141
!!! note ""
132142
As shown in the figure below, click to create a bot to complete the bot creation process.
133143

134144
![img.png](../../img/ai/Feishu_Add_Bot_Feature_Page.png)
145+
{: .browser-mockup}
135146

136147
!!! note ""
137148
After entering the bot page, click the edit button after bot configuration to define the bot name, as shown in the figure below:
138149

139150
![img.png](../../img/ai/Feishu_Bot_Setting_Page.png)
151+
{: .browser-mockup}
140152

141153
### 4.3. Step 3: Permission Configuration
142154

143155
!!! note ""
144156
After creating the bot, click to enter "Permissions & Scopes" and then click "Batch import/export scopes".
145157

146158
![img.png](../../img/ai/Feishu_Permissions_Scopes_Page.png)
159+
{: .browser-mockup}
147160

148161
!!! note ""
149162
Click "Batch import/export scopes", clear the default permission configuration information, copy and paste the permission authorization script as shown below, and click "Save".
@@ -190,68 +203,79 @@
190203
The effect after pasting is shown in the figure below:
191204

192205
![img.png](../../img/ai/Feishu_Batch_Import_Scopes_Page.png)
206+
{: .browser-mockup}
193207

194208
!!! note ""
195209
Click "Next, Review New Scopes" and finally ensure that all permissions are enabled. For personal accounts, confirm the permissions by yourself; for enterprise accounts, administrator review is required. Ensure all permissions are enabled as shown in the figure below:
196210

197211
![img.png](../../img/ai/Feishu_Permissions_Scopes_Review_Page.png)
212+
{: .browser-mockup}
198213

199214
### 4.4. Step 4: Obtain Credentials and Configure in 1Panel
200215

201216
!!! note ""
202217
Enter the Feishu platform and obtain the app credentials in "Credentials & Basic Info", as shown in the figure below:
203218

204219
![img.png](../../img/ai/Feishu_Credentials_Basic_Info_Page.png)
220+
{: .browser-mockup}
205221

206222
!!! note ""
207223
After obtaining the credentials, enter the "Configuration" page of "Agent" in 1Panel, complete the Feishu chat channel configuration, and click "Save", as shown in the figure below:
208224

209225
![img.png](../../img/ai/1Panel_OpenClaw_Feishu_Channel_Config.png)
226+
{: .browser-mockup}
210227

211228
### 4.5. Step 5: Create Events and Callbacks
212229

213230
!!! note ""
214231
As shown in the figure below, enter the "Events & Callbacks" menu and complete the subscription method setting and event addition respectively.
215232

216233
![img.png](../../img/ai/Feishu_Events_Callbacks_Page.png)
234+
{: .browser-mockup}
217235

218236
#### Subscription Method Setting
219237

220238
!!! note ""
221239
Select the persistent connection subscription method as shown in the figure below:
222240

223241
![img.png](../../img/ai/Feishu_Event_Subscription_Mode_Setting.png)
242+
{: .browser-mockup}
224243

225244
#### Add Events:
226245

227246
!!! note ""
228247
Enter "im.message.receive_v1" to search, check "Receive messages" based on "App-based Subscription", and finally confirm the addition.
229248

230249
![img.png](../../img/ai/Feishu_Add_Event_Im_Message_Receive.png)
250+
{: .browser-mockup}
231251

232252
### 4.6. Step 6: Create and Release a Version
233253

234254
!!! note ""
235255
After confirmation, click "Create Version", then enter the relevant version information as required and release it. No approval is required for personal accounts, while enterprise accounts need enterprise approval.
236256

237257
![img.png](../../img/ai/Feishu_Create_App_Version_Page.png)
258+
{: .browser-mockup}
238259

239260
### 4.7. Step 7: Verify the Feishu Channel Configuration
240261

241262
!!! note ""
242263
After completing all the above configurations, open the app in the Feishu client as shown in the figure below:
243264

244265
![img.png](../../img/ai/Feishu_Client_OpenClaw_Bot_List.png)
266+
{: .browser-mockup}
245267

246268
!!! note ""
247269
Finally, perform a simple test. The prompt as shown in the figure below indicates that the configuration is successful.
248270

249271
![img.png](../../img/ai/Feishu_OpenClaw_Bot_Chat_Test_Page.png)
272+
{: .browser-mockup}
250273

251274
# 6. Model Configuration Modification
252275

253276
!!! note ""
254277
If you need to switch the model when using the OpenClaw personal AI assistant, also enter the "Agent" list, click "Configuration", enter the model switching menu, complete the model configuration modification and click "Save", as shown in the figure below:
255278

256279
![img.png](../../img/ai/1Panel_OpenClaw_Model_Configuration_Modify.png)
280+
{: .browser-mockup}
257281

docs/user_manual/ai/gpu.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,30 @@
33
!!! note ""
44
For NVIDIA graphics cards, users can visit https://www.nvidia.com/en-us/drivers/ to find and download the driver version compatible with their GPU model.
55

6-
For example, if the downloaded file is `NVIDIA-Linux-x86_64-570.86.15.run`, upload it to your 1Panel server, then run the following commands in the command line to install:
6+
For example, if the downloaded file is `NVIDIA-Linux-x86_64-570.86.15.run`, upload it to your 1Panel server, then run the following commands in the command line to install:
77

8-
```bash
9-
chmod +x NVIDIA-Linux-x86_64-570.86.15.run
10-
./NVIDIA-Linux-x86_64-570.86.15.run
11-
```
8+
```bash
9+
chmod +x NVIDIA-Linux-x86_64-570.86.15.run
10+
./NVIDIA-Linux-x86_64-570.86.15.run
11+
```
1212

13-
> Follow the on‑screen prompts to complete the installation.
14-
The `nvidia-smi` command is installed automatically with the NVIDIA driver. 1Panel uses `nvidia-smi` to retrieve GPU information.
13+
> Follow the on‑screen prompts to complete the installation.
14+
The `nvidia-smi` command is installed automatically with the NVIDIA driver. 1Panel uses `nvidia-smi` to retrieve GPU information.
1515

1616
## 2 View GPU Information
1717

1818
!!! note ""
19-
On the GPU monitoring page, you can view the driver version, GPU model, utilization, temperature, power consumption, and other basic metrics, as well as processes currently using the GPU.
19+
On the GPU monitoring page, you can view the driver version, GPU model, utilization, temperature, power consumption, and other basic metrics, as well as processes currently using the GPU.
2020

2121
![img.png](../../img/ai/gpu_monitor.png)
22-
{: .original}
22+
{: .browser-mockup}
2323

2424
## 3 Use GPU
2525

2626
!!! note ""
27-
After installing the GPU driver, you must also install the NVIDIA Container Toolkit by following the [NVIDIA official guide](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) to enable GPU access in apps from the App Store or other containers.
27+
After installing the GPU driver, you must also install the NVIDIA Container Toolkit by following the [NVIDIA official guide](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) to enable GPU access in apps from the App Store or other containers.
2828

2929
> When installing an app from the App Store, enable `GPU Acceleration` in Advanced Settings to grant the app GPU support.
3030
3131
![img.png](../../img/ai/gpu_acceleration.png)
32-
{: .original}
32+
{: .browser-mockup}

docs/user_manual/ai/mcp.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
However, in practice, manually setting up an MCP Server requires configuring numerous dependencies, resulting in a high deployment barrier for many users. To solve this problem, 1Panel v1.10.29 LTS has introduced a native **MCP Server Management** feature. This feature supports one-click deployment of MCP Server via containerization, greatly simplifying the setup process.
77

88
![img.png](../../img/ai/mcp_list.png)
9-
{: .original}
9+
{: .browser-mockup}
1010

1111
## 2 Create MCP Server
1212

@@ -19,12 +19,12 @@
1919
### 2.1 Start via npx Command
2020

2121
![img.png](../../img/ai/create_mcp_server.png)
22-
{: .original}
22+
{: .browser-mockup}
2323

2424
### 2.2 Run as Binary
2525

2626
![img.png](../../img/ai/mcp_binary.png)
27-
{: .original}
27+
{: .browser-mockup}
2828

2929
## 3 Obtain Configuration Information
3030

@@ -34,7 +34,7 @@
3434
Users only need to copy and paste the configuration into their MCP client to use the AI assistant enhanced with MCP. This eliminates the need to manually look up or set environment variables, enabling a seamless experience from deployment to usage.
3535

3636
![img.png](../../img/ai/mcp_server_config.png)
37-
{: .original}
37+
{: .browser-mockup}
3838

3939
## 4 Unified Domain and SSE Path
4040

@@ -44,7 +44,7 @@
4444
This approach simplifies public network configuration and centralizes operation and maintenance. Especially in large‑scale deployments and enterprise internal networks, using a unified domain avoids exposing too many ports, reduces security risks, and improves deployment flexibility, security, and maintainability.
4545

4646
![img.png](../../img/ai/mcp_website.png)
47-
{: .original}
47+
{: .browser-mockup}
4848

4949
## 5 Whitelist Access Restriction
5050

docs/user_manual/ai/model.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,39 @@
66
To use the model management feature, you need to first install the Ollama application from the App Store. After installation, you can view the status of the Ollama application on this page and perform operations such as starting, stopping, and restarting.
77

88
![img.png](../../img/ai/overview.png)
9+
{: .browser-mockup}
910

1011
## 2 Adding Models
1112

1213
!!! Abstract ""
1314
Click "Add Model," enter the model name, and click the "Add" button to pull the corresponding model from the [Ollama Official Repository](https://ollama.com/search).
1415

1516
![img.png](../../img/ai/model_pull.png)
17+
{: .browser-mockup}
1618

1719
## 3 Running Models
1820

1921
!!! Abstract ""
2022
Click the "Run" button in the row of a specific model to open an online terminal on the current page and interact with the model.
2123

2224
![img.png](../../img/ai/model_run.png)
25+
{: .browser-mockup}
2326

2427
## 4 AI Proxy Enhancement
2528

2629
!!! Abstract ""
2730
This feature allows you to configure a reverse proxy for the Ollama application, supporting domain names, HTTPS, IP whitelists, and other configurations to enhance security when using large models.
2831

2932
![img.png](../../img/ai/api_proxy.png)
33+
{: .browser-mockup}
3034

3135
## 5 Viewing Connection Information
3236

3337
!!! Abstract ""
3438
Click the "Connection Information" button at the top of the list to view the connection information for the Ollama application.
3539

3640
![img.png](../../img/ai/connection_info.png)
41+
{: .browser-mockup}
3742

3843
> The Ollama application deployed from the App Store runs in a containerized manner. Different scenarios require selecting the corresponding connection information based on the prompts on the page.
3944
@@ -75,7 +80,7 @@
7580
- **Mounts**: Mount additional directories for the TensorRT LLM container. Local directories on the server can be mounted to the container for access within the container.
7681

7782
![img.png](../../img/ai/create_trtllm.png)
78-
{: .original}
83+
{: .browser-mockup}
7984

8085
### 2 View Model Logs
8186

docs/user_manual/appstore/installed.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
You can also migarte the backup file to your other nodes using the **Migrate** function.
7979

8080
![img.png](../../img/app/migrate.png)
81-
81+
{: .browser-mockup}
8282

8383

8484
## 7 Upgrade

docs/user_manual/containers/compose_template.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
Used when creating an orchestration.
33

44
![img.png](../../img/containers/compose_template_create.png)
5+
{: .browser-mockup}

docs/user_manual/containers/composes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
[Learn more about container orchestration](https://docs.docker.com/compose)
1111

1212
![img.png](../../img/containers/compose_create.png)
13-
{: .original}
13+
{: .browser-mockup}
1414

1515
## 2 Edit Orchestration
1616

@@ -29,4 +29,4 @@
2929
Click the name in the orchestration list to enter the orchestration details page. This page displays the container list corresponding to the Compose. Starting/stopping operations for the Compose are only supported when the Compose is created by 1Panel.
3030

3131
![img.png](../../img/containers/compose_detail.png)
32-
{: .original}
32+
{: .browser-mockup}

docs/user_manual/containers/container.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
- Images must be pulled manually from the Images menu
77

88
![img.png](../../img/containers/container_create.png)
9-
{: .original}
9+
{: .browser-mockup}
1010

1111
## 2 Inspect Container
1212

1313
!!! note ""
1414
Click the target container name, and all information about the container will be displayed in the right drawer.
1515

1616
![img.png](../../img/containers/container_inspect.png)
17-
{: .original}
17+
{: .browser-mockup}
1818

1919
## 3 View Container Logs
2020

@@ -24,7 +24,7 @@
2424
- **Download**: Download container logs
2525

2626
![img.png](../../img/containers/container_log.png)
27-
{: .original}
27+
{: .browser-mockup}
2828

2929
## 4 Access Container Console
3030

@@ -34,7 +34,7 @@
3434
**Note**: For Alpine Linux containers, select the `/bin/ash` command. If you need to define a command other than the provided ones, switch the **Custom** option to on.
3535

3636
![img.png](../../img/containers/container_terminal.png)
37-
{: .original}
37+
{: .browser-mockup}
3838

3939
## 5 View Container Statistics
4040

@@ -48,4 +48,4 @@
4848
**Refresh interval can be changed**.
4949

5050
![img.png](../../img/containers/container_monitor.png)
51-
{: .original}
51+
{: .browser-mockup}

0 commit comments

Comments
 (0)