acepanel/acepanel.github.io
2
0
Fork 0
mirror of https://github.com/acepanel/acepanel.github.io.git synced 2026-02-04 09:13:09 +08:00
Code Issues Activity

feat: 格式化

Browse Source
This commit is contained in:
耗子
2026-01-27 01:26:41 +08:00
parent 7184c6fcb2
commit e422162f0f
48 changed files with 407 additions and 358 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
en/advanced/app.md
View File

@@ -14,13 +14,13 @@ The application module is divided into three parts:
## Native Application vs Container Template
| Feature | Native Application | Container Template |
|---------|-------------------|-------------------|
| Performance | Higher | Slight overhead |
| Isolation | Shared system environment | Fully isolated |
| Deployment Difficulty | Requires configuration | One-click deployment |
| Resource Usage | Lower | Higher |
| Use Cases | Production environment, high performance needs | Quick testing, multiple version coexistence |
| Feature | Native Application | Container Template |
|-----------------------|------------------------------------------------|---------------------------------------------|
| Performance | Higher | Slight overhead |
| Isolation | Shared system environment | Fully isolated |
| Deployment Difficulty | Requires configuration | One-click deployment |
| Resource Usage | Lower | Higher |
| Use Cases | Production environment, high performance needs | Quick testing, multiple version coexistence |
## Application Categories

17
en/advanced/app/environment.md
View File

@@ -6,13 +6,13 @@ Runtime environments are used to install runtimes for various programming langua
AcePanel supports runtime environments for the following programming languages:
| Language | Available Versions | Description |
|----------|-------------------|-------------|
| Go | 1.20 - 1.25 | Suitable for building high-performance backend services |
| Java | JDK 8, 11, 17, 21, 25 | Uses Amazon Corretto distribution |
| Node.js | 20, 22, 24 | Suitable for frontend builds and Node applications |
| PHP | 7.4 - 8.5 | Suitable for Web development |
| Python | 3.10 - 3.14 | Suitable for scripts and Web applications |
| Language | Available Versions | Description |
|----------|-----------------------|---------------------------------------------------------|
| Go | 1.20 - 1.25 | Suitable for building high-performance backend services |
| Java | JDK 8, 11, 17, 21, 25 | Uses Amazon Corretto distribution |
| Node.js | 20, 22, 24 | Suitable for frontend builds and Node applications |
| PHP | 7.4 - 8.5 | Suitable for Web development |
| Python | 3.10 - 3.14 | Suitable for scripts and Web applications |
## Runtime Environment List
@@ -32,10 +32,11 @@ Click the language category at the top to filter versions for a specific languag
4. Click the **Install** button for the corresponding version
::: tip Version Selection Recommendations
- Production environments are recommended to use LTS (Long Term Support) versions
- Versions marked "End of Life" are not recommended for new projects
- Multiple versions can be installed simultaneously and specified for use in projects
:::
:::
## Manage Runtime Environment

10
en/advanced/app/template.md
View File

@@ -62,11 +62,11 @@ After deployment, the application will appear in the **Containers** > **Compose*
## Template vs Manual Deployment
| Feature | Using Template | Manual Deployment |
|---------|----------------|-------------------|
| Configuration Difficulty | Simple, just fill in basic information | Need to write docker-compose.yml |
| Flexibility | Uses preset configuration | Fully customizable |
| Use Cases | Quick deployment of common applications | Special requirements, custom configuration |
| Feature | Using Template | Manual Deployment |
|--------------------------|-----------------------------------------|--------------------------------------------|
| Configuration Difficulty | Simple, just fill in basic information | Need to write docker-compose.yml |
| Flexibility | Uses preset configuration | Fully customizable |
| Use Cases | Quick deployment of common applications | Special requirements, custom configuration |
## Common Template Descriptions

85
en/advanced/backup.md
View File

