Skip to content

Commit 4eb39b9

Browse files
authored
Merge pull request #91 from gitplayer4/en/v2
update index.md
2 parents c5460b1 + 8ad8e8f commit 4eb39b9

11 files changed

Lines changed: 84 additions & 92 deletions

docs/changelog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
hide:
3+
- navigation
4+
---
5+
16
# 1Panel Changelog – Full English Translation
27

38
## 1 Versioning

docs/dev_manual/api_manual.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
hide:
3+
- navigation
4+
---
5+
16
!!! note ""
27
This document details how to use custom Token verification to access panel APIs in third-party services.
38

181 KB
Loading
236 KB
Loading
49.2 KB
Loading
325 KB
Loading
265 KB
Loading
294 KB
Loading

docs/index.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,47 +3,47 @@ hide:
33
- navigation
44
---
55

6-
# 1Panel: Modern Open‑Source VPS Control Panel
6+
## What is 1Panel?
77

8-
!!! note ""
9-
1Panel is a modern, open‑source VPS control panel that streamlines administration through an intuitive and clean web interface.
8+
1Panel is a modern, open-source VPS control panel that streamlines administration through an intuitive, clean web interface.
109

11-
It allows you to manage your VPS effortlessly—entirely from a web browser.
10+
## Key Features
1211

13-
![img.png](./img/overview.png)
12+
- **One-Click OpenClaw Deployment**: Seamlessly deploy OpenClaw agents, host local LLMs using Ollama, and monitor GPU utilization—all within a unified workspace.  
13+
- **One-Click Website Deployment**: Launch production-ready websites instantly with automatic domain binding, SSL certificate provisioning, and configuration—zero manual setup required.  
14+
- **Curated App Marketplace**: Discover, install, and update trusted open-source applications (Nextcloud, Bitwarden, Umami, and more) with a single click.  
15+
- **Centralized Server Management**: Monitor system resources and manage files, databases, containers, and services effortlessly through a unified, intuitive dashboard.  
16+
- **Enterprise-Grade Security**: Strengthen your defenses with container isolation, firewall controls, audit logging, and secure deployment practices—ensuring compliance and peace of mind.  
17+
- **Intelligent Backup & Restore**: Schedule automated backups or perform instant restores to local storage or major cloud platforms (AWS S3, Cloudflare R2, and more), with flexible retention and destination options.  
1418

15-
Unlike traditional VPS control panels,
16-
1Panel fully embraces AI, is built with the modern Go programming language, and supports container‑based application deployment and management.
19+
## Quick Start
1720

18-
With 1Panel, you can efficiently manage your VPS—even without deep Linux command‑line expertise.
21+
Execute the script below and follow the prompts to install 1Panel:
1922

20-
Now, let’s explore what 1Panel can do for you!
23+
```bash
24+
bash -c "$(curl -sSL https://resource.1panel.pro/v2/quick_start.sh)"
25+
```
2126

22-
## Key Features
27+
## Screenshot
2328

24-
!!! note ""
25-
- One‑Click OpenClaw Deployment
26-
Seamlessly deploy OpenClaw agents, host local LLMs using Ollama, and monitor GPU utilization—all within a unified workspace.
29+
![img.png](./img/overview.png)
2730

28-
- One‑Click Website Deployment
29-
Launch production‑ready websites instantly with automatic domain binding, SSL certificate provisioning, and configuration—zero manual setup required.
31+
## Star History
3032

