mirror of
https://github.com/0xJacky/nginx-ui.git
synced 2026-05-06 22:12:23 +08:00
docs: add nginx_config_enable tool documentation
This commit is contained in:
@@ -46,6 +46,12 @@ The MCP Configuration File Management module provides a set of tools and resourc
|
||||
- Type: `tool`
|
||||
- Name: `nginx_config_history`
|
||||
|
||||
### Enable Configuration File
|
||||
|
||||
- Type: `tool`
|
||||
- Name: `nginx_config_enable`
|
||||
- Description: Enable a previously created Nginx configuration (creates symlink in sites-enabled)
|
||||
|
||||
## Usage Examples
|
||||
|
||||
Here are some examples of using MCP Configuration File Management features:
|
||||
@@ -120,6 +126,30 @@ Example response:
|
||||
}
|
||||
```
|
||||
|
||||
### Enable Configuration File
|
||||
|
||||
```json
|
||||
{
|
||||
"tool": "nginx_config_enable",
|
||||
"parameters": {
|
||||
"name": "my-site.conf",
|
||||
"base_dir": "sites-available",
|
||||
"overwrite": false
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Example response:
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "success",
|
||||
"message": "Site enabled and Nginx reloaded successfully",
|
||||
"source": "/etc/nginx/sites-available/my-site.conf",
|
||||
"destination": "/etc/nginx/sites-enabled/my-site.conf"
|
||||
}
|
||||
```
|
||||
|
||||
## Important Notes
|
||||
|
||||
- All path operations are relative to the Nginx configuration base path
|
||||
|
||||
@@ -53,3 +53,9 @@ MCP 配置文件管理模块提供了一系列工具和资源,用于管理 Ngi
|
||||
- 类型:`tool`
|
||||
- 名称:`nginx_config_history`
|
||||
- 描述:获取配置文件的修改历史记录
|
||||
|
||||
### 启用配置文件
|
||||
|
||||
- 类型:`tool`
|
||||
- 名称:`nginx_config_enable`
|
||||
- 描述:启用之前创建的 Nginx 配置文件(在 sites-enabled 中创建符号链接)
|
||||
|
||||
@@ -46,6 +46,12 @@ MCP 配置文件管理模組提供了一系列工具和資源,用於管理 Ngi
|
||||
- 類型:`tool`
|
||||
- 名稱:`nginx_config_history`
|
||||
|
||||
### 啟用配置文件
|
||||
|
||||
- 類型:`tool`
|
||||
- 名稱:`nginx_config_enable`
|
||||
- 描述:啟用之前創建的 Nginx 配置文件(在 sites-enabled 中創建符號連結)
|
||||
|
||||
## 使用示例
|
||||
|
||||
以下是一些使用 MCP 配置文件管理功能的示例:
|
||||
@@ -120,6 +126,30 @@ MCP 配置文件管理模組提供了一系列工具和資源,用於管理 Ngi
|
||||
}
|
||||
```
|
||||
|
||||
### 啟用配置文件
|
||||
|
||||
```json
|
||||
{
|
||||
"tool": "nginx_config_enable",
|
||||
"parameters": {
|
||||
"name": "my-site.conf",
|
||||
"base_dir": "sites-available",
|
||||
"overwrite": false
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
返回結果示例:
|
||||
|
||||
```json
|
||||
{
|
||||
"status": "success",
|
||||
"message": "Site enabled and Nginx reloaded successfully",
|
||||
"source": "/etc/nginx/sites-available/my-site.conf",
|
||||
"destination": "/etc/nginx/sites-enabled/my-site.conf"
|
||||
}
|
||||
```
|
||||
|
||||
## 注意事項
|
||||
|
||||
- 所有路徑操作都是相對於 Nginx 配置基礎路徑的
|
||||
|
||||
Reference in New Issue
Block a user