@@ -10,11 +10,11 @@ The backup module is used to backup and restore website files and databases, sup
The backup module supports the following types of backups:
| Type | Description |
|------|---------------------------------------|
| Website | Backup website files |
| MySQL | Backup Percona/MySQL/MariaDB databases |
| PostgreSQL | Backup PostgreSQL databases |
| Type | Description |
|------------|----------------------------------------|
| Website | Backup website files |
| MySQL | Backup Percona/MySQL/MariaDB databases |
| PostgreSQL | Backup PostgreSQL databases |
## Create Backup
@@ -25,6 +25,7 @@ The backup module supports the following types of backups:
5. Click Confirm
Backup file formats:
- Website: `.zip` compressed package
- Database: `.sql.zip` compressed SQL file
@@ -70,6 +71,7 @@ Click **Add Storage** to add remote storage, supporting:
- **WebDAV**: WebDAV servers
Advantages of remote storage:
- Off-site backup to prevent data loss
- Does not occupy server disk space
- Convenient for sharing backups across multiple servers
@@ -80,48 +82,48 @@ S3 compatible storage is the most commonly used remote storage method. Most clou
#### Configuration Parameters
| Parameter | Description |
|-----------|-------------|
| Name | Name of the storage configuration for identification |
| Type | Select S3 |
| Access Key | Access Key ID |
| Secret Key | Access Key Secret |
| Style | Virtual Hosted or Path Style |
| Region | Region code, e.g., `us-east-1`, `cn-hangzhou` |
| Endpoint | S3 service endpoint URL |
| Protocol | HTTPS (recommended) or HTTP |
| Bucket | Bucket name |
| Path | Sub-path for backup file storage (optional) |
| Parameter | Description |
|------------|------------------------------------------------------|
| Name | Name of the storage configuration for identification |
| Type | Select S3 |
| Access Key | Access Key ID |
| Secret Key | Access Key Secret |
| Style | Virtual Hosted or Path Style |
| Region | Region code, e.g., `us-east-1`, `cn-hangzhou` |
| Endpoint | S3 service endpoint URL |
| Protocol | HTTPS (recommended) or HTTP |
| Bucket | Bucket name |
| Path | Sub-path for backup file storage (optional) |
#### Access Style Explanation
S3 has two URL access styles:
- **Virtual Hosted Style**: `https://bucket.endpoint/key`
- Bucket name as subdomain
- AWS S3 uses this style by default
- Bucket name as subdomain
- AWS S3 uses this style by default
- **Path Style**: `https://endpoint/bucket/key`
- Bucket name as part of the path
- Self-hosted MinIO typically uses this style
- Bucket name as part of the path
- Self-hosted MinIO typically uses this style
#### Compatibility List
| Provider | Documentation | Compatible Access Style | Compatibility |
|----------|---------------|------------------------|---------------|
| Alibaba Cloud OSS | [Docs](https://help.aliyun.com/document_detail/410748.html) | Virtual Hosted Style | ✅ |
| Tencent Cloud COS | [Docs](https://cloud.tencent.com/document/product/436/41284) | Virtual Hosted Style / Path Style | ✅ |
| Qiniu Cloud | [Docs](https://developer.qiniu.com/kodo/4088/s3-access-domainname) | Virtual Hosted Style / Path Style | ✅ |
| Baidu Cloud BOS | [Docs](https://cloud.baidu.com/doc/BOS/s/Fjwvyq9xo) | Virtual Hosted Style / Path Style | ✅ |
| JD Cloud | [Docs](https://docs.jdcloud.com/cn/object-storage-service/api/regions-and-endpoints) | Virtual Hosted Style | ✅ |
| Kingsoft Cloud | [Docs](https://docs.ksyun.com/documents/6761) | Virtual Hosted Style | ✅ |
| QingCloud QingStor | [Docs](https://docsv3.qingcloud.com/storage/object-storage/s3/intro/) | Virtual Hosted Style / Path Style | ✅ |
| NetEase Shufan | [Docs](https://sf.163.com/help/documents/89796157866430464) | Virtual Hosted Style | ✅ |
| Cloudflare R2 | [Docs](https://developers.cloudflare.com/r2/data-access/s3-api/) | Virtual Hosted Style / Path Style | ✅ |
| Oracle Cloud | [Docs](https://docs.oracle.com/en-us/iaas/Content/Object/Tasks/s3compatibleapi.htm) | Virtual Hosted Style / Path Style | ✅ |
| Upyun | [Docs](https://help.upyun.com/knowledge-base/aws-s3%E5%85%BC%E5%AE%B9/) | Virtual Hosted Style / Path Style | ✅ |
| Self-hosted MinIO | - | Path Style | ✅ |
| Huawei Cloud OBS | - | Virtual Hosted Style | ❓ |
| Provider | Documentation | Compatible Access Style | Compatibility |
|--------------------|--------------------------------------------------------------------------------------|-----------------------------------|---------------|
| Alibaba Cloud OSS | [Docs](https://help.aliyun.com/document_detail/410748.html) | Virtual Hosted Style | ✅ |
| Tencent Cloud COS | [Docs](https://cloud.tencent.com/document/product/436/41284) | Virtual Hosted Style / Path Style | ✅ |
| Qiniu Cloud | [Docs](https://developer.qiniu.com/kodo/4088/s3-access-domainname) | Virtual Hosted Style / Path Style | ✅ |
| Baidu Cloud BOS | [Docs](https://cloud.baidu.com/doc/BOS/s/Fjwvyq9xo) | Virtual Hosted Style / Path Style | ✅ |
| JD Cloud | [Docs](https://docs.jdcloud.com/cn/object-storage-service/api/regions-and-endpoints) | Virtual Hosted Style | ✅ |
| Kingsoft Cloud | [Docs](https://docs.ksyun.com/documents/6761) | Virtual Hosted Style | ✅ |
| QingCloud QingStor | [Docs](https://docsv3.qingcloud.com/storage/object-storage/s3/intro/) | Virtual Hosted Style / Path Style | ✅ |
| NetEase Shufan | [Docs](https://sf.163.com/help/documents/89796157866430464) | Virtual Hosted Style | ✅ |
| Cloudflare R2 | [Docs](https://developers.cloudflare.com/r2/data-access/s3-api/) | Virtual Hosted Style / Path Style | ✅ |
| Oracle Cloud | [Docs](https://docs.oracle.com/en-us/iaas/Content/Object/Tasks/s3compatibleapi.htm) | Virtual Hosted Style / Path Style | ✅ |
| Upyun | [Docs](https://help.upyun.com/knowledge-base/aws-s3%E5%85%BC%E5%AE%B9/) | Virtual Hosted Style / Path Style | ✅ |
| Self-hosted MinIO | - | Path Style | ✅ |
| Huawei Cloud OBS | - | Virtual Hosted Style | ❓ |
::: tip Note
Huawei Cloud official documentation does not specify S3 API compatibility, but it works in actual testing.
@@ -190,10 +192,11 @@ Path: (optional)
```
::: warning Note
- Please ensure the bucket has been created and has correct access permissions
- It is recommended to create dedicated access keys for backups with limited permissions
- Some providers' Endpoints need to include region information
:::
:::
## Scheduled Backup
@@ -209,10 +212,10 @@ Combined with the [Scheduled Tasks](./task/schedule) feature, you can set up aut
### Backup Frequency
| Data Type | Recommended Frequency |
|-----------|----------------------|
| Database | Daily |
| Website Files | Weekly |
| Data Type | Recommended Frequency |
|---------------------|--------------------------------|
| Database | Daily |
| Website Files | Weekly |
| Configuration Files | Immediately after modification |
### Retention Policy

13
en/advanced/cert.md
View File

@@ -6,11 +6,11 @@ The certificate module is used to manage SSL/TLS certificates, supporting automa
The certificate module is divided into three parts:
| Feature | Description |
|---------|-------------|
| [Certificate](./cert/cert) | Manage SSL certificates |
| [Account](./cert/account) | Manage ACME accounts |
| [DNS](./cert/dns) | Manage DNS API configuration |
| Feature | Description |
|----------------------------|------------------------------|
| [Certificate](./cert/cert) | Manage SSL certificates |
| [Account](./cert/account) | Manage ACME accounts |
| [DNS](./cert/dns) | Manage DNS API configuration |
![Certificate List](/images/cert/cert-list.png)
@@ -48,6 +48,7 @@ When applying for a certificate, you need to verify domain ownership. The follow
Place a verification file in the website root directory, and the CA verifies through HTTP access.
Requirements:
- Domain is resolved to the server
- Port 80 is accessible
@@ -56,10 +57,12 @@ Requirements:
Add a TXT record in the domain DNS for verification.
Requirements:
- Have DNS management permissions for the domain
- Configure DNS API (for automatic verification)
Advantages of DNS verification:
- Supports applying for wildcard certificates (*.example.com)
- Does not require port 80 to be accessible
- Suitable for intranet servers

34
en/advanced/cert/account.md
View File

@@ -19,32 +19,32 @@ The list displays the following information:
1. Click the **Create Account** button
2. Fill in the configuration:
- **Email**: Used to receive certificate-related notifications
- **CA**: Select certificate authority
- **Key Type**: Select key algorithm
- **KID**: Optional, some CAs require KID
- **HMAC**: Optional, some CAs require HMAC key
- **Email**: Used to receive certificate-related notifications
- **CA**: Select certificate authority
- **Key Type**: Select key algorithm
- **KID**: Optional, some CAs require KID
- **HMAC**: Optional, some CAs require HMAC key
3. Click Create
### Certificate Authority (CA)
| CA | Description |
|---------------|-------------------------------|
| Let's Encrypt | Most popular free CA, certificate valid for 90 days |
| LiteSSL | Free certificate service provided by TrustAsia |
| Google | Google's free certificate service |
| CA | Description |
|---------------|--------------------------------------------------------|
| Let's Encrypt | Most popular free CA, certificate valid for 90 days |
| LiteSSL | Free certificate service provided by TrustAsia |
| Google | Google's free certificate service |
| GoogleCN | Google certificate service mirror provided by AcePanel |
| ZeroSSL | Free CA, certificate valid for 90 days |
| Buypass | Norwegian free CA, certificate valid for 180 days |
| ZeroSSL | Free CA, certificate valid for 90 days |
| Buypass | Norwegian free CA, certificate valid for 180 days |
### Key Type
| Type | Description |
|------|-------------|
| Type | Description |
|------------|----------------------------------------------|
| P256 (ECC) | Recommended, shorter key, better performance |
| P384 (ECC) | Higher security ECC key |
| RSA 2048 | Traditional RSA key, best compatibility |
| RSA 4096 | Higher security RSA key |
| P384 (ECC) | Higher security ECC key |
| RSA 2048 | Traditional RSA key, best compatibility |
| RSA 4096 | Higher security RSA key |
::: tip Recommendation
Generally recommended to use P256 (ECC) key, balancing security and performance.

2
en/advanced/cert/cert.md
View File

@@ -48,6 +48,7 @@ Wildcard certificates (*.example.com) can only be applied through DNS verificati
Click the **Upload Certificate** button to upload an existing certificate.
Required:
- **Certificate File**: PEM format certificate (.crt or .pem), please include complete certificate chain
- **Private Key File**: PEM format private key (.key)
@@ -79,6 +80,7 @@ Click the **Renew** button to manually trigger certificate renewal.
### Download Certificate
Click the **Download** button to download certificate files, including:
- Complete certificate chain (.crt)
- Private key file (.key)

26
en/advanced/cert/dns.md
View File

@@ -25,22 +25,22 @@ The list displays the following information:
### Domestic Providers
| Provider | Required Credentials |
|----------|---------------------|
| Alibaba Cloud DNS | AccessKey ID, AccessKey Secret |
| Tencent Cloud DNSPod | SecretId, SecretKey |
| Huawei Cloud DNS | AccessKeyId, SecretAccessKey |
| West.cn DNS | Username, API Password |
| Provider | Required Credentials |
|----------------------|--------------------------------|
| Alibaba Cloud DNS | AccessKey ID, AccessKey Secret |
| Tencent Cloud DNSPod | SecretId, SecretKey |
| Huawei Cloud DNS | AccessKeyId, SecretAccessKey |
| West.cn DNS | Username, API Password |
### International Providers
| Provider | Required Credentials |
|----------|------------------------------------|
| Cloudflare | API Token |
| Gcore DNS | API Key |
| Porkbun | API Key, Secret Key |
| NameSilo | API Token |
| ClouDNS | Auth ID, Auth Password |
| Provider | Required Credentials |
|------------|------------------------|
| Cloudflare | API Token |
| Gcore DNS | API Key |
| Porkbun | API Key, Secret Key |
| NameSilo | API Token |
| ClouDNS | Auth ID, Auth Password |
## Obtaining API Credentials

32
en/advanced/container.md
View File

@@ -4,22 +4,22 @@ The container module provides complete Docker container management functionality
## Prerequisites
Before using the container feature, you need to install Docker first:
Before using the container feature, you need to install Docker or Podman first:
1. Go to **Applications** > **Native Applications**
2. Find Docker, click **Install**
2. Find Docker or Podman, click **Install**
## Feature Overview
The container module is divided into five parts:
| Feature | Description |
|---------|-------------|
| [Container](./container/container) | Manage running container instances |
| [Compose](./container/compose) | Manage multi-container applications using Docker Compose |
| [Image](./container/image) | Manage local images |
| [Network](./container/network) | Manage Docker networks |
| [Volume](./container/volume) | Manage data volumes |
| Feature | Description |
|------------------------------------|----------------------------------------------------------|
| [Container](./container/container) | Manage running container instances |
| [Compose](./container/compose) | Manage multi-container applications using Docker Compose |
| [Image](./container/image) | Manage local images |
| [Network](./container/network) | Manage Docker networks |
| [Volume](./container/volume) | Manage data volumes |
![Container List](/images/container/container-list.png)
@@ -39,13 +39,13 @@ If you want to quickly deploy common applications, it is recommended to use [Con
## Container vs Native Application
| Feature | Container | Native Application |
|---------|-----------|-------------------|
| Isolation | Fully isolated | Shared system environment |
| Performance | Slight overhead | Native performance |
| Deployment | Standardized, portable | Depends on system environment |
| Resource Usage | Higher | Lower |
| Version Management | Easy to switch | Requires manual management |
| Feature | Container | Native Application |
|--------------------|------------------------|-------------------------------|
| Isolation | Fully isolated | Shared system environment |
| Performance | Slight overhead | Native performance |
| Deployment | Standardized, portable | Depends on system environment |
| Resource Usage | Higher | Lower |
| Version Management | Easy to switch | Requires manual management |
## Next Steps

12
en/advanced/container/compose.md
View File

@@ -100,9 +100,9 @@ Compose is suitable for the following scenarios:
## Difference from Container Templates
| Feature | Compose | Container Templates |
|---------|---------|-------------------------|
| Configuration Method | Write YAML manually | Graphical interface |
| Flexibility | Fully customizable | Use preset configuration + customization |
| Use Cases | Custom complex applications | Quick deployment of common applications |
| Learning Cost | Need to understand Compose syntax | No learning required |
| Feature | Compose | Container Templates |
|----------------------|-----------------------------------|------------------------------------------|
| Configuration Method | Write YAML manually | Graphical interface |
| Flexibility | Fully customizable | Use preset configuration + customization |
| Use Cases | Custom complex applications | Quick deployment of common applications |
| Learning Cost | Need to understand Compose syntax | No learning required |

8
en/advanced/container/container.md
View File

@@ -29,10 +29,10 @@ Click the **Create Container** button to open the creation dialog.
- **Image**: Docker image name, e.g., `nginx:latest`, `mysql:8.0`
- **Network**: Select the network for the container to use
- **Restart Policy**: Restart behavior after container exits
- None: Do not auto restart
- always: Always restart
- on-failure: Restart on failure
- unless-stopped: Restart unless manually stopped
- None: Do not auto restart
- always: Always restart
- on-failure: Restart on failure
- unless-stopped: Restart unless manually stopped
### Advanced Options

1
en/advanced/container/image.md
View File

@@ -58,6 +58,7 @@ The cleanup operation will delete:
Docker's official image registry, containing a large number of official and community images.
Common official images:
- `nginx` - Web server
- `mysql` / `mariadb` - Database
- `redis` - Cache

14
en/advanced/container/network.md
View File

@@ -22,11 +22,11 @@ The list displays the following information:
Docker automatically creates the following networks after installation:
| Network Name | Driver | Description |
|--------------|--------|-------------|
| bridge | bridge | Default network, containers access external network through NAT |
| host | host | Container directly uses host network, no network isolation |
| none | null | No network, container is completely isolated |
| Network Name | Driver | Description |
|--------------|--------|-----------------------------------------------------------------|
| bridge | bridge | Default network, containers access external network through NAT |
| host | host | Container directly uses host network, no network isolation |
| none | null | No network, container is completely isolated |
AcePanel also creates the `acepanel-network` network for containers deployed by panel compose templates. Please do not delete it.
@@ -56,6 +56,7 @@ When creating a container, select the network to use in the **Network** option.
Containers in the same network can access each other by container name.
For example, in the `acepanel-network` network:
- Container A is named `web`
- Container B is named `db`
- Container A can access Container B's database through `db:3306`
@@ -65,9 +66,10 @@ For example, in the `acepanel-network` network:
Select a network and click the **Delete** button to delete the network.
::: warning Note
- Default networks (bridge, host, none) and `acepanel-network` cannot be deleted
- If there are containers in the network, you need to delete or disconnect the containers before deleting the network
:::
:::
## Clean Networks

15
en/advanced/container/volume.md
View File

@@ -34,18 +34,19 @@ When creating a container, add volume mounts in the **Volume** option:
- **host_path:container_path** - Directly mount host directory
For example:
- `mysql_data:/var/lib/mysql` - Mount mysql_data volume to container's /var/lib/mysql
- `/opt/ace/data:/data` - Mount host's /opt/ace/data directory to container's /data
### Volume vs Bind Mount
| Feature | Volume | Bind Mount |
|---------|--------|------------|
| Management | Docker managed | User managed |
| Storage Location | Docker data directory | Any host path |
| Backup | Requires Docker commands | Directly backup directory |
| Portability | High | Depends on host path |
| Use Cases | Data that needs persistence like databases | Configuration files, code directories |
| Feature | Volume | Bind Mount |
|------------------|--------------------------------------------|---------------------------------------|
| Management | Docker managed | User managed |
| Storage Location | Docker data directory | Any host path |
| Backup | Requires Docker commands | Directly backup directory |
| Portability | High | Depends on host path |
| Use Cases | Data that needs persistence like databases | Configuration files, code directories |
## Delete Volume

22
en/advanced/database.md
View File

@@ -13,22 +13,22 @@ Before using the database feature, you need to install database software first:
The database module is divided into three parts:
| Feature | Description |
|---------|-------------|
| [Database](./database/database) | Create and manage databases |
| [User](./database/user) | Manage database users and permissions |
| [Server](./database/server) | Manage database server connections |
| Feature | Description |
|---------------------------------|---------------------------------------|
| [Database](./database/database) | Create and manage databases |
| [User](./database/user) | Manage database users and permissions |
| [Server](./database/server) | Manage database server connections |
![Database List](/images/database/database-list.png)
## Supported Databases
| Database | Description |
|----------|-------------|
| Percona | High-performance fork of MySQL, suitable for high-load scenarios |
| MySQL | The world's most popular open-source relational database |
| MariaDB | Open-source fork of MySQL, fully compatible with MySQL |
| PostgreSQL | Powerful open-source object-relational database |
| Database | Description |
|------------|------------------------------------------------------------------|
| Percona | High-performance fork of MySQL, suitable for high-load scenarios |
| MySQL | The world's most popular open-source relational database |
| MariaDB | Open-source fork of MySQL, fully compatible with MySQL |
| PostgreSQL | Powerful open-source object-relational database |
## Quick Start

4
en/advanced/database/database.md
View File

@@ -21,8 +21,8 @@ The list displays the following information:
1. Click the **Create Database** button
2. Fill in the configuration:
- **Server**: Select database server
- **Database Name**: Can only use letters, numbers, and underscores
- **Server**: Select database server
- **Database Name**: Can only use letters, numbers, and underscores
3. Choose whether to create a user and set permissions (optional)
4. Click Create

20
en/advanced/database/server.md
View File

@@ -31,12 +31,12 @@ After installing database software, AcePanel will automatically add local server
1. Click the **Add Server** button
2. Fill in the configuration:
- **Type**: Select database type
- **Name**: Server name (for identification)
- **Host**: Server address
- **Port**: Database port
- **Username**: Administrator username
- **Password**: Administrator password
- **Type**: Select database type
- **Name**: Server name (for identification)
- **Host**: Server address
- **Port**: Database port
- **Username**: Administrator username
- **Password**: Administrator password
3. Click Add
### Remote Server Use Cases
@@ -80,7 +80,7 @@ After adding or modifying a server, the system will automatically test the conne
## Default Ports
| Database | Default Port |
|-------------------------|--------------|
| Percona/MySQL/MariaDB | 3306 |
| PostgreSQL | 5432 |
| Database | Default Port |
|-----------------------|--------------|
| Percona/MySQL/MariaDB | 3306 |
| PostgreSQL | 5432 |

22
en/advanced/database/user.md
View File

@@ -25,21 +25,21 @@ The list displays the following information:
1. Click the **Create User** button
2. Fill in the configuration:
- **Server**: Select database server
- **Username**: Database username
- **Password**: User password (strong password recommended)
- **Host**: Allowed connection host address
- **Permissions**: Select databases the user can access
- **Server**: Select database server
- **Username**: Database username
- **Password**: User password (strong password recommended)
- **Host**: Allowed connection host address
- **Permissions**: Select databases the user can access
3. Click Create
### Host Settings
| Value | Description |
|-------|-------------|
| `localhost` | Only allow local connections |
| `127.0.0.1` | Only allow local IP connections |
| `%` | Allow connections from any host |
| `192.168.1.%` | Allow connections from specified subnet |
| Value | Description |
|-----------------|------------------------------------------|
| `localhost` | Only allow local connections |
| `127.0.0.1` | Only allow local IP connections |
| `%` | Allow connections from any host |
| `192.168.1.%` | Allow connections from specified subnet |
| `192.168.1.100` | Only allow connections from specified IP |
::: warning Security Notice

58
en/advanced/file.md
View File

@@ -17,13 +17,13 @@ The file module provides a powerful graphical file manager. The design philosoph
### Keyboard Shortcuts
| Shortcut | Function |
|----------|----------|
| `Ctrl+C` | Copy |
| `Ctrl+X` | Cut |
| `Ctrl+V` | Paste |
| `Delete` | Delete |
| `F2` | Rename |
| Shortcut | Function |
|----------|------------|
| `Ctrl+C` | Copy |
| `Ctrl+X` | Cut |
| `Ctrl+V` | Paste |
| `Delete` | Delete |
| `F2` | Rename |
| `Ctrl+A` | Select All |
## Navigation
@@ -44,14 +44,14 @@ The top displays breadcrumb navigation of the current path. Click to quickly jum
The file list displays the following information:
| Column | Description |
|--------|-------------|
| Name | File or directory name |
| Size | File size, directories show "Calculate" which can be clicked to calculate |
| Permissions | File permissions (e.g., 0755) |
| Owner/Group | File owner and group |
| Modified Time | Last modified time |
| Actions | Open, compress, rename, delete, more |
| Column | Description |
|---------------|---------------------------------------------------------------------------|
| Name | File or directory name |
| Size | File size, directories show "Calculate" which can be clicked to calculate |
| Permissions | File permissions (e.g., 0755) |
| Owner/Group | File owner and group |
| Modified Time | Last modified time |
| Actions | Open, compress, rename, delete, more |
### Select Files
@@ -83,6 +83,7 @@ Click the **More** button on the file row to display more action options:
### New
Click the **New** button to:
- Create new file
- Create new directory
@@ -91,6 +92,7 @@ Click the **New** button to:
Click the **Upload** button to upload local files to the server.
Supported upload methods:
- Click to select files for upload
- **Drag-and-drop Upload**: Directly drag files to the page to upload
@@ -99,6 +101,7 @@ Supported upload methods:
Click the **Remote Download** button, enter a URL address to download remote files to the current directory.
Use cases:
- Download software installation packages
- Download remote backup files
- Get files from other servers
@@ -106,6 +109,7 @@ Use cases:
### Search
Enter keywords in the search box to search for files:
- Default searches current directory
- Check **Include Subdirectories** to search recursively
@@ -134,13 +138,13 @@ AcePanel has a built-in powerful code editor based on Monaco Editor (the same ed
### Editor Shortcuts
| Shortcut | Function |
|----------|----------|
| `Ctrl+S` | Save current file |
| `Ctrl+Shift+S` | Save all files |
| `Ctrl+F` | Search |
| `Ctrl+H` | Replace |
| `Ctrl+G` | Go to line |
| Shortcut | Function |
|----------------|-------------------|
| `Ctrl+S` | Save current file |
| `Ctrl+Shift+S` | Save all files |
| `Ctrl+F` | Search |
| `Ctrl+H` | Replace |
| `Ctrl+G` | Go to line |
### Editor Toolbar
@@ -164,6 +168,7 @@ Click the **Maximize** button for fullscreen editing to get more editing space:
### Sidebar File Tree
The left side of the editor displays the file tree of the current directory, allowing you to:
- Quickly switch to edit other files
- Create new files
- Search files
@@ -171,6 +176,7 @@ The left side of the editor displays the file tree of the current directory, all
### Status Bar
The editor bottom status bar displays:
- Full file path
- Line ending type (LF/CRLF)
- Cursor position (line, column)
@@ -183,16 +189,18 @@ Linux file permissions are represented by three groups of numbers:
| Permission | Number | Description |
|------------|--------|-------------|
| r | 4 | Read |
| w | 2 | Write |
| x | 1 | Execute |
| r | 4 | Read |
| w | 2 | Write |
| x | 1 | Execute |
For example `0755`:
- Owner: 7 (4+2+1) = read+write+execute
- Group: 5 (4+1) = read+execute
- Others: 5 (4+1) = read+execute
Common permissions:
- `0644`: Regular files
- `0755`: Executable files and directories
- `0600`: Private files (such as keys)

6
en/advanced/monitor.md
View File

@@ -31,6 +31,7 @@ System load reflects the busyness of the CPU:
- **15-minute load**: Average load over the last 15 minutes
Load value reference:
- Load < CPU cores: System running smoothly
- Load = CPU cores: System running at full capacity
- Load > CPU cores: System overloaded, may experience lag
@@ -38,6 +39,7 @@ Load value reference:
### CPU Usage
Displays CPU usage percentage, including:
- User mode usage
- System mode usage
- Idle rate
@@ -45,6 +47,7 @@ Displays CPU usage percentage, including:
### Memory Usage
Displays memory usage:
- Used memory
- Available memory
- Cache/Buffer
@@ -52,6 +55,7 @@ Displays memory usage:
### Disk I/O
Displays disk read/write speed:
- Read speed (KB/s or MB/s)
- Write speed (KB/s or MB/s)
@@ -60,6 +64,7 @@ You can select the disk device to monitor.
### Network Traffic
Displays network interface traffic:
- Send speed
- Receive speed
@@ -79,6 +84,7 @@ Each monitoring chart supports selecting a time range:
### Performance Analysis
Analyze server performance bottlenecks through monitoring data:
- Sustained high CPU load: Consider optimizing programs or upgrading CPU
- Insufficient memory: Consider adding memory or optimizing memory usage
- High disk I/O: Consider using SSD or optimizing database queries

34
en/advanced/project.md
View File

@@ -4,25 +4,25 @@ The project module is used to manage backend applications, supporting multiple l
## Project Types
| Type | Description | Use Cases |
|------|-------------|-----------|
| [Go](./project/go) | Go language projects | Gin, Echo, Fiber frameworks |
| [Java](./project/java) | Java projects | Spring Boot, Tomcat, etc. |
| [Node.js](./project/nodejs) | Node.js projects | Express, Koa, NestJS, etc. |
| [PHP](./project/php) | PHP projects | Laravel Octane, Swoole, etc. |
| [Python](./project/python) | Python projects | Django, Flask, FastAPI, etc. |
| [General](./project/general) | Other types of projects | Any executable program |
| Type | Description | Use Cases |
|------------------------------|-------------------------|------------------------------|
| [Go](./project/go) | Go language projects | Gin, Echo, Fiber frameworks |
| [Java](./project/java) | Java projects | Spring Boot, Tomcat, etc. |
| [Node.js](./project/nodejs) | Node.js projects | Express, Koa, NestJS, etc. |
| [PHP](./project/php) | PHP projects | Laravel Octane, Swoole, etc. |
| [Python](./project/python) | Python projects | Django, Flask, FastAPI, etc. |
| [General](./project/general) | Other types of projects | Any executable program |
![Project List](/images/project/project-list.png)
## Project vs Website
| Feature | Project | Website |
|---------|---------|---------|
| Run Mode | Independent process | Depends on Web server |
| Process Management | Auto restart, auto-start on boot | Managed by Web server |
| Use Cases | Backend services, APIs | Traditional Web applications |
| External Access | Requires reverse proxy | Direct access |
| Feature | Project | Website |
|--------------------|----------------------------------|------------------------------|
| Run Mode | Independent process | Depends on Web server |
| Process Management | Auto restart, auto-start on boot | Managed by Web server |
| Use Cases | Backend services, APIs | Traditional Web applications |
| External Access | Requires reverse proxy | Direct access |
## Create Project
@@ -128,9 +128,9 @@ Security options to enhance service isolation:
- **Protect /tmp**: Create a private /tmp directory for the service
- **Protect /home**: Restrict access to the /home directory
- **Protect System**: Set read-only protection level for system directories
- `true`: /usr, /boot are read-only
- `full`: + /etc is read-only
- `strict`: Entire filesystem is read-only
- `true`: /usr, /boot are read-only
- `full`: + /etc is read-only
- `strict`: Entire filesystem is read-only
- **Read-Write Paths**: Paths the service can read and write
- **Read-Only Paths**: Paths the service can only read

6
en/advanced/project/general.md
View File

@@ -15,9 +15,9 @@ General projects are used to deploy any type of executable program, not limited
1. Go to the **Projects** page
2. Click **Create Project**
3. Fill in the configuration:
- **Project Name**: Project identifier
- **Project Directory**: Directory where the executable is located
- **Startup Command**: Command to start the program
- **Project Name**: Project identifier
- **Project Directory**: Directory where the executable is located
- **Startup Command**: Command to start the program
4. Enable **Reverse Proxy** as needed
## Startup Command Examples

6
en/advanced/project/go.md
View File

@@ -38,9 +38,9 @@ go build -o myapp
1. Go to the **Project** page
2. Click **Create Project**
3. Fill in configuration:
- **Project Name**: `myapp`
- **Project Directory**: `/opt/ace/project/myapp`
- **Start Command**: `./myapp` or `go1.24 run main.go`
- **Project Name**: `myapp`
- **Project Directory**: `/opt/ace/project/myapp`
- **Start Command**: `./myapp` or `go1.24 run main.go`
4. Enable **Reverse Proxy** for external access
## Start Command Examples

18
en/advanced/project/java.md
View File

@@ -23,9 +23,9 @@ mvn clean package -DskipTests
1. Upload JAR file to server (e.g., `/opt/ace/project/myapp/app.jar`)
2. Create project:
- **Project Name**: `myapp`
- **Project Directory**: `/opt/ace/project/myapp`
- **Start Command**: `java21 -jar app.jar`
- **Project Name**: `myapp`
- **Project Directory**: `/opt/ace/project/myapp`
- **Start Command**: `java21 -jar app.jar`
3. Enable **Reverse Proxy**
## Start Command Examples
@@ -58,12 +58,12 @@ java21 \
Common parameter descriptions:
| Parameter | Description |
|-----------|-------------|
| `-Xms` | Initial heap memory size |
| `-Xmx` | Maximum heap memory size |
| `-XX:+UseG1GC` | Use G1 garbage collector |
| `-XX:MaxGCPauseMillis` | Maximum GC pause time |
| Parameter | Description |
|------------------------|--------------------------|
| `-Xms` | Initial heap memory size |
| `-Xmx` | Maximum heap memory size |
| `-XX:+UseG1GC` | Use G1 garbage collector |
| `-XX:MaxGCPauseMillis` | Maximum GC pause time |
## Multiple JDK Versions

8
en/advanced/project/nodejs.md
View File

@@ -18,9 +18,9 @@ npm24 install
```
3. Create project:
- **Project Name**: `myapp`
- **Project Directory**: `/opt/ace/project/myapp`
- **Start Command**: `node24 app.js`
- **Project Name**: `myapp`
- **Project Directory**: `/opt/ace/project/myapp`
- **Start Command**: `node24 app.js`
4. Enable **Reverse Proxy**
## Start Command Examples
@@ -51,7 +51,7 @@ const express = require('express');
const app = express();
app.get('/', (req, res) => {
res.send('Hello World');
res.send('Hello World');
});
app.listen(3000);

6
en/advanced/project/php.md
View File

@@ -24,9 +24,9 @@ Traditional PHP-FPM applications (such as WordPress, Laravel) should be deployed
### Creating a Project
1. Create project:
- **Project Name**: `myapp`
- **Project Directory**: `/opt/ace/project/myapp`
- **Startup Command**: `php84 artisan octane:start --host=0.0.0.0 --port=8000`
- **Project Name**: `myapp`
- **Project Directory**: `/opt/ace/project/myapp`
- **Startup Command**: `php84 artisan octane:start --host=0.0.0.0 --port=8000`
2. Enable **Reverse Proxy**
## Startup Command Examples

6
en/advanced/project/python.md
View File

@@ -20,9 +20,9 @@ pip install -r requirements.txt
```
3. Create project:
- **Project Name**: `myapp`
- **Project Directory**: `/opt/ace/project/myapp`
- **Startup Command**: See examples below
- **Project Name**: `myapp`
- **Project Directory**: `/opt/ace/project/myapp`
- **Startup Command**: See examples below
4. Enable **Reverse Proxy**
## Startup Command Examples

8
en/advanced/setting/basic.md
View File

@@ -39,10 +39,10 @@ Before changing the port, please ensure the new port is open in the server secur
Configure the default storage paths for various resources:
| Setting | Default Value | Description |
|---------|---------------|-------------|
| Default Website Directory | /opt/ace/sites | Directory for storing website files |
| Default Backup Directory | /opt/ace/backup | Directory for storing backup files |
| Setting | Default Value | Description |
|---------------------------|-------------------|-------------------------------------|
| Default Website Directory | /opt/ace/sites | Directory for storing website files |
| Default Backup Directory | /opt/ace/backup | Directory for storing backup files |
| Default Project Directory | /opt/ace/projects | Directory for storing project files |
After changing directories, newly created websites/backups/projects will use the new directory, existing ones are not affected.

4
en/advanced/setting/safe.md
View File

@@ -35,6 +35,7 @@ When enabled, entering the wrong password multiple times during login will trigg
When the panel is deployed behind a reverse proxy (such as Nginx, CDN), you need to set the correct IP header to obtain the real client IP.
Common values:
- `X-Real-IP`: Default used by Nginx
- `X-Forwarded-For`: Standard proxy header
- `CF-Connecting-IP`: Used by Cloudflare
@@ -44,6 +45,7 @@ Common values:
Restrict panel access to specified domains only. After adding a domain, access via IP or other domains will be blocked.
Suitable for:
- Improving security
- Using with SSL certificates
@@ -52,6 +54,7 @@ Suitable for:
Restrict panel access to specified IP addresses only. Multiple IP addresses can be added.
Suitable for:
- Fixed office networks
- Jump server access
@@ -68,6 +71,7 @@ This is an advanced security option that can be used with custom browser plugins
## Offline Mode
When enabled, the panel will not connect to external networks, including:
- Checking for updates
- Downloading applications
- Syncing cache data

12
en/advanced/setting/user.md
View File

@@ -8,12 +8,12 @@ The user management page is used to manage panel login users.
The list displays information for all panel users:
| Field | Description |
|-------|-------------|
| Username | Login username, can be modified directly in the table |
| Email | User email, used for password recovery and other features |
| Two-Factor Auth | Whether TOTP two-factor authentication is enabled |
| Created At | User creation time |
| Field | Description |
|-----------------|-----------------------------------------------------------|
| Username | Login username, can be modified directly in the table |
| Email | User email, used for password recovery and other features |
| Two-Factor Auth | Whether TOTP two-factor authentication is enabled |
| Created At | User creation time |
## Create User

6
en/advanced/ssh.md
View File

@@ -22,10 +22,10 @@ Click the **Create Host** button to add an SSH connection:
### Authentication Methods
| Method | Description |
|--------|-------------|
| Method | Description |
|----------|------------------------------------------|
| Password | Authenticate using username and password |
| Key | Authenticate using SSH private key |
| Key | Authenticate using SSH private key |
::: tip Recommendation
Production environments are recommended to use key authentication for better security.

13
en/advanced/task/panel.md
View File

@@ -18,17 +18,18 @@ The list displays the following information:
## Task Status
| Status | Description |
|--------|-------------|
| Running | Task is being executed |
| Status | Description |
|-----------|----------------------------|
| Running | Task is being executed |
| Completed | Task executed successfully |
| Failed | Task execution failed |
| Failed | Task execution failed |
## Common Task Types
### Application Installation
Installation tasks are created when installing native applications:
- Install application Nginx
- Install application MySQL
- Install application Docker
@@ -36,12 +37,14 @@ Installation tasks are created when installing native applications:
### Application Uninstallation
Uninstallation tasks are created when uninstalling applications:
- Uninstall application MariaDB
- Uninstall application Redis
### Environment Installation
Installation tasks are created when installing runtime environments:
- Install environment PHP 8.4
- Install environment Node.js 20
- Install environment Go 1.24
@@ -49,6 +52,7 @@ Installation tasks are created when installing runtime environments:
## View Logs
Click the **Logs** button to view detailed execution logs of the task, including:
- Command output
- Error messages
@@ -71,6 +75,7 @@ If a task fails:
3. Re-execute the operation after resolving the issue
Common failure causes:
- Network issues causing download failures
- Insufficient disk space
- Missing dependencies

26
en/advanced/task/schedule.md
View File

@@ -24,12 +24,12 @@ Click the **Create Task** button to create a new scheduled task.
### Task Types
| Type | Description |
|------|-------------|
| Shell | Execute Shell commands or scripts |
| Backup Website | Scheduled backup of website files |
| Backup Database | Scheduled backup of database |
| Log Rotation | Scheduled rotation of log files |
| Type | Description |
|-----------------|-----------------------------------|
| Shell | Execute Shell commands or scripts |
| Backup Website | Scheduled backup of website files |
| Backup Database | Scheduled backup of database |
| Log Rotation | Scheduled rotation of log files |
### Execution Schedule
@@ -58,13 +58,13 @@ Cron expression format: `minute hour day month weekday`
Common examples:
| Expression | Description |
|------------|-------------|
| `0 2 * * *` | Every day at 2 AM |
| `0 */6 * * *` | Every 6 hours |
| `0 0 * * 0` | Every Sunday at midnight |
| `0 0 1 * *` | First day of every month at midnight |
| `*/5 * * * *` | Every 5 minutes |
| Expression | Description |
|---------------|--------------------------------------|
| `0 2 * * *` | Every day at 2 AM |
| `0 */6 * * *` | Every 6 hours |
| `0 0 * * 0` | Every Sunday at midnight |
| `0 0 1 * *` | First day of every month at midnight |
| `*/5 * * * *` | Every 5 minutes |
Don't know how to write it? Just describe your requirements clearly to an AI and let it generate one for you.

18
en/advanced/toolbox.md
View File

@@ -4,15 +4,15 @@ The toolbox provides a series of system management tools, including process mana
## Feature List
| Feature | Description |
|---------|-------------|
| [Process](./toolbox/process) | View and manage system processes |
| [System](./toolbox/system) | View system information and configuration |
| [SSH](./toolbox/ssh) | SSH service configuration |
| [Disk](./toolbox/disk) | Disk usage and management |
| [Log Cleanup](./toolbox/log) | Clean up system logs |
| [Web Hook](./toolbox/webhook) | Configure Webhook notifications |
| [Benchmark](./toolbox/benchmark) | Server performance testing |
| Feature | Description |
|----------------------------------|-------------------------------------------|
| [Process](./toolbox/process) | View and manage system processes |
| [System](./toolbox/system) | View system information and configuration |
| [SSH](./toolbox/ssh) | SSH service configuration |
| [Disk](./toolbox/disk) | Disk usage and management |
| [Log Cleanup](./toolbox/log) | Clean up system logs |
| [Web Hook](./toolbox/webhook) | Configure Webhook notifications |
| [Benchmark](./toolbox/benchmark) | Server performance testing |
![Toolbox](/images/toolbox/toolbox-process.png)

21
en/advanced/toolbox/disk.md
View File

@@ -20,16 +20,16 @@ The top of the page displays basic information for each disk:
Each disk shows its partition information:
| Column | Description |
|--------|-------------|
| Column | Description |
|----------------|-------------------------------------------|
| Partition Name | Partition device name, such as vda1, vda2 |
| Size | Partition capacity |
| Used | Used space |
| Available | Available space |
| Usage | Usage percentage |
| Mount Point | Mount directory, such as `/`, `/data` |
| File System | File system type, such as ext4, xfs |
| Actions | Unmount and other operations |
| Size | Partition capacity |
| Used | Used space |
| Available | Available space |
| Usage | Usage percentage |
| Mount Point | Mount directory, such as `/`, `/data` |
| File System | File system type, such as ext4, xfs |
| Actions | Unmount and other operations |
### Mount Partition
@@ -81,6 +81,7 @@ LVM (Logical Volume Manager) provides flexible disk space management with suppor
Physical volumes are the foundation of LVM, typically a disk partition or an entire disk.
**Create Physical Volume**:
1. Select device (unused partition or disk)
2. Click **Create Physical Volume**
@@ -89,6 +90,7 @@ Physical volumes are the foundation of LVM, typically a disk partition or an ent
A volume group consists of one or more physical volumes, representing a storage pool concept.
**Create Volume Group**:
1. Enter volume group name
2. Select physical volumes to add
3. Click **Create Volume Group**
@@ -98,6 +100,7 @@ A volume group consists of one or more physical volumes, representing a storage
Logical volumes allocate space from volume groups, equivalent to traditional partitions.
**Create Logical Volume**:
1. Enter logical volume name
2. Select volume group
3. Set size (GB)

28
en/advanced/toolbox/process.md
View File

@@ -22,13 +22,13 @@ The list displays the following information:
## Process Status
| Status | Description |
|--------|-------------|
| Running | Process is executing |
| Sleeping | Process is waiting for an event |
| Idle | Kernel thread is idle |
| Stopped | Process has stopped |
| Zombie | Process has ended but not been reaped |
| Status | Description |
|----------|---------------------------------------|
| Running | Process is executing |
| Sleeping | Process is waiting for an event |
| Idle | Kernel thread is idle |
| Stopped | Process has stopped |
| Zombie | Process has ended but not been reaped |
## Search and Filter
@@ -45,14 +45,14 @@ Right-click on a process to:
## Common Processes
| Process | Description |
|---------|-------------|
| nginx | Nginx web server |
| php-fpm | PHP FastCGI process manager |
| mysqld | MySQL database service |
| Process | Description |
|----------|-----------------------------|
| nginx | Nginx web server |
| php-fpm | PHP FastCGI process manager |
| mysqld | MySQL database service |
| postgres | PostgreSQL database service |
| dockerd | Docker daemon |
| ace | AcePanel panel process |
| dockerd | Docker daemon |
| ace | AcePanel panel process |
## Notes

1
en/advanced/toolbox/ssh.md
View File

@@ -41,6 +41,7 @@ It is recommended to enable key login and disable password login to effectively
Modify the port that the SSH service listens on, default is `22`.
After modifying the port:
1. Click the **Save** button
2. Ensure the firewall has allowed the new port
3. Test connection using the new port

17
en/advanced/toolbox/system.md
View File

@@ -15,13 +15,13 @@ Configure the system's DNS servers.
### Common DNS Servers
| Provider | DNS1 | DNS2 |
|----------|------|------|
| Alibaba Cloud | 223.5.5.5 | 223.6.6.6 |
| Tencent Cloud | 119.29.29.29 | 119.28.28.28 |
| 114 DNS | 114.114.114.114 | 114.114.115.115 |
| Google | 8.8.8.8 | 8.8.4.4 |
| Cloudflare | 1.1.1.1 | 1.0.0.1 |
| Provider | DNS1 | DNS2 |
|---------------|-----------------|-----------------|
| Alibaba Cloud | 223.5.5.5 | 223.6.6.6 |
| Tencent Cloud | 119.29.29.29 | 119.28.28.28 |
| 114 DNS | 114.114.114.114 | 114.114.115.115 |
| Google | 8.8.8.8 | 8.8.4.4 |
| Cloudflare | 1.1.1.1 | 1.0.0.1 |
## SWAP
@@ -30,6 +30,7 @@ Manage the system's SWAP space.
![SWAP Settings](/images/toolbox/toolbox-system-swap.png)
The page displays current SWAP usage:
- System total
- Used
- Available
@@ -60,6 +61,7 @@ Modify the server's hostname, such as `myserver`, `web-01`, etc.
Edit the system's `/etc/hosts` file for configuring local domain name resolution.
Common uses:
- Block specific domains
- Configure local development domains
- Speed up resolution of specific domains
@@ -87,6 +89,7 @@ After manually changing the time, automatic system time synchronization may stil
Configure the NTP time synchronization server. Leave empty to use the system default server.
Common NTP servers:
- `ntp.aliyun.com` - Alibaba Cloud
- `ntp.tencent.com` - Tencent Cloud
- `cn.pool.ntp.org` - China NTP Pool

18
en/advanced/toolbox/webhook.md
View File

@@ -62,15 +62,15 @@ curl -X POST https://panel.example.com/api/webhook/your-key
## List Description
| Field | Description |
|-------|-------------|
| Name | Webhook name |
| Key | Unique identifier, used to build the call URL |
| Run User | System user that executes the script |
| Raw Output | Whether to return raw text output |
| Enabled | Whether the webhook is enabled |
| Call Count | Cumulative number of calls |
| Last Call | Last call time |
| Field | Description |
|------------|-----------------------------------------------|
| Name | Webhook name |
| Key | Unique identifier, used to build the call URL |
| Run User | System user that executes the script |
| Raw Output | Whether to return raw text output |
| Enabled | Whether the webhook is enabled |
| Call Count | Cumulative number of calls |
| Last Call | Last call time |
## Notes

8
en/advanced/website.md
View File

@@ -11,11 +11,11 @@ Before using the website feature, you need to install a Web server first:
## Website Types
| Type | Description | Use Cases |
|------|-------------|-----------|
| Type | Description | Use Cases |
|----------------------------------|--------------------------------------|--------------------------------|
| [Reverse Proxy](./website/proxy) | Forward requests to backend services | Node.js, Go, Java applications |
| [PHP](./website/php) | Run PHP programs | WordPress, Laravel, etc. |
| [Static](./website/static) | Host static files | HTML, Vue/React build outputs |
| [PHP](./website/php) | Run PHP programs | WordPress, Laravel, etc. |
| [Static](./website/static) | Host static files | HTML, Vue/React build outputs |
## Website List

10
en/faq/container.md
View File

@@ -10,7 +10,9 @@ Servers in China cannot connect to Docker Hub and need to configure mirror accel
```json
{
"registry-mirrors": ["https://docker.1ms.run"]
"registry-mirrors": [
"https://docker.1ms.run"
]
}
```
@@ -31,9 +33,9 @@ For mirror acceleration addresses, you can use [1ms Mirror](https://1ms.run/) or
1. Click **Logs** to view error messages
2. Common causes:
- Port occupied: Modify the mapped port
- Image pull failed: Configure mirror acceleration
- Configuration error: Check docker-compose.yml syntax
- Port occupied: Modify the mapped port
- Image pull failed: Configure mirror acceleration
- Configuration error: Check docker-compose.yml syntax
## Container Inaccessible

3
en/faq/database.md
View File

@@ -68,5 +68,6 @@ pg_dump -U username database_name > backup.sql
To modify character set for existing databases:
```sql
ALTER DATABASE database_name CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
ALTER
DATABASE database_name CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
```

2
en/faq/project.md
View File

@@ -19,6 +19,7 @@ If deployed under `/root`, you need to run as root user (not recommended).
Such as `node: No such file or directory`, indicates environment variables are not configured.
Solutions:
1. Associate runtime environment in **Edit** -> **Dependencies**
2. Or add PATH in **Runtime Settings** -> **Environment Variables**
@@ -35,6 +36,7 @@ lsof -i:3000 # View process occupying the port
**Edit** -> **Runtime Settings** -> **Environment Variables**, click **Add**.
Common configurations:
- `NODE_ENV=production`
- `PORT=3000`

10
en/faq/website.md
View File

@@ -57,11 +57,11 @@ Add listening addresses in **Domains and Listening**: `[::]:80` and `[::]:443`.
## CDN Origin and HTTPS
| CDN Origin Protocol | Website HTTPS Configuration |
|---------------------|----------------------------|
| HTTP | Not required |
| HTTPS | Must be enabled |
| Follow Protocol | Must be enabled, and HTTP redirect must not be enabled |
| CDN Origin Protocol | Website HTTPS Configuration |
|---------------------|--------------------------------------------------------|
| HTTP | Not required |
| HTTPS | Must be enabled |
| Follow Protocol | Must be enabled, and HTTP redirect must not be enabled |
## Upload File Size Limit

10
en/quickstart/first-project.md
View File

@@ -10,12 +10,12 @@ First, prepare a simple Node.js application. Create `app.js` in the project dire
const http = require('http');
const server = http.createServer((req, res) => {
res.writeHead(200, { 'Content-Type': 'text/plain' });
res.end('Hello from AcePanel!\n');
res.writeHead(200, {'Content-Type': 'text/plain'});
res.end('Hello from AcePanel!\n');
});
server.listen(3000, () => {
console.log('Server running at http://localhost:3000/');
console.log('Server running at http://localhost:3000/');
});
```
@@ -46,6 +46,7 @@ Click "Edit" in the project list to adjust more settings:
![Project Edit](/images/quickstart/project-edit-run.png)
**Run Settings**:
- **Pre-start Command**: Execute before starting, e.g., `npm install`
- **Restart Policy**: How to handle abnormal process exits
- **Environment Variables**: Set `NODE_ENV=production`, etc.
@@ -68,7 +69,8 @@ If not, you can access directly via `http://ServerIP:3000` (need to allow port 3
::: tip Production Environment
Production environment recommendations:
- Enable "Auto Start" to automatically recover after server restart
- Configure reverse proxy to forward requests through Nginx
- Set memory limits in "Resource Limits" to prevent memory leaks
:::
:::

28
en/quickstart/install.md
View File

@@ -8,20 +8,20 @@
## Supported Operating Systems
| System | Version | Status |
|--------------------|---------|-----------------|
| AlmaLinux | 10 | Recommended |
| AlmaLinux | 9 | Supported |
| RockyLinux | 10 | Recommended |
| RockyLinux | 9 | Supported |
| Debian | 13 | Recommended |
| Debian | 12 | Supported |
| Ubuntu | 24 | Recommended |
| Ubuntu | 22 | Supported |
| OpenCloudOS | 9 | Supported |
| TencentOS Server | 4 | Supported |
| CentOS Stream | 10 | Not Recommended |
| CentOS Stream | 9 | Not Recommended |
| System | Version | Status |
|------------------|---------|-----------------|
| AlmaLinux | 10 | Recommended |
| AlmaLinux | 9 | Supported |
| RockyLinux | 10 | Recommended |
| RockyLinux | 9 | Supported |
| Debian | 13 | Recommended |
| Debian | 12 | Supported |
| Ubuntu | 24 | Recommended |
| Ubuntu | 22 | Supported |
| OpenCloudOS | 9 | Supported |
| TencentOS Server | 4 | Supported |
| CentOS Stream | 10 | Not Recommended |
| CentOS Stream | 9 | Not Recommended |
Systems not listed can be tried at your own risk, but technical support is not provided.

14
en/quickstart/introduction.md
View File

@@ -29,10 +29,10 @@ One-click backup and recovery for websites and databases, supports scheduled bac
## Comparison
| Feature | AcePanel | Similar Product 1 | Similar Product B |
|----------------|-----------------|--------------------------|---------------------------------------|
| User Interface | Clean and modern | Modern design | Complex features, more advertisements |
| Open Source | Fully open source | Only non-pro version | Partially open source, incomplete commit history |
| Resource Usage | Extremely low, single file | core + agent dual process | Higher |
| App Center | Native apps + container orchestration | Container orchestration only | Outdated apps, slow updates |
| Tech Stack | Go 1.25 + Vue 3 | Go 1.24 + Vue 3 | Python 3.7 + Vue 3 + jQuery |
| Feature | AcePanel | Similar Product 1 | Similar Product B |
|----------------|---------------------------------------|------------------------------|--------------------------------------------------|
| User Interface | Clean and modern | Modern design | Complex features, more advertisements |
| Open Source | Fully open source | Only non-pro version | Partially open source, incomplete commit history |
| Resource Usage | Extremely low, single file | core + agent dual process | Higher |
| App Center | Native apps + container orchestration | Container orchestration only | Outdated apps, slow updates |
| Tech Stack | Go 1.25 + Vue 3 | Go 1.24 + Vue 3 | Python 3.7 + Vue 3 + jQuery |

9
en/quickstart/news/acepanel-3-release.md
View File

@@ -4,9 +4,9 @@ Long time no see. After several delays, AcePanel 3.0 was finally completed in ea
## Upgraded to New Brand Name AcePanel
AcePanel was originally named Haozi Panel, a server operation and maintenance management panel I developed at the end of 2022.
AcePanel was originally named Rat Panel, a server operation and maintenance management panel I developed at the end of 2022.
The most common feedback I received was that the name Haozi Panel didn't sound good, so we've now changed to a more sophisticated name - AcePanel.
The most common feedback I received was that the name Rat Panel didn't sound good, so we've now changed to a more sophisticated name - AcePanel.
![AcePanel Logo](https://wmimg.com/i/1424/2026/01/6975d8a45a01d.png)
@@ -130,12 +130,11 @@ Also starting from AcePanel 3.0, RHEL 8-based systems (AlmaLinux 8/Rocky Linux 8
Additionally, to support pre-built installation packages to solve the much-criticized slow MySQL compilation issue, AcePanel has changed the default installation directory to `/opt/ace` and no longer allows customization (expected to have minimal impact, you can still mount data disks before installation).
## About Old Version Upgrade and Maintenance
We plan to release a script to upgrade from the old Haozi Panel 2.x to AcePanel 3.0 after AcePanel 3.0 has been stable for a while. Given the significant changes, a perfect upgrade is not expected to be achievable, please be aware.
We plan to release a script to upgrade from the old Rat Panel 2.x to AcePanel 3.0 after AcePanel 3.0 has been stable for a while. Given the significant changes, a perfect upgrade is not expected to be achievable, please be aware.
The old Haozi Panel 2.x will continue to receive security updates for a period of time (expected until the end of 2026). You can arrange your upgrade during this period.
The old Rat Panel 2.x will continue to receive security updates for a period of time (expected until the end of 2026). You can arrange your upgrade during this period.
## Open Source License Change