31-
- Curated App Marketplace
32-
Discover, install, and update trusted open‑source applications (Nextcloud, Bitwarden, Umami, and more) with a single click.
33+
[![Star History Chart](https://api.star-history.com/svg?repos=1Panel-dev/1Panel&type=Date)](https://star-history.com/#1Panel-dev/1Panel&Date)
3334

34-
- Centralized Server Management
35-
Monitor system resources and manage files, databases, containers, and services effortlessly through a unified, intuitive dashboard.
35+
## Pro Edition
3636

37-
- Enterprise‑Grade Security
38-
Strengthen your defenses with container isolation, firewall controls, audit logging, and secure deployment practices—ensuring compliance and peace of mind.
37+
Compared to the OSS Edition, 1Panel Pro Edition provides users with a wealth of enhanced features and technical support services. Enhanced features include WAF enhancement, website tamper protection, website monitoring, GPU monitoring, custom logo and theme color, etc. [Click to view the detailed introduction of the Pro Edition](https://1panel.pro/pricing).
3938

40-
- Intelligent Backup & Restore
41-
Schedule automated backups or perform instant restores to local storage or major cloud platforms (AWS S3, Cloudflare R2, and more), with flexible retention and destination options.
39+
## Security Information
4240

43-
## Community & Trust
41+
If you discover any security issues, please refer to [SECURITY.md](/SECURITY.md).
4442

45-
!!! note ""
46-
1Panel has earned over 34,000 stars on GitHub and surpassed 2 million installations worldwide.
47-
Its features, performance, stability, and security are trusted by the global open‑source community.
43+
## License
4844

49-
Welcome to try 1Panel and take full control of your VPS!
45+
Licensed under The GNU General Public License version 3 (GPLv3) (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
46+
47+
<https://www.gnu.org/licenses/gpl-3.0.html>
48+
49+
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

docs/user_manual/ai/agent.md

Lines changed: 42 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,8 @@ The parameter definitions during agent creation are detailed as follows:
8282
- Token: A token for the OpenClaw Web UI access address, which is automatically generated by the system for direct access in the follow-up.
8383
- Other Parameters: Keep the default configurations for all other parameters.
8484

85-
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.
85+
!!! note ""
86+
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.
8687

8788
![img.png](../../img/ai/1Panel_OpenClaw_Installation_Log.png)
8889

@@ -103,7 +104,8 @@ After configuring all the above parameters, click "Confirm" directly to start th
103104
!!! note ""
104105
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.
105106

106-
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.
107+
!!! note ""
108+
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.
107109

108110
### 4.1. Step 1: Create a Custom Enterprise App
109111

@@ -112,25 +114,32 @@ Note: A personal Feishu account is used in this guide. For enterprise accounts,
112114

113115
![img.png](../../img/ai/Feishu_Open_Platform_Custom_Apps_List.png)
114116

115-
As shown in the figure below, enter the relevant app name and basic information as required and click "Create".
117+
!!! note ""
118+
As shown in the figure below, enter the relevant app name and basic information as required and click "Create".
116119

117120
![img.png](../../img/ai/Feishu_Create_Custom_App_Page.png)
118121

119122
### 4.2. Step 2: Create a Bot
120-
As shown in the figure below, click to create a bot to complete the bot creation process.
123+
124+
!!! note ""
125+
As shown in the figure below, click to create a bot to complete the bot creation process.
121126

122127
![img.png](../../img/ai/Feishu_Add_Bot_Feature_Page.png)
123128

124-
After entering the bot page, click the edit button after bot configuration to define the bot name, as shown in the figure below:
129+
!!! note ""
130+
After entering the bot page, click the edit button after bot configuration to define the bot name, as shown in the figure below:
125131

126132
![img.png](../../img/ai/Feishu_Bot_Setting_Page.png)
127133

128134
### 4.3. Step 3: Permission Configuration
129-
After creating the bot, click to enter "Permissions & Scopes" and then click "Batch import/export scopes".
135+
136+
!!! note ""
137+
After creating the bot, click to enter "Permissions & Scopes" and then click "Batch import/export scopes".
130138

131139
![img.png](../../img/ai/Feishu_Permissions_Scopes_Page.png)
132140

133-
Click "Batch import/export scopes", clear the default permission configuration information, copy and paste the permission authorization script as shown below, and click "Save".
141+
!!! note ""
142+
Click "Batch import/export scopes", clear the default permission configuration information, copy and paste the permission authorization script as shown below, and click "Save".
134143

135144
```json
136145
{
@@ -170,49 +179,65 @@ Click "Batch import/export scopes", clear the default permission configuration i
170179
}
171180
```
172181

173-
The effect after pasting is shown in the figure below:
182+
!!! note ""
183+
The effect after pasting is shown in the figure below:
174184

175185
![img.png](../../img/ai/Feishu_Batch_Import_Scopes_Page.png)
176186

177-
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:
187+
!!! note ""
188+
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:
178189

179190
![img.png](../../img/ai/Feishu_Permissions_Scopes_Review_Page.png)
180191

181192
### 4.4. Step 4: Obtain Credentials and Configure in 1Panel
182-
Enter the Feishu platform and obtain the app credentials in "Credentials & Basic Info", as shown in the figure below:
193+
194+
!!! note ""
195+
Enter the Feishu platform and obtain the app credentials in "Credentials & Basic Info", as shown in the figure below:
183196

184197
![img.png](../../img/ai/Feishu_Credentials_Basic_Info_Page.png)
185198

186-
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:
199+
!!! note ""
200+
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:
187201

188202
![img.png](../../img/ai/1Panel_OpenClaw_Feishu_Channel_Config.png)
189203

190204
### 4.5. Step 5: Create Events and Callbacks
191-
As shown in the figure below, enter the "Events & Callbacks" menu and complete the subscription method setting and event addition respectively.
205+
206+
!!! note ""
207+
As shown in the figure below, enter the "Events & Callbacks" menu and complete the subscription method setting and event addition respectively.
192208

193209
![img.png](../../img/ai/Feishu_Events_Callbacks_Page.png)
194210

195211
#### Subscription Method Setting
196-
Select the persistent connection subscription method as shown in the figure below:
212+
213+
!!! note ""
214+
Select the persistent connection subscription method as shown in the figure below:
197215

198216
![img.png](../../img/ai/Feishu_Event_Subscription_Mode_Setting.png)
199217

200218
#### Add Events:
201-
Enter "im.message.receive_v1" to search, check "Receive messages" based on "App-based Subscription", and finally confirm the addition.
219+
220+
!!! note ""
221+
Enter "im.message.receive_v1" to search, check "Receive messages" based on "App-based Subscription", and finally confirm the addition.
202222

203223
![img.png](../../img/ai/Feishu_Add_Event_Im_Message_Receive.png)
204224

205225
### 4.6. Step 6: Create and Release a Version
206-
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.
226+
227+
!!! note ""
228+
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.
207229

208230
![img.png](../../img/ai/Feishu_Create_App_Version_Page.png)
209231

210232
### 4.7. Step 7: Verify the Feishu Channel Configuration
211-
After completing all the above configurations, open the app in the Feishu client as shown in the figure below:
233+
234+
!!! note ""
235+
After completing all the above configurations, open the app in the Feishu client as shown in the figure below:
212236

213237
![img.png](../../img/ai/Feishu_Client_OpenClaw_Bot_List.png)
214238

215-
Finally, perform a simple test. The prompt as shown in the figure below indicates that the configuration is successful.
239+
!!! note ""
240+
Finally, perform a simple test. The prompt as shown in the figure below indicates that the configuration is successful.
216241

217242
![img.png](../../img/ai/Feishu_OpenClaw_Bot_Chat_Test_Page.png)
218243

0 commit comments

Comments
 (0)