diff --git a/docs/css/extra.css b/docs/css/extra.css index 97dce099e..67bee4d93 100644 --- a/docs/css/extra.css +++ b/docs/css/extra.css @@ -2,6 +2,12 @@ --md-primary-fg-color: #005EEB; } +/*.md-content img {*/ +/* border-radius: 0 0 10px 10px;*/ +/* box-shadow: 0 2px 8px rgba(0,0,0,0.1);*/ +/*}*/ + + .progress-label { position: absolute; text-align: center; @@ -150,9 +156,10 @@ /* 不添加浏览器导航栏的图片样式 */ .md-content img:not(.browser-mockup img) { display: block; - box-shadow: 0 0.1em .5em 0 rgba(0, 0, 0, 0.4); + box-shadow: 0 6px 16px -2px rgba(0, 0, 0, 0.15); border: none; - border-radius: 4px; + border-radius: 10px; + margin: 0 0 1em 0; } .browser-mockup.none { @@ -173,7 +180,7 @@ border-top: 2em solid rgba(230, 230, 230, 0.8); box-shadow: 0 0.1em .5em 0 rgba(0, 0, 0, 0.4); position: relative; - border-radius: 4px 4px 4px 4px; + border-radius: 10px; max-width: 1200px; margin: 0 auto; } diff --git a/docs/dev_manual/api_manual.md b/docs/dev_manual/api_manual.md index a1e28f7f7..d65dd0039 100644 --- a/docs/dev_manual/api_manual.md +++ b/docs/dev_manual/api_manual.md @@ -62,7 +62,7 @@ - `API-Key`:面板 API 接口密钥。 - `UnixTimestamp`:当前时间戳,秒级。 - - `1panel` / `1panel:`:固定签名内容前缀。 + - `1panel` / `1panel`:固定签名内容前缀。 ### 2.3 Go 示例 diff --git a/docs/faq/faq.md b/docs/faq/faq.md index 815c5b8b1..1b030419f 100644 --- a/docs/faq/faq.md +++ b/docs/faq/faq.md @@ -12,5 +12,5 @@ !!! note "" - - 1Panel 基于 Golang 语言编写,可执行文件大小约 40MB、运行时占用系系统内存约 150MB + - 1Panel 基于 Golang 语言编写,可执行文件大小约 40MB、运行时占用系统内存约 150MB - 1Panel 基于 Docker 来部署管理其他应用,对系统的侵入影响非常小 diff --git a/docs/faq/openclaw.md b/docs/faq/openclaw.md index 3d99b0b25..27e6cbc3d 100644 --- a/docs/faq/openclaw.md +++ b/docs/faq/openclaw.md @@ -10,7 +10,7 @@ !!! note "" OpenClaw 支持通过 1Panel 的智能体功能快速部署,具体可参考 [安装部署文档](../user_manual/appstore/openclaw.md)。 -## 如何通过 Ollama 运行本地模型? +## 3 如何通过 Ollama 运行本地模型? !!! note "" diff --git a/docs/faq/operating_system.md b/docs/faq/operating_system.md index 25a27fc7c..8deafab3a 100644 --- a/docs/faq/operating_system.md +++ b/docs/faq/operating_system.md @@ -24,7 +24,7 @@ - 更新 systemd 管理,支持 systemd 后问题即可解决 - 参考文档:[Systemd support is now available in WSL!](https://devblogs.microsoft.com/commandline/systemd-support-is-now-available-in-wsl/) -## 3 使用 Fedora 37 安装面板后打开防火墙发现面板创建的端口规则未效果 +## 3 使用 Fedora 37 安装面板后打开防火墙发现面板创建的端口规则未生效 !!! note "" **Fedora 37 默认区域不是 public 导致的,可以通过以下命令手动将默认区域设置为 public** diff --git a/docs/img/ai/agent_channel_qq.png b/docs/img/ai/agent_channel_qq.png new file mode 100644 index 000000000..8fbb3262b Binary files /dev/null and b/docs/img/ai/agent_channel_qq.png differ diff --git a/docs/img/ai/agent_config_model.png b/docs/img/ai/agent_config_model.png new file mode 100644 index 000000000..c29db65ad Binary files /dev/null and b/docs/img/ai/agent_config_model.png differ diff --git a/docs/img/ai/agent_create.png b/docs/img/ai/agent_create.png new file mode 100644 index 000000000..2ced64fc4 Binary files /dev/null and b/docs/img/ai/agent_create.png differ diff --git a/docs/img/ai/agent_list.png b/docs/img/ai/agent_list.png new file mode 100644 index 000000000..327690437 Binary files /dev/null and b/docs/img/ai/agent_list.png differ diff --git a/docs/img/ai/agent_overview.png b/docs/img/ai/agent_overview.png new file mode 100644 index 000000000..8fd9221cd Binary files /dev/null and b/docs/img/ai/agent_overview.png differ diff --git a/docs/img/ai/agent_settings_other.png b/docs/img/ai/agent_settings_other.png new file mode 100644 index 000000000..13d0d1407 Binary files /dev/null and b/docs/img/ai/agent_settings_other.png differ diff --git a/docs/img/ai/agent_skills_market.png b/docs/img/ai/agent_skills_market.png new file mode 100644 index 000000000..4e6a291a1 Binary files /dev/null and b/docs/img/ai/agent_skills_market.png differ diff --git a/docs/img/ai/ai_agent_normal.png b/docs/img/ai/ai_agent_normal.png new file mode 100644 index 000000000..4cc3c8251 Binary files /dev/null and b/docs/img/ai/ai_agent_normal.png differ diff --git a/docs/img/ai/ai_gateway_api_key_create.png b/docs/img/ai/ai_gateway_api_key_create.png new file mode 100644 index 000000000..330c354e2 Binary files /dev/null and b/docs/img/ai/ai_gateway_api_key_create.png differ diff --git a/docs/img/ai/ai_gateway_compliance_fenzu.png b/docs/img/ai/ai_gateway_compliance_fenzu.png new file mode 100644 index 000000000..53e58ffde Binary files /dev/null and b/docs/img/ai/ai_gateway_compliance_fenzu.png differ diff --git a/docs/img/ai/ai_gateway_compliance_shenheyangben.png b/docs/img/ai/ai_gateway_compliance_shenheyangben.png new file mode 100644 index 000000000..72c76cfa4 Binary files /dev/null and b/docs/img/ai/ai_gateway_compliance_shenheyangben.png differ diff --git a/docs/img/ai/ai_gateway_import_account.png b/docs/img/ai/ai_gateway_import_account.png new file mode 100644 index 000000000..9edf95461 Binary files /dev/null and b/docs/img/ai/ai_gateway_import_account.png differ diff --git a/docs/img/ai/ai_gateway_smart_routing_sample.png b/docs/img/ai/ai_gateway_smart_routing_sample.png new file mode 100644 index 000000000..45f71c81c Binary files /dev/null and b/docs/img/ai/ai_gateway_smart_routing_sample.png differ diff --git a/docs/img/ai/ai_gateway_smart_routing_sample_juece.png b/docs/img/ai/ai_gateway_smart_routing_sample_juece.png new file mode 100644 index 000000000..9bccdaeda Binary files /dev/null and b/docs/img/ai/ai_gateway_smart_routing_sample_juece.png differ diff --git a/docs/img/ai/ai_gateway_smart_routing_sample_tongji.png b/docs/img/ai/ai_gateway_smart_routing_sample_tongji.png new file mode 100644 index 000000000..6306f7706 Binary files /dev/null and b/docs/img/ai/ai_gateway_smart_routing_sample_tongji.png differ diff --git a/docs/img/ai/ai_gateway_smart_routing_sample_yulan.png b/docs/img/ai/ai_gateway_smart_routing_sample_yulan.png new file mode 100644 index 000000000..8381b76aa Binary files /dev/null and b/docs/img/ai/ai_gateway_smart_routing_sample_yulan.png differ diff --git a/docs/img/ai/ai_gateway_usage_new_diaoyongrizhi.png b/docs/img/ai/ai_gateway_usage_new_diaoyongrizhi.png new file mode 100644 index 000000000..ae3e05b9f Binary files /dev/null and b/docs/img/ai/ai_gateway_usage_new_diaoyongrizhi.png differ diff --git a/docs/img/ai/ai_gateway_usage_new_fenbu.png b/docs/img/ai/ai_gateway_usage_new_fenbu.png new file mode 100644 index 000000000..dad60f040 Binary files /dev/null and b/docs/img/ai/ai_gateway_usage_new_fenbu.png differ diff --git a/docs/img/ai/ai_gateway_usage_new_paihangbang.png b/docs/img/ai/ai_gateway_usage_new_paihangbang.png new file mode 100644 index 000000000..9f7bfba4d Binary files /dev/null and b/docs/img/ai/ai_gateway_usage_new_paihangbang.png differ diff --git a/docs/img/ai/create_mcp_server.png b/docs/img/ai/create_mcp_server.png index bafd2dbc3..bc1df4427 100644 Binary files a/docs/img/ai/create_mcp_server.png and b/docs/img/ai/create_mcp_server.png differ diff --git a/docs/img/ai/gpu_acceleration.png b/docs/img/ai/gpu_acceleration.png index fdff40b1a..ae6819dca 100644 Binary files a/docs/img/ai/gpu_acceleration.png and b/docs/img/ai/gpu_acceleration.png differ diff --git a/docs/img/ai/gpu_monitor.png b/docs/img/ai/gpu_monitor.png index 9534d2969..37b3e9770 100644 Binary files a/docs/img/ai/gpu_monitor.png and b/docs/img/ai/gpu_monitor.png differ diff --git a/docs/img/ai/mcp_server_config.png b/docs/img/ai/mcp_server_config.png index b412260ef..572d1d729 100644 Binary files a/docs/img/ai/mcp_server_config.png and b/docs/img/ai/mcp_server_config.png differ diff --git a/docs/img/ai/mcp_website.png b/docs/img/ai/mcp_website.png index 25f7aa478..5fd02b20e 100644 Binary files a/docs/img/ai/mcp_website.png and b/docs/img/ai/mcp_website.png differ diff --git a/docs/img/ai/model_pull.png b/docs/img/ai/model_pull.png index aa908e1a4..67e23486d 100644 Binary files a/docs/img/ai/model_pull.png and b/docs/img/ai/model_pull.png differ diff --git a/docs/img/ai/model_run.png b/docs/img/ai/model_run.png index abce55549..92a508169 100644 Binary files a/docs/img/ai/model_run.png and b/docs/img/ai/model_run.png differ diff --git a/docs/img/ai/overview.png b/docs/img/ai/overview.png index 5078447bd..dafc7ed38 100644 Binary files a/docs/img/ai/overview.png and b/docs/img/ai/overview.png differ diff --git a/docs/img/ai/skills_hub_import_github.png b/docs/img/ai/skills_hub_import_github.png new file mode 100644 index 000000000..e03f2c388 Binary files /dev/null and b/docs/img/ai/skills_hub_import_github.png differ diff --git a/docs/img/ai/skills_hub_import_url.png b/docs/img/ai/skills_hub_import_url.png new file mode 100644 index 000000000..7d602dfc1 Binary files /dev/null and b/docs/img/ai/skills_hub_import_url.png differ diff --git a/docs/img/ai/skills_hub_list_pending.png b/docs/img/ai/skills_hub_list_pending.png new file mode 100644 index 000000000..4c1f92f6f Binary files /dev/null and b/docs/img/ai/skills_hub_list_pending.png differ diff --git a/docs/img/ai/skills_hub_risk.png b/docs/img/ai/skills_hub_risk.png new file mode 100644 index 000000000..ba74c0e5f Binary files /dev/null and b/docs/img/ai/skills_hub_risk.png differ diff --git a/docs/img/ai/skills_hub_targets.png b/docs/img/ai/skills_hub_targets.png new file mode 100644 index 000000000..26f21cbe1 Binary files /dev/null and b/docs/img/ai/skills_hub_targets.png differ diff --git a/docs/img/ai/skills_hub_upload.png b/docs/img/ai/skills_hub_upload.png new file mode 100644 index 000000000..4ac53bd63 Binary files /dev/null and b/docs/img/ai/skills_hub_upload.png differ diff --git a/docs/img/ai/vllm_create.png b/docs/img/ai/vllm_create.png index 0b02aaa28..1badf5bd0 100644 Binary files a/docs/img/ai/vllm_create.png and b/docs/img/ai/vllm_create.png differ diff --git a/docs/installation/online_installation.md b/docs/installation/online_installation.md index 8ec8d0faa..a58d11bb4 100644 --- a/docs/installation/online_installation.md +++ b/docs/installation/online_installation.md @@ -125,4 +125,3 @@ 登录 1Panel Web 控制台,在页面右下角点击 **【检查更新】** 进行在线升级。 ![在线升级检查更新](../img/installation/检查更新.png) -{: .browser-mockup} diff --git a/docs/installation/online_upgrade.md b/docs/installation/online_upgrade.md index 2de371fea..a24bfe26d 100644 --- a/docs/installation/online_upgrade.md +++ b/docs/installation/online_upgrade.md @@ -2,4 +2,3 @@ 登录 1Panel Web 控制台,在页面右下角点击 **【检查更新】** 进行在线升级。 ![img.png](../img/installation/检查更新.png) -{: .browser-mockup} diff --git a/docs/user_manual/ai/agent.md b/docs/user_manual/ai/agent.md index 68bececea..c33dcd3a9 100644 --- a/docs/user_manual/ai/agent.md +++ b/docs/user_manual/ai/agent.md @@ -13,20 +13,26 @@ schema_type: TechArticle !!! note "" 1Panel 在 **AI -> 智能体** 中集中安装和管理受支持的智能体应用。当前页面包含智能体列表、模型账号,以及按智能体类型和版本动态显示的配置能力。 +![智能体列表](../../img/ai/agent_list.png) + ## 1 使用前提 -- Docker 服务和应用商店状态正常。 -- 已准备要使用的模型服务及 API Key;也可以先在 **AI -> 模型管理 -> 模型账号** 中创建账号。 -- 服务器可以访问智能体应用镜像和所需的软件源。 -- 对外开放 WebUI 或频道前,已完成防火墙、域名、HTTPS 和访问控制配置。 +!!! note "" + - Docker 服务和应用商店状态正常。 + - 已准备要使用的模型服务及 API Key;也可以先在 **AI -> 模型管理 -> 模型账号** 中创建账号。 + - 服务器可以访问智能体应用镜像和所需的软件源。 + - 对外开放 WebUI 或频道前,已完成防火墙、域名、HTTPS 和访问控制配置。 ## 2 安装智能体 -1. 进入 **AI -> 智能体**。 -2. 点击 **安装**,选择页面当前支持的智能体类型。 -3. 填写名称、应用版本、WebUI 端口、认证信息和允许访问地址。 -4. 选择或新建模型账号,并根据需要配置模型池和备用模型。 -5. 确认参数后提交任务,在任务日志中查看安装结果。 +![创建智能体](../../img/ai/agent_create.png) + +!!! note "" + 1. 进入 **AI -> 智能体**。 + 2. 点击 **创建**,选择页面当前支持的智能体类型。 + 3. 填写名称、应用版本、WebUI 端口、认证信息和允许访问地址。 + 4. 选择或新建模型账号,并根据需要配置模型池和备用模型。 + 5. 确认参数后提交任务,在任务日志中查看安装结果。 !!! warning "访问地址" 允许访问地址需要使用 `http://` 或 `https://` 开头的域名或 IP;只填写可信来源,避免把智能体管理界面直接暴露到公网。 @@ -36,31 +42,45 @@ schema_type: TechArticle !!! note "" 智能体列表支持查看状态和版本,并根据当前状态执行概览、配置、终端、对话、启动、停止、重启、升级和删除等操作。不同智能体类型支持的按钮可能不同。 +![AI Agent日常管理](../../img/ai/ai_agent_normal.png) + ### 3.1 概览 !!! note "" 概览展示运行状态、主模型、频道数量、技能数量、定时任务数量和会话数量等摘要。页面数据取决于智能体类型及其版本是否支持对应接口。 +![概览](../../img/ai/agent_overview.png) + ### 3.2 模型 !!! note "" 模型页用于选择主模型、维护可用模型和备用模型。修改模型账号时,可以选择是否同步更新关联智能体的配置文件。 +![模型配置](../../img/ai/agent_config_model.png) + ### 3.3 频道 !!! note "" 频道配置按智能体类型提供微信、企业微信、钉钉、飞书、QQ、Telegram、Discord 等接入项。实际可用频道、插件要求和字段由当前智能体版本决定;保存频道配置后,系统可能自动重启容器使配置生效。 +![QQ 频道配置](../../img/ai/agent_channel_qq.png) + ### 3.4 技能与角色 +!!! note "" + - **技能**:查看内置、外部和工作区技能,并从页面支持的技能来源搜索和安装。 + - **角色**:维护智能体工作区中的角色 Markdown 文件。保存后按页面提示重启容器。 -- **技能**:查看内置、外部和工作区技能,并从页面支持的技能来源搜索和安装。 -- **角色**:维护智能体工作区中的角色 Markdown 文件。保存后按页面提示重启容器。 +![技能市场](../../img/ai/agent_skills_js.png) -### 3.5 设置 +![技能市场](../../img/ai/agent_skills_market.png) + +### 3.5 设置 !!! note "" 设置页包含安全、其他和配置文件等标签,可配置认证方式、时区、浏览器开关、NPM 源等。直接编辑配置文件前建议先备份;保存后需要重启的配置以页面提示为准。 +![设置-其他](../../img/ai/agent_settings_other.png) + ## 4 多节点与批量操作 !!! info "企业版能力" diff --git a/docs/user_manual/ai/benchmark.md b/docs/user_manual/ai/benchmark.md index 49e083be5..1424ca337 100644 --- a/docs/user_manual/ai/benchmark.md +++ b/docs/user_manual/ai/benchmark.md @@ -8,7 +8,6 @@ 该功能属于 [1Panel 企业版](https://1panel.cn/enterprise.html)。 ![基准测试](../../img/ai/ai_benchmark_list.jpg) -{: .original} ## 1 前置条件 @@ -31,7 +30,6 @@ 创建成功后,系统会启动后台任务执行基准测试,并可通过任务日志查看执行过程。 ![创建基准测试](../../img/ai/ai_benchmark_create.jpg) -{: .original} !!! info "基础参数" - **服务地址**:目标模型服务地址,例如 `http://127.0.0.1:4000` @@ -59,7 +57,6 @@ 点击任务名称可打开详情抽屉,查看基础信息、运行配置、结果指标、启动命令和原始结果。 ![基准测试详情](../../img/ai/ai_benchmark_detail.jpg) -{: .original} !!! info "核心指标" - **上下文长度**:输入 Token 与输出 Token 上限之和 diff --git a/docs/user_manual/ai/gateway.md b/docs/user_manual/ai/gateway.md index 883930e44..9dabab01f 100644 --- a/docs/user_manual/ai/gateway.md +++ b/docs/user_manual/ai/gateway.md @@ -1,19 +1,17 @@ -## AI 网关 - !!! note "" AI 网关用于统一管理模型账号、调用凭证、访问配额和请求转发。客户端只需配置网关的外部连接地址和 API Key,即可通过统一入口调用不同供应商或本地部署的模型。 进入 1Panel 面板后,打开 **AI -> AI 网关** 页面即可进行管理。 该功能属于 [1Panel 企业版](https://1panel.cn/enterprise.html)。 +!!! note "" + 新版 AI 网关包含 **账号池、模型组、API Key、用户组、智能路由、内容合规、用量统计、设置** 8 个功能入口。建议按照以下顺序完成首次配置: -新版 AI 网关包含 **账号池、模型组、API Key、用户组、智能路由、内容合规、用量统计、设置** 8 个功能入口。建议按照以下顺序完成首次配置: - -1. 在 **账号池** 中导入模型账号并配置模型映射。 -2. 按需创建 **模型组**,用于限制用户组可用模型或配置智能路由。 -3. 创建 **用户组**,设置 QPS、Token 配额和模型范围。 -4. 创建 **API Key**,交付给客户端使用。 -5. 按需启用智能路由、内容合规、用量统计和 Elasticsearch。 + 1. 在 **账号池** 中导入模型账号并配置模型映射。 + 2. 按需创建 **模型组**,用于限制用户组可用模型或配置智能路由。 + 3. 创建 **用户组**,设置 QPS、Token 配额和模型范围。 + 4. 创建 **API Key**,交付给客户端使用。 + 5. 按需启用智能路由、内容合规、用量统计和 Elasticsearch。 ## 1 运行状态与基础操作 @@ -26,8 +24,8 @@ - **日志**:查看 AI 网关运行日志 - **外部连接地址**:客户端配置的 Base URL,可直接复制 -![AI 网关账号池](../../img/ai/ai_gateway_account_pool.jpg) -{: .original} +![AI 网关账号池](../../img/ai/ai_gateway_account_pool.png) + ## 2 账号池 @@ -44,6 +42,8 @@ - **验证账号可用性**:保存前发送最小请求检查接口是否可用 - **启用**:控制该账号是否参与网关转发 +![导入模型账号](../../img/ai/ai_gateway_import_account.png) + > 模型映射左侧填写客户端请求中的 `model`,右侧填写真实上游模型。客户端只需要感知映射后的请求模型名。 ## 3 模型组 @@ -53,16 +53,14 @@ `auto` 是客户端触发智能路由时使用的虚拟模型名,不需要添加到模型组中。 -![AI 网关模型组](../../img/ai/ai_gateway_model_groups.jpg) -{: .original} +![AI 网关模型组](../../img/ai/ai_gateway_model_groups.png) ## 4 用户组 !!! note "" **用户组** 用于统一管理一组 API Key 的调用配额和模型范围。创建用户组后,再将 API Key 绑定到该用户组。 -![AI 网关用户组](../../img/ai/ai_gateway_user_groups.jpg) -{: .original} +![AI 网关用户组](../../img/ai/ai_gateway_user_groups.png) !!! info "用户组参数" - **用户组**:用户组名称 @@ -72,7 +70,7 @@ - **状态**:禁用后,该组下的 API Key 无法继续调用 - **备注**:记录部门、项目或使用场景 -默认用户组不可删除。API Key 绑定用户组后,会继承用户组的 QPS、Token 配额和模型范围。 +>默认用户组不可删除。API Key 绑定用户组后,会继承用户组的 QPS、Token 配额和模型范围。 ## 5 API Key @@ -81,6 +79,7 @@ API Key 只会在创建时完整展示,请妥善保存。重置 Token 后,原 Token 将无法继续使用,需要同步更新客户端配置。 +![创建 API Key](../../img/ai/ai_gateway_api_key_create.png) !!! info "客户端调用示例" ```bash curl http://<服务器 IP>:4000/v1/chat/completions \ @@ -98,78 +97,73 @@ }' ``` -客户端应将页面顶部的 **外部连接地址** 作为 Base URL。`model` 可以填写账号池中的请求模型名;启用智能路由后,也可以填写 `auto`。 +>客户端应将页面顶部的 **外部连接地址** 作为 Base URL。`model` 可以填写账号池中的请求模型名;启用智能路由后,也可以填写 `auto`。 ## 6 智能路由 !!! note "" 智能路由根据请求复杂度,在简单模型组和复杂模型组之间选择模型。只有客户端请求使用 `model=auto` 时才会触发智能路由;请求其他模型名时,仍按普通 AI 网关流程转发。 - -![AI 网关智能路由](../../img/ai/ai_gateway_smart_routing.jpg) -{: .original} - ### 6.1 配置流程 - -1. 在 **模型组** 中分别创建简单模型组和复杂模型组,并配置真实上游模型。 -2. 在 **设置 -> Embedding** 中配置 Embedding 服务、路由阈值和 TopK。 -3. 在 **设置 -> 智能路由** 中启用功能,并选择简单模型组和复杂模型组。 -4. 在 **智能路由 -> 样本** 中维护简单、复杂请求样本,并生成或重建向量。 -5. 客户端使用 `model=auto` 发起请求。 +!!! note "" + 1. 在 **模型组** 中分别创建简单模型组和复杂模型组,并配置真实上游模型。 + 2. 在 **设置 -> Embedding** 中配置 Embedding 服务、路由阈值和 TopK。 + 3. 在 **设置 -> 智能路由** 中启用功能,并选择简单模型组和复杂模型组。 + 4. 在 **智能路由 -> 样本** 中维护简单、复杂请求样本,并生成或重建向量。 + 5. 客户端使用 `model=auto` 发起请求。 ### 6.2 功能说明 !!! info "样本" 样本用于描述简单或复杂问题。列表展示标签、样本文本、向量模型和向量维度,新增或调整 Embedding 配置后可以点击 **重建向量**。 - +![智能路由样本](../../img/ai/ai_gateway_smart_routing_sample.png) !!! info "预览" 输入一段请求文本,查看它会被判定为简单还是复杂,并显示判定来源。预览只执行路由判断,不会真实调用上游模型。 - +![智能路由预览](../../img/ai/ai_gateway_smart_routing_sample_yulan.png) !!! info "决策日志" 记录请求 ID、判定标签、最终模型、判定来源、置信度、耗时和创建时间。判定来源包括样本匹配和规则判断,并可跳转到对应调用日志。 - +![智能路由决策](../../img/ai/ai_gateway_smart_routing_sample_juece.png) !!! info "统计信息" 展示简单/复杂请求占比、样本匹配占比、总 Token、平均 Token、失败请求,以及按标签、来源、模型和 Token 的分布。 - +![智能路由统计](../../img/ai/ai_gateway_smart_routing_sample_tongji.png) ## 7 内容合规 !!! note "" 内容合规支持敏感词匹配和基于 Embedding 的语义审核样本。启用前,需要先在 **设置 -> 内容合规** 中打开总开关;使用审核样本时,还需要完成 **设置 -> Embedding** 配置。 -![AI 网关内容合规](../../img/ai/ai_gateway_compliance.jpg) -{: .original} - !!! info "敏感词" 支持创建和批量导入敏感词,并设置敏感词分组、归一化词、状态和备注。归一化词用于将不同写法统一为同一个匹配词。 +![AI 网关内容合规](../../img/ai/ai_gateway_compliance.png) + !!! info "敏感词分组" 为一组敏感词设置处理动作、风险等级、状态和描述。处理动作包括 **阻断** 和 **仅记录**。 - +![AI 网关内容合规](../../img/ai/ai_gateway_compliance_fenzu.png) !!! info "审核样本" 维护用于语义匹配的审核文本,并设置标签。列表展示向量模型和维度,样本变更或 Embedding 配置调整后可以重建向量。 - +![AI 网关内容合规](../../img/ai/ai_gateway_compliance_shenheyangben.png) !!! info "审计日志" 记录 Request ID、请求模型、命中词、命中分组、处理动作、状态码和创建时间,用于追踪被记录或阻断的请求。 +![ai_gateway_compliance_log.png](../../img/ai/ai_gateway_compliance_log.png) + ## 8 用量统计 !!! note "" - **用量统计** 提供概览、分布、排行榜和调用日志 4 个视图,并支持按用户、模型供应商、模型和关键字筛选。 - -![AI 网关用量统计](../../img/ai/ai_gateway_usage_new.jpg) -{: .original} - -!!! info "概览" - 展示请求数、总 Token、输入 Token、输出 Token、缓存 Token、缓存命中率、活跃用户、活跃模型、失败请求、平均 Token/请求和使用趋势。 + **用量统计** 提供分布、排行榜和调用日志 3 个视图,并支持按用户、模型供应商、模型和关键字筛选。 !!! info "分布" 按模型供应商、模型、模型账号、用户组和用户统计请求数、Token 用量、缓存 Token 和占比。 +![AI 网关用量分布](../../img/ai/ai_gateway_usage_new_fenbu.png) + !!! info "排行榜" 按用户展示请求数、输入 Token、输出 Token、Token 总量和缓存 Token,并支持按指标排序。 +![AI 网关用量排行榜](../../img/ai/ai_gateway_usage_new_paihangbang.png) + !!! info "调用日志" 展示 Request ID、模型供应商、请求模型、上游模型、用户、用户组、输入/输出/总 Token、缓存 Token、状态码、响应时间和请求时间。点击 **详情** 可以查看单次调用信息。 - +![AI 网关用量调用日志](../../img/ai/ai_gateway_usage_new_diaoyongrizhi.png) ## 9 网关设置 ### 9.1 基础设置 @@ -177,8 +171,7 @@ !!! note "" **基础设置** 用于控制网关开关、监听端口、外部连接地址和负载策略。外部连接地址应填写客户端实际可访问的地址,并包含 `/v1` 路径。 -![AI 网关基础设置](../../img/ai/ai_gateway_settings_basic.jpg) -{: .original} +![AI 网关基础设置](../../img/ai/ai_gateway_settings_basic.png) ### 9.2 性能设置 @@ -191,8 +184,7 @@ - **最大请求体**:单次请求体大小限制 - **Runtime 刷新间隔**:运行时配置刷新间隔 -![AI 网关性能设置](../../img/ai/ai_gateway_settings_performance.jpg) -{: .original} +![AI 网关性能设置](../../img/ai/ai_gateway_settings_performance.png) ### 9.3 Embedding 设置 @@ -203,8 +195,7 @@ 1. 进入 **AI -> 模型 -> 下载器**,下载 `Qwen3-Embedding-0.6B-GGUF` 模型,并确认模型文件中包含 `qwen3-embedding-0.6b-q8_0.gguf`。 - ![下载 Qwen3 Embedding 模型](../../img/ai/ai_gateway_embedding_model_download.jpg) - {: .original} +![下载 Qwen3 Embedding 模型](../../img/ai/ai_gateway_embedding_model_download.jpg) 2. 进入 **应用商店**,搜索并安装 `llama.cpp`。 3. 在安装参数中,将 **模型目录** 设置为: @@ -219,8 +210,7 @@ -m /models/Qwen3-Embedding-0.6B-GGUF/qwen3-embedding-0.6b-q8_0.gguf --host 0.0.0.0 --port 8080 --embedding --pooling last -c 32768 ``` - ![llama.cpp Embedding 参数配置](../../img/ai/ai_gateway_embedding_llama_cpp.jpg) - {: .original} +![llama.cpp Embedding 参数配置](../../img/ai/ai_gateway_embedding_llama_cpp.jpg) 5. 完成安装,并确认 `llama.cpp` 应用处于运行状态。 @@ -236,9 +226,8 @@ - **API Key**:本地 `llama.cpp` 未配置认证时留空 ![AI 网关 Embedding 设置](../../img/ai/ai_gateway_embedding_settings.jpg) -{: .original} -点击 **连接测试**。测试成功后保存配置,再到智能路由样本或内容审核样本页面生成或重建向量。 +>点击 **连接测试**。测试成功后保存配置,再到智能路由样本或内容审核样本页面生成或重建向量。 !!! info "判定参数" - **路由阈值**:请求与智能路由样本的相似度达到该值后,才采用样本匹配结果 @@ -253,7 +242,6 @@ 在 **智能路由** 标签页中打开开关,并选择简单模型组和复杂模型组。简单模型组适合低成本任务,复杂模型组适合代码分析、架构设计和故障排查等任务。 ![AI 网关智能路由设置](../../img/ai/ai_gateway_settings_smart_routing.jpg) -{: .original} 在 **内容合规** 标签页中可以统一启用或停用内容合规检查。 @@ -270,7 +258,6 @@ Elasticsearch 用于保存 AI 网关请求和响应内容,便于检索、审计和问题排查。页面支持连接测试,确认连接可用后再保存配置。 ![AI 网关 Elasticsearch 设置](../../img/ai/ai_gateway_settings_elasticsearch.jpg) -{: .original} !!! info "参数说明" - **启用**:控制是否向 Elasticsearch 写入请求和响应内容 diff --git a/docs/user_manual/ai/gpu.md b/docs/user_manual/ai/gpu.md index 2d4190923..f9b2d9f62 100644 --- a/docs/user_manual/ai/gpu.md +++ b/docs/user_manual/ai/gpu.md @@ -13,10 +13,10 @@ schema_type: TechArticle 社区版、专业版和企业版均可使用。多节点环境中,页面展示的是当前所选节点的数据。 ## 1 使用前提 +!!! warning "注意" + 1Panel 通过主机上已安装的显卡管理工具读取数据。以 NVIDIA GPU 为例,需要先安装与显卡和操作系统匹配的驱动,并确保在服务器终端执行 `nvidia-smi` 能正常返回信息。 -1Panel 通过主机上已安装的显卡管理工具读取数据。以 NVIDIA GPU 为例,需要先安装与显卡和操作系统匹配的驱动,并确保在服务器终端执行 `nvidia-smi` 能正常返回信息。 - -需要在容器中使用 NVIDIA GPU 时,还应按照 [NVIDIA Container Toolkit 安装文档](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html)完成容器运行时配置。 + 需要在容器中使用 NVIDIA GPU 时,还应按照 [NVIDIA Container Toolkit 安装文档](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html)完成容器运行时配置。 !!! warning "驱动安装" 显卡驱动与内核、操作系统和硬件型号相关。升级内核或驱动可能影响现有 GPU 工作负载,生产环境应先确认兼容性并安排维护窗口。 @@ -27,18 +27,18 @@ schema_type: TechArticle 当前状态展示驱动版本、显卡型号、利用率、显存、温度、功耗等指标,并列出正在使用 GPU 的进程。实际可见字段取决于显卡类型、驱动和管理工具返回的数据。 ![GPU 当前状态](../../img/ai/gpu_monitor.png) -{: .original} -如果页面无数据,请先在终端验证显卡管理命令,再检查驱动状态和 1Panel 服务日志。 +>如果页面无数据,请先在终端验证显卡管理命令,再检查驱动状态和 1Panel 服务日志。 ## 3 历史记录 !!! note "" 历史记录用于按时间范围查看 GPU 指标趋势。只有已被采集并保存的数据才能形成历史曲线;更换节点时,应重新确认当前节点和查询时间范围。 +![GPU历史数据记录](../../img/ai/gpu_history1.png) +![GPU历史数据记录](../../img/ai/gpu_history2.png) ## 4 在容器中使用 GPU - -驱动和容器工具配置完成后,可在支持 GPU 的应用或容器配置中启用 **GPU 加速**,并选择需要分配的设备。容器启动后,可通过容器日志、主机 GPU 进程和利用率确认设备是否生效。 +!!! note "" + 驱动和容器工具配置完成后,可在支持 GPU 的应用或容器配置中启用 **GPU 加速**,并选择需要分配的设备。容器启动后,可通过容器日志、主机 GPU 进程和利用率确认设备是否生效。 ![应用 GPU 加速](../../img/ai/gpu_acceleration.png) -{: .original} diff --git a/docs/user_manual/ai/mcp.md b/docs/user_manual/ai/mcp.md index 7cf4d7dc5..2fa37141a 100644 --- a/docs/user_manual/ai/mcp.md +++ b/docs/user_manual/ai/mcp.md @@ -13,8 +13,8 @@ schema_type: TechArticle 入口为左侧菜单 **AI -> MCP**。社区版、专业版和企业版均可使用;创建、编辑、删除和绑定网站需要具有对应资源操作权限。 ## 1 创建 MCP Server - -点击 **创建**,也可以先点击 **导入 MCP Server 配置**,从包含 `mcpServers` 的 JSON 配置中导入命令和环境变量。 +!!! note "" + 点击 **创建**,也可以先点击 **导入 MCP Server 配置**,从包含 `mcpServers` 的 JSON 配置中导入命令和环境变量。 !!! info "参数说明" - **名称**:MCP Server 名称,创建后不可修改,同时用于生成默认容器名称和访问路径。 @@ -31,7 +31,6 @@ schema_type: TechArticle - **环境变量 / 挂载**:向 MCP Server 传入凭证、配置或主机目录。 ![创建 MCP Server](../../img/ai/create_mcp_server.png) -{: .original} !!! warning "命令与挂载安全" 1Panel 会在服务器上运行所填写的命令。导入第三方配置前,应检查命令、镜像、环境变量和挂载目录,不要运行来源不明或权限范围过大的 MCP Server。 @@ -42,9 +41,8 @@ schema_type: TechArticle 创建任务完成后,可在列表中查看运行状态和连接信息,并执行编辑、启动、停止、重启、删除、查看日志和测试连接等操作。客户端连接地址由外部访问路径、端口和当前输出类型的路径共同组成,应直接使用页面提供的配置。 ![MCP Server 连接配置](../../img/ai/mcp_server_config.png) -{: .original} -如果实例无法连接,依次检查容器状态及日志、运行命令、访问路径、端口监听、防火墙和反向代理配置。 +>如果实例无法连接,依次检查容器状态及日志、运行命令、访问路径、端口监听、防火墙和反向代理配置。 ## 3 绑定网站 @@ -52,9 +50,8 @@ schema_type: TechArticle 点击 **绑定网站**,可以把所有已安装的 MCP Server 统一接入一个已有网站。绑定后,1Panel 会更新各实例的外部访问地址,并关闭端口外部访问;不同实例通过各自的 SSE 或 Streamable HTTP 路径区分。 ![绑定 MCP 网站](../../img/ai/mcp_website.png) -{: .original} -网站侧可以继续配置 HTTPS 和访问限制。修改域名、证书或反向代理规则后,应重新测试每个 MCP Server 的连接。 +>网站侧可以继续配置 HTTPS 和访问限制。修改域名、证书或反向代理规则后,应重新测试每个 MCP Server 的连接。 !!! note "取消直接暴露端口" 已通过网站提供服务时,建议保持实例端口仅监听本机,避免网站入口和直接端口同时暴露。 diff --git a/docs/user_manual/ai/model.md b/docs/user_manual/ai/model.md index 7dd928fb4..fae76c28f 100644 --- a/docs/user_manual/ai/model.md +++ b/docs/user_manual/ai/model.md @@ -17,15 +17,17 @@ schema_type: TechArticle !!! note "" 模型账号保存模型服务的连接信息,可供智能体、AI 搜索等功能选择。点击 **创建** 后,按页面提示配置以下信息: +!!! note "" + - **名称**:模型账号在 1Panel 中的显示名称。 + - **模型提供商**:选择预置提供商,或选择自定义、Ollama、vLLM 等类型。 + - **API Key**:模型服务的访问凭证。是否需要填写取决于提供商。 + - **Base URL**:模型服务 API 地址。部分预置提供商使用默认地址,自定义、Ollama 和 vLLM 可按实际服务填写。 + - **API 类型**:按提供商支持情况选择兼容协议。 + - **模型池**:维护模型 ID、显示名称、Context Window、Max Tokens、输入类型和推理能力。 -- **名称**:模型账号在 1Panel 中的显示名称。 -- **模型提供商**:选择预置提供商,或选择自定义、Ollama、vLLM 等类型。 -- **API Key**:模型服务的访问凭证。是否需要填写取决于提供商。 -- **Base URL**:模型服务 API 地址。部分预置提供商使用默认地址,自定义、Ollama 和 vLLM 可按实际服务填写。 -- **API 类型**:按提供商支持情况选择兼容协议。 -- **模型池**:维护模型 ID、显示名称、Context Window、Max Tokens、输入类型和推理能力。 +![在线模型管理](../../img/ai/cloud_model.png) -创建完成后,可以在列表中验证连接、编辑账号、维护模型池或删除账号。编辑已经被智能体使用的账号时,可按页面选项同步更新相关智能体配置。 +>创建完成后,可以在列表中验证连接、编辑账号、维护模型池或删除账号。编辑已经被智能体使用的账号时,可按页面选项同步更新相关智能体配置。 !!! warning "凭证安全" API Key 属于敏感信息,仅向受信任的管理员开放模型账号管理权限。 @@ -38,36 +40,32 @@ schema_type: TechArticle 使用 Ollama 管理前,需要先从 **应用商店** 安装 Ollama。安装完成后,页面会显示应用运行状态,并提供启动、停止、重启和连接信息等操作。 ![Ollama 管理](../../img/ai/overview.png) -{: .original} ### 2.2 添加和运行模型 -点击 **添加模型**,输入 [Ollama 模型库](https://ollama.com/search)中的模型名称后确认,1Panel 将创建后台拉取任务。模型可用后,可以执行运行、重建或删除等操作。 +>点击 **添加模型**,输入 [Ollama 模型库](https://ollama.com/search)中的模型名称后确认,1Panel 将创建后台拉取任务。模型可用后,可以执行运行、重建或删除等操作。 ![添加 Ollama 模型](../../img/ai/model_pull.png) -{: .original} -点击模型所在行的 **运行**,可在页面内打开终端与模型对话。 +>点击模型所在行的 **运行**,可在页面内打开终端与模型对话。 ![运行 Ollama 模型](../../img/ai/model_run.png) -{: .original} ### 2.3 连接和同步 - -- **连接信息**:查看不同访问场景下的 Ollama 地址。容器内访问、主机访问和外部访问的地址可能不同,应以页面显示为准。 -- **从服务器同步**:当模型由其他工具添加或删除后,从 Ollama 服务重新读取模型列表。 -- **AI 代理增强**:为 Ollama 配置反向代理,可结合域名、HTTPS 和 IP 白名单限制外部访问。 -- **Open WebUI**:按页面入口跳转至已支持的 Web 管理工具。 +!!! note "" + - **连接信息**:查看不同访问场景下的 Ollama 地址。容器内访问、主机访问和外部访问的地址可能不同,应以页面显示为准。 + - **从服务器同步**:当模型由其他工具添加或删除后,从 Ollama 服务重新读取模型列表。 + - **AI 代理增强**:为 Ollama 配置反向代理,可结合域名、HTTPS 和 IP 白名单限制外部访问。 + - **Open WebUI**:按页面入口跳转至已支持的 Web 管理工具。 ## 3 vLLM - -vLLM 页面用于创建和维护本地推理服务,支持查看状态、编辑、启动、停止、重启、删除和任务进度。具体配置参见 [vLLM](./vllm.md)。 +!!! note "" + vLLM 页面用于创建和维护本地推理服务,支持查看状态、编辑、启动、停止、重启、删除和查看任务进度。具体配置参见 [vLLM](./vllm.md)。 ## 4 模型下载器 !!! info "版本说明" 模型下载器需要专业版或企业版许可证。 -模型下载器用于搜索和下载 Hugging Face、ModelScope 或兼容镜像站中的模型,并统一查看下载任务和本地模型目录。可按页面配置下载目录、镜像地址和访问令牌;私有或受限模型必须使用具有相应权限的令牌。 - +>模型下载器用于搜索和下载 Hugging Face、ModelScope 或兼容镜像站中的模型,并统一查看下载任务和本地模型目录。可按页面配置下载目录、镜像地址和访问令牌;私有或受限模型必须使用具有相应权限的令牌。 下载任务支持查看进度和错误信息,并可取消或重试。删除本地模型前,应确认该目录未被 vLLM 或其他服务使用。 diff --git a/docs/user_manual/ai/skills_hub.md b/docs/user_manual/ai/skills_hub.md index 3c8b5b7db..ee8d06fd1 100644 --- a/docs/user_manual/ai/skills_hub.md +++ b/docs/user_manual/ai/skills_hub.md @@ -15,11 +15,18 @@ schema_type: TechArticle ## 1 导入 Skill -页面支持以下来源: +!!! note "" + 页面支持以下来源: + - 上传 `.zip`、`.7z`、`.tar` 或 `.tar.gz` 格式的 Skill 压缩包,文件不超过 5 MB,压缩包中需包含 `SKILL.md`; + - 从 GitHub 仓库地址和分支或 Tag 导入; + - 从可下载的 `.zip` 软件包 URL 导入。 + +![上传 Skill](../../img/ai/skills_hub_upload.png) + +![从 GitHub 仓库地址导入](../../img/ai/skills_hub_import_github.png) + +![从压缩包 URL 导入](../../img/ai/skills_hub_import_url.png) -- 上传 `.zip`、`.7z`、`.tar` 或 `.tar.gz` 格式的 Skill 压缩包,文件不超过 5 MB,压缩包中需包含 `SKILL.md`; -- 从 GitHub 仓库地址和分支或 Tag 导入; -- 从可下载的 `.zip` 软件包 URL 导入。 !!! note "" 导入时填写版本。系统完成解析后会记录 Skill 名称、描述、来源、适用智能体、版本、状态和风险等级。 @@ -28,9 +35,12 @@ schema_type: TechArticle !!! note "" Skill 状态包括待审核、已审核、已上架、已下架、审核未通过和已删除。具备管理权限的用户可以执行审核通过、审核驳回、上架、下架和删除操作。 +![Skill 列表](../../img/ai/skills_hub_list_pending.png) !!! warning "风险检查" 风险检查会展示风险等级、文件路径、规则类型、命中关键字和说明。发布前应人工复核 Skill 内容及其依赖,不应仅根据自动检查结果判断安全性。 +![风险等级说明](../../img/ai/skills_hub_risk.png) + ## 3 版本管理 @@ -39,15 +49,20 @@ schema_type: TechArticle ## 4 自定义智能体 -在 **自定义智能体** 中点击 **添加智能体**,配置 Skill 的安装位置: +!!! note "" + 在 **自定义智能体** 中点击 **添加智能体**,配置 Skill 的安装位置: + + - **名称**:用于识别目标; + - **节点**:安装 Skill 的 1Panel 节点; + - **Skill 目录**:软件包解压到主机的目标目录; + - **安装后命令**:解压完成后执行的可选命令; + - **描述和状态**:说明用途并控制目标是否可选。 + +![自定义智能体列表](../../img/ai/skills_hub_targets.png) + -- **名称**:用于识别目标; -- **节点**:安装 Skill 的 1Panel 节点; -- **Skill 目录**:软件包解压到主机的目标目录; -- **安装后命令**:解压完成后执行的可选命令; -- **描述和状态**:说明用途并控制目标是否可选。 -安装 Skill 时可以选择一个或多个已启用目标。安装后命令会在目标节点执行,配置前应确认命令来源和执行影响。 +>安装 Skill 时可以选择一个或多个已启用目标。安装后命令会在目标节点执行,配置前应确认命令来源和执行影响。 ## 5 离线环境 diff --git a/docs/user_manual/ai/vllm.md b/docs/user_manual/ai/vllm.md index d040d1952..a39d71ecf 100644 --- a/docs/user_manual/ai/vllm.md +++ b/docs/user_manual/ai/vllm.md @@ -40,14 +40,14 @@ schema_type: TechArticle - **模型目录**:服务器上的本地模型目录。选择后,1Panel 会将该目录挂载到容器中 - **启动命令**:用于启动 vLLM 服务的命令参数。选择模型目录后,系统会根据目录名称自动生成默认命令;如有特殊推理参数需求,也可自行调整 -> vLLM 服务创建完成后,会以 OpenAI 兼容接口的形式对外提供推理能力,便于后续接入智能体或其他 AI 应用。 - +> vLLM 服务创建完成后,会以 OpenAI 兼容接口的形式对外提供推理能力,便于后续接入智能体或其他 AI 应用。 创建完成后,可将服务同步为 **模型账号**,供智能体及其他 AI 功能选择。同步时应确认 Base URL、API 类型和模型信息与实际服务一致。 ## 3 高级设置 !!! note "" 如需对容器运行方式做进一步控制,可展开 **高级设置**。 +![img.png](../../img/ai/vllm_create_hight.png) !!! info "高级设置说明" - **容器名称**:自定义 vLLM 容器名称,默认会跟随服务名称自动填写 @@ -60,7 +60,7 @@ schema_type: TechArticle ## 4 日常管理 -列表支持查看状态和运行目录,并提供编辑、启动、停止、重启、删除、查看日志和任务追踪等操作。修改镜像、启动命令、挂载或资源限制可能触发容器重建;未挂载到主机目录的数据不会随容器保留。 +>列表支持查看状态和运行目录,并提供编辑、启动、停止、重启、删除、查看日志和任务追踪等操作。修改镜像、启动命令、挂载或资源限制可能触发容器重建;未挂载到主机目录的数据不会随容器保留。 !!! warning "外部访问" 开启端口外部访问前,应结合防火墙、授权 IP 或反向代理限制访问范围。模型 API 默认不等同于已完成身份认证,不应直接暴露到不受信任的网络。 diff --git a/docs/user_manual/appstore/appstore.md b/docs/user_manual/appstore/appstore.md index 9587156c2..a4c3eeafa 100644 --- a/docs/user_manual/appstore/appstore.md +++ b/docs/user_manual/appstore/appstore.md @@ -13,4 +13,3 @@ 添加自己想要的应用,1Panel 应用商店还支持本地应用。制作教程可参考:[提交自定义应用教程](https://github.com/1Panel-dev/appstore/wiki/%E5%A6%82%E4%BD%95%E6%8F%90%E4%BA%A4%E8%87%AA%E5%B7%B1%E6%83%B3%E8%A6%81%E7%9A%84%E5%BA%94%E7%94%A8),也可以参考论坛文章:[1Panel 本地应用创建技巧及第三方应用库举例](https://bbs.fit2cloud.com/t/topic/640/)。 ![img.png](../../img/app/appstore.png) -{: .browser-mockup} diff --git a/docs/user_manual/appstore/cloudreve.md b/docs/user_manual/appstore/cloudreve.md index 93560a344..39c662dbb 100644 --- a/docs/user_manual/appstore/cloudreve.md +++ b/docs/user_manual/appstore/cloudreve.md @@ -28,7 +28,7 @@ - **数据库名** (为应用创建的数据库名称) - **数据库用户** (用于连接数据库的用户名) - **数据库用户密码** (数据库用户的密码) - - **redis 服务** (选择用于缓存的 Redis 服务) + - **Redis 服务** (选择用于缓存的 Redis 服务) - **缓存数据库密码** (Redis 服务的密码) - **端口** (应用的访问端口,默认为 40033) - **端口外部访问** (开启后,将允许从外部网络访问此应用端口) diff --git a/docs/user_manual/appstore/hermes-agent.md b/docs/user_manual/appstore/hermes-agent.md index d115336b9..5fc03fc20 100644 --- a/docs/user_manual/appstore/hermes-agent.md +++ b/docs/user_manual/appstore/hermes-agent.md @@ -38,6 +38,9 @@ 在智能体类型中选择 **Hermes Agent**,然后按页面要求填写部署参数。 +![Hermes_Agent_install.png](../../img/app/Hermes_Agent_install.png) + + !!! note "参数说明" - **智能体类型**:选择 `Hermes Agent` - **名称**:默认可填写为 `hermes-agent`,也可按需自定义 @@ -70,6 +73,8 @@ 首次打开时,如页面仍在初始化,可稍等片刻后再刷新访问。 +![Hermes_Agent_index.png](../../img/app/Hermes_Agent_index.png) + ## 5. 后续配置说明 !!! note "" diff --git a/docs/user_manual/appstore/install.md b/docs/user_manual/appstore/install.md index 05fa868b7..fcd8addc4 100644 --- a/docs/user_manual/appstore/install.md +++ b/docs/user_manual/appstore/install.md @@ -10,21 +10,17 @@ (1)点击【安装】按钮进入应用详情页面。 ![img.png](../../img/app/app_detail.png) -{: .browser-mockup} !!! note "" (2)填写数据库、端口等参数。 ![img.png](../../img/app/app_param.png) -{: .browser-mockup} !!! note "" (3)配置高级设置选项,例如是否暴露外部端口、资源限制以及编辑 compose文件等。最后,点击【确认】按钮,将弹出应用安装日志界面,等待应用安装完成。 -![img.png](../../img/app/installation_log.png){: .browser-mockup} -![img.png](../../img/app/app_install.png){: .browser-mockup} diff --git a/docs/user_manual/appstore/installed.md b/docs/user_manual/appstore/installed.md index f60e854fc..ab9473220 100644 --- a/docs/user_manual/appstore/installed.md +++ b/docs/user_manual/appstore/installed.md @@ -3,7 +3,6 @@ 进入已安装列表,用户可以对应用进行同步、升级、重启、启动、停止、删除、备份和恢复等操作。 ![img.png](../../img/app/installed_list.png) -{: .browser-mockup} ## 1 同步 @@ -12,7 +11,6 @@ 点击【同步】按钮,可自动更新应用状态,确保与当前系统状态保持一致。 ![img.png](../../img/app/app_sync.png) -{: .browser-mockup} ## 2 重建 @@ -21,7 +19,6 @@ 点击【重建】按钮,系统会删除现有的应用实例,并基于当前的设置和配置重新安装和启动应用。 ![img.png](../../img/app/app_rebuild.png) -{: .browser-mockup} !!! tip "提示" @@ -30,7 +27,6 @@ ## 3 启动 / 停止 / 重启 ![img.png](../../img/app/app_restart.png) -{: .browser-mockup} ## 4 卸载 @@ -42,7 +38,6 @@ - 删除备份:删除备份列表中的备份文件 ![img.png](../../img/app/app_delete.png) -{: .browser-mockup} ## 5 应用详情 @@ -51,14 +46,12 @@ 点击【参数】按钮,可以查看并修改应用的相关参数。 ![img.png](../../img/app/install_detail.png) -{: .browser-mockup} !!! note "" 点击参数页面右上角的【编辑】按钮,可以对部分应用参数及应用高级设置进行修改,具体支持修改的参数与应用定义有关。 ![img.png](../../img/app/app_modify.png) -{: .browser-mockup} ## 6 备份 / 恢复 @@ -67,21 +60,18 @@ 点击【备份】按钮,进入备份列表。 ![img.png](../../img/app/app_backup.png) -{: .browser-mockup} !!! note "" 点击【备份】按钮可立即备份当前应用。若需恢复应用,点击备份列表中的【恢复】按钮,将根据选定的备份恢复应用到相应状态。 ![img.png](../../img/app/app_restore.png) -{: .browser-mockup} !!! note "" 也可将备份文件下载后,通过导入备份功能上传备份文件并进行恢复。 ![img.png](../../img/app/backup_import.png) -{: .browser-mockup} ## 7 升级 @@ -90,18 +80,15 @@ 进入【可升级】页面,可查看当前支持升级的应用。 ![img.png](../../img/app/upgrade_list.png) -{: .browser-mockup} !!! note "" 点击应用卡片上的【忽略升级】按钮,可以不再显示该应用的升级提示。可以通过点击列表上方的【查看忽略应用】查看所有已忽略升级的应用并取消忽略。 ![img.png](../../img/app/upgrade_ignore.png) -{: .browser-mockup} !!! note "" 点击【升级】按钮后,选择目标版本。可选择在升级前备份应用、自动拉取最新镜像、以及自定义修改 compose.yml 文件等。最后点击【确认】按钮,等待升级完成。 ![img.png](../../img/app/app_upgrade.png) -{: .browser-mockup} diff --git a/docs/user_manual/appstore/setting.md b/docs/user_manual/appstore/setting.md index ad8a0a21e..60841a519 100644 --- a/docs/user_manual/appstore/setting.md +++ b/docs/user_manual/appstore/setting.md @@ -19,7 +19,6 @@ schema_type: TechArticle - **安装时放行端口**:启用后,应用安装时默认在主机防火墙中放行配置的外部端口。 ![应用商店设置](../../img/app/appstore_setting.png) -{: .browser-mockup} !!! warning "默认值会影响后续任务" 这些选项会作为后续安装、升级或卸载操作的默认值。执行具体任务前仍应检查确认框,尤其是备份、镜像清理和端口放行选项。 diff --git a/docs/user_manual/appstore/zabbix.md b/docs/user_manual/appstore/zabbix.md index 03b3a850a..ee4aa02bf 100644 --- a/docs/user_manual/appstore/zabbix.md +++ b/docs/user_manual/appstore/zabbix.md @@ -2,6 +2,9 @@ !!! note "" **Zabbix** 是一款企业级开源分布式监控解决方案,可用于监控网络设备、服务器、服务及其他 IT 资源的性能和可用性。 +!!! warning "注意" + 下面提到的IP无特殊配置的话要填 **docker网段** 分配的 **容器IP** 需要前往 **容器管理** 页面查看具体的容器IP + ## 1. 安装 Zabbix Server diff --git a/docs/user_manual/containers/compose_template.md b/docs/user_manual/containers/compose_template.md index cd5cac6d7..0b3a718e4 100644 --- a/docs/user_manual/containers/compose_template.md +++ b/docs/user_manual/containers/compose_template.md @@ -22,11 +22,11 @@ schema_type: TechArticle 不建议把数据库密码、访问令牌或私钥直接写入模板。优先使用环境变量文件、Docker Secret 或其他受控凭证方式,并确认导出文件不包含敏感数据。 ## 2 使用和管理 - -- 在模板列表点击名称可查看内容,点击 **编辑** 可修改名称、描述和 Compose 配置。 -- 创建编排时,可从已有模板载入内容,再根据目标节点修改目录、端口、网络和环境变量。 -- 删除模板不会删除已由该模板创建的编排。 +!!! note "" + - 在模板列表点击名称可查看内容,点击 **编辑** 可修改名称、描述和 Compose 配置。 + - 创建编排时,可从已有模板载入内容,再根据目标节点修改目录、端口、网络和环境变量。 + - 删除模板不会删除已由该模板创建的编排。 ## 3 导入和导出 - -模板支持 JSON 导入和批量导出。导入外部模板后,应检查镜像来源、特权模式、主机目录挂载、端口和启动命令,再用于生产环境。模板中的主机路径和网络名称不一定在其他节点存在,跨节点使用时必须重新核对。 +!!! note "" + 模板支持 JSON 导入和批量导出。导入外部模板后,应检查镜像来源、特权模式、主机目录挂载、端口和启动命令,再用于生产环境。模板中的主机路径和网络名称不一定在其他节点存在,跨节点使用时必须重新核对。 diff --git a/docs/user_manual/containers/container.md b/docs/user_manual/containers/container.md index 5ac3d30a0..c5af34c43 100644 --- a/docs/user_manual/containers/container.md +++ b/docs/user_manual/containers/container.md @@ -4,7 +4,7 @@ - 从菜单中选择【容器】,然后单击【创建容器】 - 根据需要配置容器设置 - - 镜像需要从镜像镜像菜单手动拉取 + - 镜像需要从镜像菜单手动拉取 ![img.png](../../img/containers/container_create.png) {: .original} diff --git a/docs/user_manual/containers/overview.md b/docs/user_manual/containers/overview.md index 97abed3bf..cde319fea 100644 --- a/docs/user_manual/containers/overview.md +++ b/docs/user_manual/containers/overview.md @@ -13,7 +13,6 @@ schema_type: TechArticle 页面展示容器及其运行状态、编排、编排模板、镜像、镜像仓库、网络和存储卷数量,点击数量可进入对应列表。 ![容器概览](../../img/containers/container_overview.png) -{: .browser-mockup} ## 磁盘占用 diff --git a/docs/user_manual/containers/repo.md b/docs/user_manual/containers/repo.md index ea17c2412..d2201a56f 100644 --- a/docs/user_manual/containers/repo.md +++ b/docs/user_manual/containers/repo.md @@ -12,12 +12,14 @@ schema_type: TechArticle ## 1 创建仓库 -点击 **创建**,填写名称、协议、下载地址,以及是否认证、用户名和密码。启用认证后,1Panel 会使用所填凭证执行 Docker 登录。 +!!! note "" + 点击 **创建**,填写名称、协议、下载地址,以及是否认证、用户名和密码。启用认证后,1Panel 会使用所填凭证执行 Docker 登录。 ![创建镜像仓库](../../img/containers/repo_create.png) {: .original} -使用 HTTP 仓库时,1Panel 会按确认提示把地址加入 Docker 不安全仓库配置,并需要重启 Docker 服务。重启会影响当前节点上正在进行的镜像操作,并可能短暂影响容器管理。 +!!! warning "" + 使用 HTTP 仓库时,1Panel 会按确认提示把地址加入 Docker 不安全仓库配置,并需要重启 Docker 服务。重启会影响当前节点上正在进行的镜像操作,并可能短暂影响容器管理。 ## 2 管理仓库 diff --git a/docs/user_manual/cronjobs.md b/docs/user_manual/cronjobs.md index 49637d1c0..abf2d9831 100644 --- a/docs/user_manual/cronjobs.md +++ b/docs/user_manual/cronjobs.md @@ -6,8 +6,8 @@ schema_type: TechArticle --- # 计划任务 - -计划任务用于按固定周期执行脚本、备份、日志维护和系统运维任务,也支持手动执行。入口为左侧菜单 **计划任务**。社区版、专业版和企业版均可使用;执行失败告警及部分高级任务是否可用取决于许可证和当前功能配置。 +!!! note "" + 计划任务用于按固定周期执行脚本、备份、日志维护和系统运维任务,也支持手动执行。入口为左侧菜单 **计划任务**。社区版、专业版和企业版均可使用;执行失败告警及部分高级任务是否可用取决于许可证和当前功能配置。 ## 1 创建任务 @@ -24,15 +24,15 @@ schema_type: TechArticle ## 2 任务类型 ### 2.1 Shell 脚本 - -填写脚本内容并选择解释器,也可以从脚本库或服务器文件中选择脚本。启用 **在容器中执行** 后,需要选择容器、用户和命令执行器。 +!!! note "" + 填写脚本内容并选择解释器,也可以从脚本库或服务器文件中选择脚本。启用 **在容器中执行** 后,需要选择容器、用户和命令执行器。 ![Shell 计划任务](../img/cronjobs/shell.png) {: .original} ### 2.2 备份应用、网站和数据库 - -选择一个、多个或全部对象,并配置备份账号、保留份数及备份选项。数据库任务还会根据数据库类型显示相应的备份参数。 +!!! note "" + 选择一个、多个或全部对象,并配置备份账号、保留份数及备份选项。数据库任务还会根据数据库类型显示相应的备份参数。 ![应用备份任务](../img/cronjobs/app.png) {: .original} @@ -41,51 +41,51 @@ schema_type: TechArticle 任务执行成功只表示备份流程完成。生产环境应定期执行恢复验证,并确认应用版本、数据库版本、压缩密码和远端文件均可用。 ### 2.3 备份目录 - -选择主机上的文件或目录,并配置压缩、排除规则和备份目标。避免把备份输出目录再次包含进源目录,否则可能造成递归归档或空间快速增长。 +!!! note "" + 选择主机上的文件或目录,并配置压缩、排除规则和备份目标。避免把备份输出目录再次包含进源目录,否则可能造成递归归档或空间快速增长。 ![目录备份任务](../img/cronjobs/dir.png) {: .original} ### 2.4 备份日志 - -备份 1Panel 系统日志、SSH 登录日志和网站日志。源日志已被轮转或删除后,任务只能备份当时仍存在的内容。 +!!! note "" + 备份 1Panel 系统日志、SSH 登录日志和网站日志。源日志已被轮转或删除后,任务只能备份当时仍存在的内容。 ### 2.5 访问 URL - -按周期请求一个或多个 URL。该任务适合触发受控接口或健康检查;需要鉴权时,应谨慎处理请求头和凭证,避免把敏感信息暴露在日志中。 +!!! note "" + 按周期请求一个或多个 URL。该任务适合触发受控接口或健康检查;需要鉴权时,应谨慎处理请求头和凭证,避免把敏感信息暴露在日志中。 ### 2.6 切割网站日志 - -切割指定网站的日志并保存历史文件。应结合保留份数和磁盘空间设置,防止长期日志占满磁盘。 +!!! note "" + 切割指定网站的日志并保存历史文件。应结合保留份数和磁盘空间设置,防止长期日志占满磁盘。 ### 2.7 缓存清理 - -按周期执行 **工具箱 -> 缓存清理** 中的清理项目。创建前应确认清理范围,避免删除仍需保留的容器、镜像、日志或临时数据。 +!!! note "" + 按周期执行 **工具箱 -> 缓存清理** 中的清理项目。创建前应确认清理范围,避免删除仍需保留的容器、镜像、日志或临时数据。 ### 2.8 系统快照 - -按周期创建 1Panel 系统快照。可以配置是否包含镜像以及忽略的应用;具体备份范围和恢复注意事项参见 [面板设置](./settings.md#5)。 +!!! note "" + 按周期创建 1Panel 系统快照。可以配置是否包含镜像以及忽略的应用;具体备份范围和恢复注意事项参见 [面板设置](./settings.md#5)。 ### 2.9 同步服务器时间 - -使用 **工具箱 -> 快速设置** 中配置的 NTP 服务器同步当前节点时间。 +!!! note "" + 使用 **工具箱 -> 快速设置** 中配置的 NTP 服务器同步当前节点时间。 ### 2.10 同步 IP 组 - -当页面提供该类型时,可按计划同步 WAF 使用的远程 IP 组。WAF IP 组支持社区版、专业版和企业版,创建任务前需要先完成对应 IP 组配置。 +!!! note "" + 当页面提供该类型时,可按计划同步 WAF 使用的远程 IP 组。WAF IP 组支持社区版、专业版和企业版,创建任务前需要先完成对应 IP 组配置。 ### 2.11 清理日志 - -按所选日志类型和保留策略清理日志。清理前应确认合规留存要求;已清理的日志不能从 1Panel 页面恢复。 +!!! note "" + 按所选日志类型和保留策略清理日志。清理前应确认合规留存要求;已清理的日志不能从 1Panel 页面恢复。 ## 3 任务库 - -任务库用于保存可复用的 Shell 脚本模板。创建 Shell 任务时可从任务库选择,也可以将常用脚本维护到任务库后重复使用。导入外部脚本前,应先审查命令和变量。 +!!! note "" + 任务库用于保存可复用的 Shell 脚本模板。创建 Shell 任务时可从任务库选择,也可以将常用脚本维护到任务库后重复使用。导入外部脚本前,应先审查命令和变量。 ## 4 执行报告 - -点击计划任务的 **报告** 查看每次执行时间、状态和日志。执行中的任务可查看实时输出;备份类任务还可以查看备份文件并按权限下载。 +!!! note "" + 点击计划任务的 **报告** 查看每次执行时间、状态和日志。执行中的任务可查看实时输出;备份类任务还可以查看备份文件并按权限下载。 ![备份文件](../img/cronjobs/backup_list.png) {: .original} @@ -94,5 +94,5 @@ schema_type: TechArticle {: .original} ## 5 导入和导出 - -计划任务支持通过 JSON 文件导入或导出。导入时,名称已存在的任务会被忽略;引用的网站、数据库、应用、备份账号或其他资源无法匹配时,任务可能进入待编辑状态。导入后应逐项检查目标节点、周期、路径和凭证,再启用任务。 +!!! note "" + 计划任务支持通过 JSON 文件导入或导出。导入时,名称已存在的任务会被忽略;引用的网站、数据库、应用、备份账号或其他资源无法匹配时,任务可能进入待编辑状态。导入后应逐项检查目标节点、周期、路径和凭证,再启用任务。 diff --git a/docs/user_manual/databases/mongodb.md b/docs/user_manual/databases/mongodb.md index 30440ca43..377c86a7f 100644 --- a/docs/user_manual/databases/mongodb.md +++ b/docs/user_manual/databases/mongodb.md @@ -21,27 +21,27 @@ schema_type: TechArticle 点击实例选择器中的 **安装 MongoDB**,可跳转到应用商店完成安装。安装完成后,页面会显示本地实例状态,并提供连接信息、从服务器同步和 Mongo Express 等入口。 ### 1.2 远程实例 +!!! note "" + 进入 **远程数据库**,点击 **创建远程数据库**,填写以下参数: -进入 **远程数据库**,点击 **创建远程数据库**,填写以下参数: - -- **名称**:1Panel 中用于识别该连接的名称; -- **版本**:当前页面可选择 `6.x`、`7.x` 或 `8.x`; -- **地址、端口**:MongoDB 服务地址和端口,默认端口为 `27017`; -- **初始数据库**:用于认证的数据库,默认值为 `admin`; -- **用户名、密码**:远程实例凭据; -- **超时时间、描述**:连接超时和备注。 + - **名称**:1Panel 中用于识别该连接的名称; + - **版本**:当前页面可选择 `6.x`、`7.x` 或 `8.x`; + - **地址、端口**:MongoDB 服务地址和端口,默认端口为 `27017`; + - **初始数据库**:用于认证的数据库,默认值为 `admin`; + - **用户名、密码**:远程实例凭据; + - **超时时间、描述**:连接超时和备注。 !!! note "" 保存前必须先点击 **连接测试**。解绑远程实例只会删除 1Panel 中的连接信息,不会删除远程 MongoDB 数据。 ## 2 创建数据库 +!!! note "" + 选择目标实例后点击 **创建数据库**,填写数据库名、用户名、密码、权限和描述。当前页面提供以下权限: -选择目标实例后点击 **创建数据库**,填写数据库名、用户名、密码、权限和描述。当前页面提供以下权限: - -- `dbOwner`:数据库所有者; -- `read`:只读; -- `readWrite`:读写; -- `userAdmin`:用户管理。 + - `dbOwner`:数据库所有者; + - `read`:只读; + - `readWrite`:读写; + - `userAdmin`:用户管理。 ## 3 数据库操作 diff --git a/docs/user_manual/databases/mysql.md b/docs/user_manual/databases/mysql.md index 844938af9..a08486e4a 100644 --- a/docs/user_manual/databases/mysql.md +++ b/docs/user_manual/databases/mysql.md @@ -57,7 +57,7 @@ ## 5 WEB 管理工具 !!! note "" - 如果需要使用 WEB 图形化界面管理 MySQL 数据库,可以列表上方的【管理】按钮,跳转到对应工具页面。 + 如果需要使用 WEB 图形化界面管理 MySQL 数据库,可以点击列表上方的【管理】按钮,跳转到对应工具页面。 目前支持的管理工具有: diff --git a/docs/user_manual/databases/redis.md b/docs/user_manual/databases/redis.md index c33a41e95..d4a6e608b 100644 --- a/docs/user_manual/databases/redis.md +++ b/docs/user_manual/databases/redis.md @@ -48,7 +48,7 @@ !!! note "" Redis 持久化分为两种:AOF 及 RDB,其中: - - RBD + - RDB - 实现: 父进程在保存 RDB 文件时,先 fork 出来一个子进程,然后子进程处理接下来的保存工作,父进程无需执行任何磁盘 I/O 操作 - 优点: 将 Redis 在某个时间点上的数据集保存在一个文件中,适用于灾难恢复,可以最大化 Redis 性能,速度更快,并且在恢复大数据集时速度更快 - 缺点: 有丢失数据的风险,需要设置备份频率,一旦发生故障停机时,可能会丢失数据,而且当数据集比较大时,fork 子进程将会非常耗时造成服务停止 diff --git a/docs/user_manual/enterprise/ops_report.md b/docs/user_manual/enterprise/ops_report.md index a26963abd..21f83c813 100644 --- a/docs/user_manual/enterprise/ops_report.md +++ b/docs/user_manual/enterprise/ops_report.md @@ -14,16 +14,16 @@ schema_type: TechArticle 进入 **安全运维报表**,可以按节点汇总系统、登录、网站、资源、计划任务和告警数据,并生成历史报表。 ## 1 报表内容 - -- **概览**:汇总评分、风险和主要运行指标; -- **系统**:展示主机和系统运行情况; -- **登录**:分析登录事件和异常; -- **网站**:汇总网站状态及相关风险; -- **资源**:展示 CPU、内存、磁盘等资源情况; -- **计划任务**:统计任务执行和失败记录; -- **告警**:汇总告警事件; -- **历史**:查看已经生成的报表; -- **设置**:配置导出格式、保存路径、自动导出和系统阈值,并查看最近生成结果。 +!!! note "" + - **概览**:汇总评分、风险和主要运行指标; + - **系统**:展示主机和系统运行情况; + - **登录**:分析登录事件和异常; + - **网站**:汇总网站状态及相关风险; + - **资源**:展示 CPU、内存、磁盘等资源情况; + - **计划任务**:统计任务执行和失败记录; + - **告警**:汇总告警事件; + - **历史**:查看已经生成的报表; + - **设置**:配置导出格式、保存路径、自动导出和系统阈值,并查看最近生成结果。 ## 2 选择节点 diff --git a/docs/user_manual/enterprise/user_management.md b/docs/user_manual/enterprise/user_management.md index ceedae74c..7722a5750 100644 --- a/docs/user_manual/enterprise/user_management.md +++ b/docs/user_manual/enterprise/user_management.md @@ -14,25 +14,25 @@ schema_type: TechArticle 进入 **用户管理**,可以创建面板用户和角色,并按节点分配权限。页面包含 **用户** 和 **角色** 两个标签。 ## 1 角色管理 - -创建角色时填写角色名称和描述,并在权限表中选择查看或管理权限。权限按首页、应用商店、AI、网站、数据库、容器、计划任务、工具箱、面板设置、系统、高级功能、节点和日志等分组展示。 +!!! note "" + 创建角色时填写角色名称和描述,并在权限表中选择查看或管理权限。权限按首页、应用商店、AI、网站、数据库、容器、计划任务、工具箱、面板设置、系统、高级功能、节点和日志等分组展示。 !!! note "权限联动" 部分管理权限依赖对应查看权限;页面会自动处理必选权限和依赖关系。标记为“仅主节点”的权限只在主节点生效。 -!!! note "" 系统内置角色不可编辑或删除。自定义角色被用户绑定时,应先调整用户的节点角色再删除。 ## 2 用户管理 +!!! note "" + 创建用户时填写: -创建用户时填写: - -- **用户名**; -- **密码**:长度和复杂度按页面校验规则执行; -- **权限**:为一个或多个节点分别选择角色; -- **描述**。 + - **用户名**; + - **密码**:长度和复杂度按页面校验规则执行; + - **权限**:为一个或多个节点分别选择角色; + - **描述**。 -同一用户在同一节点只能绑定一个角色,但可以在不同节点使用不同角色。编辑用户时密码留空表示不修改。 +!!! warning "注意" + 同一用户在同一节点只能绑定一个角色,但可以在不同节点使用不同角色。编辑用户时密码留空表示不修改。 ## 3 超级管理员 @@ -40,8 +40,8 @@ schema_type: TechArticle 超级管理员拥有完整权限,不能从用户列表删除,也不能通过普通用户编辑流程降低权限。用户和角色管理、许可证等管理入口只对超级管理员显示。 ## 4 使用建议 - -- 按职责创建角色,不要为日常用户直接分配超级管理员; -- 查看权限和管理权限分开授予; -- 定期检查离职用户、闲置账号和节点角色; -- 对网站、数据库、容器、文件、终端和高级功能的管理权限遵循最小权限原则。 +!!! note "" + - 按职责创建角色,不要为日常用户直接分配超级管理员; + - 查看权限和管理权限分开授予; + - 定期检查离职用户、闲置账号和节点角色; + - 对网站、数据库、容器、文件、终端和高级功能的管理权限遵循最小权限原则。 diff --git a/docs/user_manual/enterprise/vm.md b/docs/user_manual/enterprise/vm.md index 95e94e5e7..b3b3a94a0 100644 --- a/docs/user_manual/enterprise/vm.md +++ b/docs/user_manual/enterprise/vm.md @@ -19,28 +19,28 @@ schema_type: TechArticle 首次进入时,系统会检查虚拟化能力、KVM 辅助服务以及相关依赖。页面提示缺少可安装依赖时,可按引导安装;硬件虚拟化未开启、内核模块不可用或平台不受支持时,需要先在宿主机或固件中处理。 ## 2 页面结构 - -- **概览**:查看虚拟机、资源和存储摘要,并扫描孤立资源; -- **虚拟机**:创建、编辑、启动、停止、重启、重命名、删除和进入控制台; -- **ISO**:上传或管理系统安装镜像; -- **模板**:从可用资源创建或管理虚拟机模板; -- **网络**:管理 NAT 或桥接网络; -- **存储池**:管理虚拟磁盘存放位置和容量。 +!!! note "" + - **概览**:查看虚拟机、资源和存储摘要,并扫描孤立资源; + - **虚拟机**:创建、编辑、启动、停止、重启、重命名、删除和进入控制台; + - **ISO**:上传或管理系统安装镜像; + - **模板**:从可用资源创建或管理虚拟机模板; + - **网络**:管理 NAT 或桥接网络; + - **存储池**:管理虚拟磁盘存放位置和容量。 ## 3 创建虚拟机 - -1. 准备可用 ISO 或模板、网络和存储池。 -2. 进入 **虚拟机** 标签,点击 **创建**。 -3. 填写名称,选择安装来源并配置 CPU、内存和磁盘。 -4. 选择网络及其他启动参数,确认后提交。 -5. 虚拟机启动后,通过控制台完成操作系统安装。 +!!! note "" + 1. 准备可用 ISO 或模板、网络和存储池。 + 2. 进入 **虚拟机** 标签,点击 **创建**。 + 3. 填写名称,选择安装来源并配置 CPU、内存和磁盘。 + 4. 选择网络及其他启动参数,确认后提交。 + 5. 虚拟机启动后,通过控制台完成操作系统安装。 ## 4 网络与存储 - -- NAT 网络需要配置网段、网关和 DHCP 地址范围; -- 桥接网络需要选择宿主机现有桥接接口; -- 存储池创建时填写名称、类型、路径和描述; -- 删除网络或存储池前,应确认没有虚拟机或磁盘仍在使用。 +!!! note "" + - NAT 网络需要配置网段、网关和 DHCP 地址范围; + - 桥接网络需要选择宿主机现有桥接接口; + - 存储池创建时填写名称、类型、路径和描述; + - 删除网络或存储池前,应确认没有虚拟机或磁盘仍在使用。 !!! danger "宿主机风险" 虚拟机占用宿主机 CPU、内存、磁盘和网络。过量分配、错误桥接或删除虚拟磁盘都可能影响宿主机和业务,生产环境操作前应完成容量评估和备份。 diff --git a/docs/user_manual/hosts/disk.md b/docs/user_manual/hosts/disk.md index 4bf645348..dea0caedb 100644 --- a/docs/user_manual/hosts/disk.md +++ b/docs/user_manual/hosts/disk.md @@ -14,18 +14,18 @@ schema_type: TechArticle 进入 **系统 -> 磁盘管理**,可以查看系统盘、未分区磁盘和普通磁盘的容量、分区、文件系统、挂载点、使用率、磁盘类型、型号和序列号。 ## 1 磁盘分类 - -- **系统盘**:承载当前系统的磁盘。页面只展示信息,不提供挂载、卸载或分区操作。 -- **未分区磁盘**:未创建分区且未挂载的磁盘,可以从页面执行分区。 -- **普通磁盘**:展示现有分区及挂载状态,可以执行挂载或卸载。 +!!! note "" + - **系统盘**:承载当前系统的磁盘。页面只展示信息,不提供挂载、卸载或分区操作。 + - **未分区磁盘**:未创建分区且未挂载的磁盘,可以从页面执行分区。 + - **普通磁盘**:展示现有分区及挂载状态,可以执行挂载或卸载。 ## 2 分区并挂载 - -1. 在未分区磁盘卡片中点击 **分区**。 -2. 选择文件系统,当前支持 `ext4` 和 `xfs`。 -3. 填写挂载点。 -4. 根据需要启用 **自动挂载**;启用后可以同时配置 `nofail`。 -5. 确认磁盘设备和挂载点无误后提交。 +!!! note "" + 1. 在未分区磁盘卡片中点击 **分区**。 + 2. 选择文件系统,当前支持 `ext4` 和 `xfs`。 + 3. 填写挂载点。 + 4. 根据需要启用 **自动挂载**;启用后可以同时配置 `nofail`。 + 5. 确认磁盘设备和挂载点无误后提交。 !!! danger "数据风险" 分区和创建文件系统会清除目标磁盘上的原有数据。1Panel 不会替你判断磁盘中是否存在有效数据,操作前必须核对设备名并完成备份。 diff --git a/docs/user_manual/hosts/file.md b/docs/user_manual/hosts/file.md index f36212fa0..b997d478c 100644 --- a/docs/user_manual/hosts/file.md +++ b/docs/user_manual/hosts/file.md @@ -1,7 +1,7 @@ ## 1 文件操作 !!! note "" - 文件管理实现了很多实用的文件操作,除了基本的剪切、复制、粘贴、删除操作,还支持上传和下载文件、解压和解压、加密和解密、批量操作。 + 文件管理实现了很多实用的文件操作,除了基本的剪切、复制、粘贴、删除操作,还支持上传和下载文件、压缩和解压、加密和解密、批量操作。 ## 2 修改权限 @@ -9,7 +9,7 @@ 点击文件列表“权限”列中的值(类似 0755、0644),可对文件的权限进行修改。 !!! note "" - Linux 中文件权限可按照以下三个不用角色分别进行设置: + Linux 中文件权限可按照以下三个不同角色分别进行设置: - 文件所有者 - 所属用户组 diff --git a/docs/user_manual/hosts/monitor.md b/docs/user_manual/hosts/monitor.md index 3af2ef692..09a032e48 100644 --- a/docs/user_manual/hosts/monitor.md +++ b/docs/user_manual/hosts/monitor.md @@ -21,14 +21,14 @@ schema_type: TechArticle 监控图为空时,先确认监控开关已启用、查询时间范围内有采集数据,并检查系统时间和 1Panel 服务状态。 ## 2 监控设置 +!!! note "" + 点击页面上的 **设置**,节点管理员可以: -点击页面上的 **设置**,节点管理员可以: - -- 启用或停用监控采集; -- 设置监控数据保留天数; -- 设置采集间隔; -- 设置默认网卡和默认磁盘; -- 清空已有监控记录。 + - 启用或停用监控采集; + - 设置监控数据保留天数; + - 设置采集间隔; + - 设置默认网卡和默认磁盘; + - 清空已有监控记录。 !!! warning "容量和清理" 更短的采集间隔和更长的保留时间会增加数据库占用。清空监控记录后无法从 1Panel 恢复,应先确认不再需要历史数据。 diff --git a/docs/user_manual/hosts/process.md b/docs/user_manual/hosts/process.md index a6d31e0f0..245e28e09 100644 --- a/docs/user_manual/hosts/process.md +++ b/docs/user_manual/hosts/process.md @@ -18,7 +18,7 @@ 点击当前页面上方的 `网络` 选项,可以进入网络连接列表。 - 在列表中可以查看系统中的所有网络连接及端口使用信息 - - 列表上方筛选组件可以更具进程 ID、进程名称、端口号进行筛选 + - 列表上方筛选组件可以根据进程 ID、进程名称、端口号进行筛选 - 列表中可以根据 PID 进行排序,根据连接状态进行筛选 ![img.png](../../img/hosts/netstat.png) diff --git a/docs/user_manual/settings.md b/docs/user_manual/settings.md index a10ec9bb7..1f11add7b 100644 --- a/docs/user_manual/settings.md +++ b/docs/user_manual/settings.md @@ -160,8 +160,8 @@ schema_type: TechArticle 1. 登录企业微信管理后台 2. 进入 【应用管理】 -> 选择为 1Panel 告警创建或指定的自建应用 3. 在 **安全设置 / 可调用 IP 白名单** 中: - - 如**开启 IP 白名单**,则只允许白名单中的 IP 调用接口,建议将运行 1Panel 的服务器公网 IP 地址加入白名单 - - 如**未开启 / 未配置 IP 白名单**,则默认允许任意来源 IP 调用接口 + - 如 **开启 IP 白名单** ,则只允许白名单中的 IP 调用接口,建议将运行 1Panel 的服务器公网 IP 地址加入白名单 + - 如 **未开启 / 未配置 IP 白名单** ,则默认允许任意来源 IP 调用接口 4. 若已配置白名单,需确保服务器网络出口 IP 与白名单配置一致,避免因出口 NAT 导致 IP 不匹配 配置 IP 白名单后,仅允许来自白名单 IP 的服务器调用相关接口;如果更换服务器或出口 IP,需要同步更新白名单配置。 @@ -294,7 +294,7 @@ schema_type: TechArticle ### 4.2 OneDrive 自定义配置 !!! note "" - **在调用 Onedrive API 时需要使用到 4 个参数:** + **在调用 OneDrive API 时需要使用到 4 个参数:** - client_id: 客户端ID - client_secret: 客户端密码 @@ -303,9 +303,9 @@ schema_type: TechArticle !!! note "" - (1)访问并登录 MicroSoft Azure:https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade。 + (1)访问并登录 Microsoft Azure:https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade。 - (2)点击新注册,并填写注册信息,其中的重定向 URI 作为 重定向 Url 参数。 + (2)点击新注册,并填写注册信息,其中的重定向 URI 作为 重定向 URL 参数。 ![img.png](../img/settings/onedrive_custom1.png) {: .original} @@ -326,7 +326,7 @@ schema_type: TechArticle !!! note "" - (5)在【API 权限】页面选择需要的权限,添加权限,Microsoft Graph,委托的权限,勾选 Files.ReadWrite All、offline_access、User.Read,这将作为 scope 传递。 + (5)在【API 权限】页面选择需要的权限,添加权限,Microsoft Graph,委托的权限,勾选 Files.ReadWrite.All、offline_access、User.Read,这将作为 scope 传递。 ![img.png](../img/settings/onedrive_custom4.png) {: .original} @@ -421,7 +421,7 @@ schema_type: TechArticle {: .original} !!! note "" - (8)点击授权码的获取按钮,登陆谷歌账号,跳转至 1Panel 应用,完成登陆。 + (8)点击授权码的获取按钮,登录谷歌账号,跳转至 1Panel 应用,完成登陆。 ![img.png](../img/settings/google_drive_1.png) {: .original} @@ -504,7 +504,6 @@ schema_type: TechArticle 版本能力以 [1Panel 官网](https://1panel.cn/)及当前许可证页面显示为准。 ![img.png](../img/settings/licenses.png) -{: .browser-mockup} ## 7 关于 diff --git a/docs/user_manual/terminal.md b/docs/user_manual/terminal.md index f03ec9c25..9f83ebabf 100644 --- a/docs/user_manual/terminal.md +++ b/docs/user_manual/terminal.md @@ -43,15 +43,15 @@ schema_type: TechArticle 快速命令只是命令模板,选择后仍应检查目标主机和命令内容再执行。包含变量、管道或重定向的命令,应先在非生产环境验证。 ## 4 配置 +!!! note "" + **配置** 标签页仅管理员可见,主要包括: -**配置** 标签页仅管理员可见,主要包括: - -- 终端字体、字号、行高、字距、前景色、背景色、光标和滚动设置; -- 默认连接信息,以及打开终端时是否自动连接当前节点; -- 本地连接认证信息; -- AI 助手设置。 + - 终端字体、字号、行高、字距、前景色、背景色、光标和滚动设置; + - 默认连接信息,以及打开终端时是否自动连接当前节点; + - 本地连接认证信息; + - AI 助手设置。 -AI 助手可使用已创建的模型账号,根据“触发前缀 + 空格 + 自然语言”生成并回填命令。Ollama、vLLM 本地模型需要先配置为自定义模型账号。还可配置风险命令拦截列表,命中后阻止生成并以注释形式回填。 + AI 助手可使用已创建的模型账号,根据“触发前缀 + 空格 + 自然语言”生成并回填命令。Ollama、vLLM 本地模型需要先配置为自定义模型账号。还可配置风险命令拦截列表,命中后阻止生成并以注释形式回填。 !!! warning "AI 生成命令" AI 助手只负责生成命令,不代表命令已通过目标环境验证。执行前必须检查命令含义、参数、目标路径和权限范围。 diff --git a/docs/user_manual/toolbox/clean.md b/docs/user_manual/toolbox/clean.md index 7aa17d10a..ca4cb031c 100644 --- a/docs/user_manual/toolbox/clean.md +++ b/docs/user_manual/toolbox/clean.md @@ -10,12 +10,12 @@ - 系统缓存文件 - 系统废弃目录 - 容器垃圾 - - 所有违背任何容器使用的镜像 + - 所有未被任何容器使用的镜像 - 所有处于停止状态的容器 - 存储卷 - 构建缓存 - 临时上传文件 - - 临时长传文件 + - 临时上传文件 - 应用 - 网站 - 数据库 diff --git a/docs/user_manual/toolbox/supervisor.md b/docs/user_manual/toolbox/supervisor.md index d5d2fa3b4..0e49aa1db 100644 --- a/docs/user_manual/toolbox/supervisor.md +++ b/docs/user_manual/toolbox/supervisor.md @@ -75,7 +75,7 @@ !!! note "" - 列表页面可以操作守护进程,包括启动、停止、重启、查看日志、编辑、删除、修改源文等。 + 列表页面可以操作守护进程,包括启动、停止、重启、查看日志、编辑、删除、修改源文件等。 ![创建](../../img/hosts/supervisor_list.png){ width="900px" } {: .original} diff --git a/docs/user_manual/websites/certificate.md b/docs/user_manual/websites/certificate.md index 767041a5b..3e0c6caa8 100644 --- a/docs/user_manual/websites/certificate.md +++ b/docs/user_manual/websites/certificate.md @@ -13,16 +13,15 @@ schema_type: TechArticle 列表展示主域名、其他域名、申请方式、ACME 账户、到期时间、状态和自动续签状态,并提供详情、申请/续签、更新、编辑、同步、下载和删除等操作。实际按钮取决于证书来源和当前状态。 ![证书列表](../../img/websites/certificate_list.png) -{: .browser-mockup} ## 相关操作 - -- [申请证书](./certificate_create.md) -- [上传证书](./certificate_upload.md) -- [自签证书](./certificate_self_sign.md) -- [续签证书](./certificate_renew.md) -- [ACME 账户](./certificate_acme.md) -- [DNS 账户](./certificate_dns.md) +!!! note "" + - [申请证书](./certificate_create.md) + - [上传证书](./certificate_upload.md) + - [自签证书](./certificate_self_sign.md) + - [续签证书](./certificate_renew.md) + - [ACME 账户](./certificate_acme.md) + - [DNS 账户](./certificate_dns.md) !!! warning "删除和下载" 删除证书前应确认没有网站仍在使用。下载包中可能包含私钥,应通过安全渠道保存和传输。 diff --git a/docs/user_manual/websites/certificate_acme.md b/docs/user_manual/websites/certificate_acme.md index d3aca5c8b..56cf43b9c 100644 --- a/docs/user_manual/websites/certificate_acme.md +++ b/docs/user_manual/websites/certificate_acme.md @@ -16,4 +16,3 @@ schema_type: TechArticle 创建 ACME 账户时填写的邮箱可以用于接收证书相关通知。自定义 ACME 服务还需要按页面填写目录地址等信息。 ![img.png](../../img/websites/certificate_acme.png) -{: .browser-mockup} diff --git a/docs/user_manual/websites/certificate_create.md b/docs/user_manual/websites/certificate_create.md index d508c2997..6c55a8e1d 100644 --- a/docs/user_manual/websites/certificate_create.md +++ b/docs/user_manual/websites/certificate_create.md @@ -13,7 +13,6 @@ schema_type: TechArticle - 如果是 DNS 验证模式,需要提前准备 DNS 账号 ![img.png](../../img/websites/certificate_create.png) -{: .browser-mockup} ## 2 DNS 账号模式申请证书 diff --git a/docs/user_manual/websites/certificate_renew.md b/docs/user_manual/websites/certificate_renew.md index a14d3918a..291d9b743 100644 --- a/docs/user_manual/websites/certificate_renew.md +++ b/docs/user_manual/websites/certificate_renew.md @@ -6,19 +6,18 @@ schema_type: TechArticle --- # 续签证书 - -通过 DNS 账户或 HTTP 验证申请的证书可以启用自动续签;使用手动 DNS 验证或手动上传的证书不能按同样方式自动续签。是否支持自动续签以证书列表开关状态为准。 +!!! note "" + 通过 DNS 账户或 HTTP 验证申请的证书可以启用自动续签;使用手动 DNS 验证或手动上传的证书不能按同样方式自动续签。是否支持自动续签以证书列表开关状态为准。 ## 自动续签 - -启用 **自动续签** 后,1Panel 会在证书临近到期时发起续签。续签依赖 ACME 账户、DNS 账户或 HTTP 验证路径持续可用;域名解析、API 凭证、网络或网站配置变化都可能导致失败。 +!!! note "" + 启用 **自动续签** 后,1Panel 会在证书临近到期时发起续签。续签依赖 ACME 账户、DNS 账户或 HTTP 验证路径持续可用;域名解析、API 凭证、网络或网站配置变化都可能导致失败。 ## 手动续签 - -点击证书所在行的 **申请** 可手动触发续签。手动 DNS 类型会显示需要添加的解析记录,完成解析后再继续申请。任务状态和错误信息可在证书日志或任务日志中查看。 +!!! note "" + 点击证书所在行的 **申请** 可手动触发续签。手动 DNS 类型会显示需要添加的解析记录,完成解析后再继续申请。任务状态和错误信息可在证书日志或任务日志中查看。 ![续签证书](../../img/websites/certificate_renew.png) -{: .browser-mockup} !!! note "续签后的网站证书" 续签成功后,应确认使用该证书的网站已经加载新证书,并从客户端检查到期时间。业务侧存在 CDN、负载均衡或外部代理时,还需同步更新对应入口。 diff --git a/docs/user_manual/websites/certificate_self_sign.md b/docs/user_manual/websites/certificate_self_sign.md index 56be2dc34..68531231b 100644 --- a/docs/user_manual/websites/certificate_self_sign.md +++ b/docs/user_manual/websites/certificate_self_sign.md @@ -7,7 +7,6 @@ 1Panel 默认创建了名为 `1Panel` 的证书颁发机构,如果没有特殊要求,用户可以使用该颁发机构快速创建自签证书。 ![img.png](../../img/websites/certificate_self_sign_1.png) -{: .browser-mockup} ## 2 签发证书 @@ -16,4 +15,3 @@ 在证书颁发机构列表中,点击【签发证书】按钮,弹出签发证书页面。在该页面中可以创建自签证书。 ![img.png](../../img/websites/certificate_self_sign_2.png) -{: .browser-mockup} diff --git a/docs/user_manual/websites/certificate_upload.md b/docs/user_manual/websites/certificate_upload.md index 7fb288eb9..f1ca36bd0 100644 --- a/docs/user_manual/websites/certificate_upload.md +++ b/docs/user_manual/websites/certificate_upload.md @@ -12,7 +12,6 @@ schema_type: TechArticle 点击证书列表上方的【上传证书】按钮,用户可以将已有的 SSL 证书上传至 1Panel 中,用于网站的 HTTPS 访问。 ![img.png](../../img/websites/certificate_upload.png) -{: .browser-mockup} !!! note "" diff --git a/docs/user_manual/websites/golang.md b/docs/user_manual/websites/golang.md index 6dd3f079d..5967c5dcc 100644 --- a/docs/user_manual/websites/golang.md +++ b/docs/user_manual/websites/golang.md @@ -14,7 +14,6 @@ schema_type: TechArticle 点击 **创建运行环境**,选择 Go 版本、运行目录和启动配置。可选版本以当前页面显示为准;创建前应确保项目已经包含可构建或可执行的 Go 程序。 ![runtime_golang_create.png](../../img/websites/runtime_golang_create.png) -{: .browser-mockup} ## 2 操作 Go 运行环境 @@ -24,4 +23,3 @@ schema_type: TechArticle - 编辑启动命令、运行目录或环境变量后,需通过日志确认程序重新启动成功。 ![runtime_golang_list.png](../../img/websites/runtime_golang_list.png) -{: .browser-mockup} diff --git a/docs/user_manual/websites/java.md b/docs/user_manual/websites/java.md index 8dc410a98..f05c64087 100644 --- a/docs/user_manual/websites/java.md +++ b/docs/user_manual/websites/java.md @@ -7,7 +7,6 @@ - 目前支持 Java 1.8、11、17、18、21、22 大版本,用户可以根据自己的需求选择合适的版本 ![runtime_java_create.png](../../img/websites/runtime_java_create.png) -{: .browser-mockup} ## 2 操作 Java 运行环境 @@ -16,7 +15,6 @@ - 在列表页面,可以对 Java 运行环境进行停止、启动、重启、编辑、删除和查看日志等操作 ![runtime_java_list.png](../../img/websites/runtime_java_list.png) -{: .browser-mockup} ## 3 日志查看 @@ -25,4 +23,3 @@ 点击【查看】日志按钮,可以查看 Java 运行环境的运行日志。 ![runtime_java_log.png](../../img/websites/runtime_java_log.png) -{: .browser-mockup} diff --git a/docs/user_manual/websites/node.md b/docs/user_manual/websites/node.md index 413866ff4..69a17553a 100644 --- a/docs/user_manual/websites/node.md +++ b/docs/user_manual/websites/node.md @@ -4,10 +4,9 @@ 点击创建运行环境按钮,选择 Node 版本和源码目录。 - 目前支持 12.x、14.x 16.x 和 18.x 四个大版本,用户可以根据自己的需求选择合适的版本。 + 目前支持 12.x、14.x、16.x和 18.x 四个大版本,用户可以根据自己的需求选择合适的版本。 ![runtime_node_create.png](../../img/websites/runtime_node_create.png) -{: .browser-mockup} ## 2 操作 Node 运行环境 @@ -16,7 +15,6 @@ 在列表页面,可以查看 Node 运行环境安装的模块,对 Node 运行环境进行停止、启动、重启、编辑、删除、模块管理和查看日志等操作。 ![runtime_node_list.png](../../img/websites/runtime_node_list.png) -{: .browser-mockup} ## 3 日志查看 @@ -25,7 +23,6 @@ 点击【查看】日志按钮,可以查看 Node 运行环境的运行日志。 ![runtime_node_log.png](../../img/websites/runtime_node_log.png) -{: .browser-mockup} ## 4 模块管理 @@ -34,4 +31,3 @@ 点击模块按钮,可以对 Node 运行环境的模块进行管理。 ![runtime_node_module.png](../../img/websites/runtime_node_module.png) -{: .browser-mockup} diff --git a/docs/user_manual/websites/openresty.md b/docs/user_manual/websites/openresty.md index f35f54b77..810e6b293 100644 --- a/docs/user_manual/websites/openresty.md +++ b/docs/user_manual/websites/openresty.md @@ -10,7 +10,6 @@ 可以通过按钮停止、启动或重启来管理 OpenResty 应用。 ![img.png](../../img/websites/openresty_setting.png) -{: .browser-mockup} ## 2 重载 @@ -19,7 +18,6 @@ 允许用户在无需停机的情况下快速应用配置更改,确保网站服务的高可用性。 ![img.png](../../img/websites/openresty_reload.png) -{: .browser-mockup} ## 3 设置 @@ -30,7 +28,6 @@ 查看当前网站状态,包括活动连接数、总连接数、总握手次数、总请求数、请求数、响应数及驻留进程等信息。 ![img.png](../../img/websites/openresty_status.png) -{: .browser-mockup} ### 3.2 配置修改 @@ -40,7 +37,6 @@ - 点击【默认配置】按钮可将配置文件恢复到默认状态 ![img.png](../../img/websites/openresty_conf.png) -{: .browser-mockup} ### 3.3 性能调整 @@ -49,7 +45,6 @@ 调整 OpenResty 的相关配置参数。 ![img.png](../../img/websites/openresty_performance.png) -{: .browser-mockup} ### 3.4 日志 @@ -58,7 +53,6 @@ 查看 OpenResty 日志,支持实时追踪、下载、清空等操作,并可按指定时间段和行数筛选日志。 ![img.png](../../img/websites/openresty_log.png) -{: .browser-mockup} ### 3.5 模块 @@ -80,4 +74,3 @@ 脚本参考 unzip -o /tmp/nginx-rtmp-module.zip -d /tmp (必须是 /tmp) ![img.png](../../img/websites/openresty_module.png) -{: .browser-mockup} diff --git a/docs/user_manual/websites/php.md b/docs/user_manual/websites/php.md index 99d78896d..11e2641f0 100644 --- a/docs/user_manual/websites/php.md +++ b/docs/user_manual/websites/php.md @@ -7,7 +7,6 @@ - 1Panel 支持维护 5.x、7.x 和 8.x 三个大版本,用户可以根据自己的需求选择合适的版本 ![img.png](../../img/websites/runtime_list.png) -{: .browser-mockup} ### 1.1.创建 本地 PHP 运行环境 @@ -17,7 +16,6 @@ - 需要先在服务器上安装 php-fpm。 ![img.png](../../img/websites/runtime_local.png) -{: .browser-mockup} !!! note "" **1Panel 离线版** @@ -27,7 +25,6 @@ - 详细操作步骤可参考:[PHP 离线版使用文档](../../installation/package_installation.md/#8-php) ![img.png](../../img/websites/runtime_local_website.png) -{: .browser-mockup} ## 2 管理 PHP 扩展 @@ -35,7 +32,6 @@ 点击 PHP 运行环境列表中的【扩展】按钮,可以查看当前 PHP 运行环境已加载的扩展,同时支持安装、卸载扩展。 ![img.png](../../img/websites/runtime_php_extensions.png) -{: .browser-mockup} ## 3 修改 PHP 配置 @@ -43,7 +39,6 @@ 点击 PHP 运行环境列表中的【更多】操作中的【配置】选项,可以查看并修改当前 PHP 运行环境的配置。 ![img.png](../../img/websites/runtime_php_config.png) -{: .browser-mockup} ## 4 配置进程守护 @@ -54,7 +49,6 @@ ![img.png](../../img/websites/runtime_php_daemon.png) -{: .browser-mockup} ## 5 PHP 扩展列表 diff --git a/docs/user_manual/websites/website_backup.md b/docs/user_manual/websites/website_backup.md index dac88c802..217c35c56 100644 --- a/docs/user_manual/websites/website_backup.md +++ b/docs/user_manual/websites/website_backup.md @@ -10,7 +10,6 @@ 点击网站列表【更多】操作中的【备份列表】选项后,系统将在默认备份目录下生成网站的备份文件。 ![img.png](../../img/websites/backup_list.png) -{: .browser-mockup} ## 2 网站恢复 @@ -19,7 +18,6 @@ 在备份列表中选择目标备份记录,然后点击【恢复】按钮以进行恢复操作。 ![img.png](../../img/websites/website_restore.png) -{: .browser-mockup} ## 3 备份下载 @@ -28,7 +26,6 @@ 支持将网站备份记录下载到本地,下载后可在上传备份页面使用该文件。 ![img.png](../../img/websites/website_bak_download.png) -{: .browser-mockup} ## 4 导入备份 @@ -37,4 +34,3 @@ 选择网站备份文件并进行上传。 ![img.png](../../img/websites/website_bak_import.png) -{: .browser-mockup} diff --git a/docs/user_manual/websites/website_config_basic.md b/docs/user_manual/websites/website_config_basic.md index 43545827c..b28d5d048 100644 --- a/docs/user_manual/websites/website_config_basic.md +++ b/docs/user_manual/websites/website_config_basic.md @@ -18,7 +18,6 @@ schema_type: TechArticle 域名设置页面允许用户管理网站的域名和端口配置。 ![img.png](../../img/websites/config_basic_domain.png) -{: .browser-mockup} ## 2 网站目录 @@ -27,7 +26,6 @@ schema_type: TechArticle 网站目录页面支持查看网站的根目录,设置运行目录,以及配置运行用户和用户组等选项。 ![img.png](../../img/websites/config_basic_folder.png) -{: .browser-mockup} ## 3 默认文档 @@ -36,7 +34,6 @@ schema_type: TechArticle 配置默认文档,以便在用户访问网站根目录时自动加载指定的文件。 ![img_1.png](../../img/websites/basic_config_default.png) -{: .browser-mockup} ## 4 流量限制 @@ -45,7 +42,6 @@ schema_type: TechArticle 允许用户配置流量限制,通过选择不同的限制方案,控制网站的带宽和访问流量。 ![img.png](../../img/websites/basic_config_limit.png) -{: .browser-mockup} ## 5 反向代理 @@ -54,14 +50,12 @@ schema_type: TechArticle 反向代理功能允许将网站请求转发到后端服务器,以实现负载均衡、安全控制和内容分发。 ![img.png](../../img/websites/basic_config_proxy.png) -{: .browser-mockup} !!! note "" 用户也可以在当前页面开启并配置反向代理缓存规则,或者清除当前缓存。 ![img.png](../../img/websites/basic_config_proxy_cache.png) -{: .browser-mockup} ## 6 负载均衡 @@ -70,7 +64,6 @@ schema_type: TechArticle 创建负载均衡规则,用于将当前网站请求转发到多个后端服务。当前页面仅创建负载均衡规则,使用负载均衡规则需要在创建反向代理时使用 `http://<负载均衡名称>`。 ![img.png](../../img/websites/basic_config_upstream.png) -{: .browser-mockup} ## 7 密码访问 @@ -79,7 +72,6 @@ schema_type: TechArticle 密码访问功能允许用户为网站设置访问密码,以增强网站的安全性,限制未经授权的访问。支持创建全局配置或按路径配置。 ![img.png](../../img/websites/basic_config_password.png) -{: .browser-mockup} ## 8 CORS @@ -110,7 +102,6 @@ schema_type: TechArticle 通过以上配置,用户可以有效提升网站的安全性和访问性能。 ![img.png](../../img/websites/basic_config_https.png) -{: .browser-mockup} ## 10 真实 IP @@ -118,7 +109,6 @@ schema_type: TechArticle 配置客户端 IP 获取方式及可信的 IP 来源,OpenResty 会分析 HTTP Header 中的 IP 信息,准确识别并记录访客的真实 IP 地址,包括在访问日志中。 ![img.png](../../img/websites/basic_config_real_ip.png) -{: .browser-mockup} ## 11 伪静态 @@ -127,7 +117,6 @@ schema_type: TechArticle 伪静态功能通过将动态 URL 转换为更友好的静态 URL,提高网站的可读性和搜索引擎优化效果。 ![img.png](../../img/websites/basic_config_static.png) -{: .browser-mockup} ## 12 防盗链 @@ -136,7 +125,6 @@ schema_type: TechArticle 防盗链功能通过验证请求来源,阻止非授权用户直接链接和下载网站资源,以保护网站内容安全。 ![img.png](../../img/websites/basic_config_protection.png) -{: .browser-mockup} ## 13 重定向 @@ -145,7 +133,6 @@ schema_type: TechArticle 重定向功能允许将访问特定URL的请求自动转发到另一个URL,以实现链接管理和流量引导。 ![img.png](../../img/websites/basic_config_redirect.png) -{: .browser-mockup} ## 14 PHP @@ -154,7 +141,6 @@ schema_type: TechArticle 静态页面类型的网站可以在此选择 PHP 运行环境切换为 PHP 类型网站,PHP 类型的网站可以切换不同的 PHP 运行环境。 ![img.png](../../img/websites/basic_config_php.png) -{: .browser-mockup} ## 15 资源 @@ -163,7 +149,6 @@ schema_type: TechArticle 将当前网站与某一个数据库进行关联,备份网站时将同时备份关联的数据库。切换其他数据库会导致以前的备份无法恢复。 ![img.png](../../img/websites/basic_config_resource.png) -{: .browser-mockup} ## 16 其他 @@ -172,8 +157,9 @@ schema_type: TechArticle 支持更改主域名、切换分组以及更新备注信息等操作。 ![img.png](../../img/websites/basic_config_other.png) -{: .browser-mockup} ## 17 TCP/UDP 配置 -TCP/UDP 代理网站可在此调整协议、监听端口和上游负载均衡配置。修改监听端口后,应同步检查端口占用、防火墙和云安全组。 +!!! note "" + + TCP/UDP 代理网站可在此调整协议、监听端口和上游负载均衡配置。修改监听端口后,应同步检查端口占用、防火墙和云安全组。 diff --git a/docs/user_manual/websites/website_config_other.md b/docs/user_manual/websites/website_config_other.md index cd5804bb5..c73323e6c 100644 --- a/docs/user_manual/websites/website_config_other.md +++ b/docs/user_manual/websites/website_config_other.md @@ -22,7 +22,6 @@ schema_type: TechArticle - 清空日志内容 ![img.png](../../img/websites/log.png) -{: .browser-mockup} ## 2 资源与配置文件 @@ -33,7 +32,6 @@ schema_type: TechArticle - 保存配置前应检查语法;错误配置可能导致当前网站或 OpenResty 重载失败。 ![img.png](../../img/websites/web_openresty.png) -{: .browser-mockup} ## 3 默认站点 @@ -42,7 +40,6 @@ schema_type: TechArticle 在网站列表点击 **高级设置**,可设置未匹配到其他域名时使用的默认网站。 ![img.png](../../img/websites/website_default.png) -{: .browser-mockup} ## 4 默认页面 @@ -57,7 +54,6 @@ schema_type: TechArticle - **网站停用页** ![img.png](../../img/websites/website_default_page.png) -{: .browser-mockup} ## 5 开启 / 停止网站 @@ -66,7 +62,6 @@ schema_type: TechArticle 点击列表中的 **已启动** 或 **已停止** 可以切换 HTTP 网站状态。TCP/UDP 代理不通过该状态按钮切换。 ![img.png](../../img/websites/website_start.png) -{: .browser-mockup} ## 6 设置过期时间 @@ -75,7 +70,6 @@ schema_type: TechArticle 设置网站过期时间后,系统将在到期时自动停止该站点,以确保资源的有效管理和使用。 ![img.png](../../img/websites/web_expire.png) -{: .browser-mockup} ## 7 删除网站 @@ -91,4 +85,3 @@ schema_type: TechArticle 强制删除、删除关联应用或删除备份都可能造成不可逆的数据丢失。操作前应确认网站目录、关联数据库、应用数据和备份保留策略。 ![img.png](../../img/websites/website_del.png) -{: .browser-mockup} diff --git a/docs/user_manual/websites/website_create.md b/docs/user_manual/websites/website_create.md index 116c581c8..0bae8f10c 100644 --- a/docs/user_manual/websites/website_create.md +++ b/docs/user_manual/websites/website_create.md @@ -28,7 +28,6 @@ schema_type: TechArticle - **备注**:填写对该站点作用的描述 ![img.png](../../img/websites/auto_create.png) -{: .browser-mockup} ## 2 运行环境 @@ -49,7 +48,6 @@ schema_type: TechArticle - **备注**:提供该站点的功能描述 ![img.png](../../img/websites/website_runtime_create.png) -{: .browser-mockup} ## 3 反向代理 @@ -67,7 +65,6 @@ schema_type: TechArticle - **备注**:描述该站点的功能或用途 ![img.png](../../img/websites/proxy_create.png) -{: .browser-mockup} ## 4 静态网站 @@ -85,7 +82,6 @@ schema_type: TechArticle - **备注**:简要描述该站点的功能或用途 ![img.png](../../img/websites/static_create.png) -{: .browser-mockup} ## 5 子网站 @@ -104,17 +100,17 @@ schema_type: TechArticle - **备注**:简要描述该站点的功能或用途 ![img.png](../../img/websites/subsite_create.png) -{: .browser-mockup} ## 6 TCP/UDP 代理 -TCP/UDP 代理使用 OpenResty Stream 模块转发四层流量,适合数据库、消息服务或其他非 HTTP 服务。当前版本要求 OpenResty 不低于 `1.27.1.2-3-3-focal`,不满足时页面会禁止创建。 +!!! note "" + TCP/UDP 代理使用 OpenResty Stream 模块转发四层流量,适合数据库、消息服务或其他非 HTTP 服务。当前版本要求 OpenResty 不低于 `1.27.1.2-3-3-focal`,不满足时页面会禁止创建。 -- **监听端口**:对外监听的一个或多个端口,多个端口使用英文逗号分隔。 -- **UDP**:开启后使用 UDP,否则使用 TCP。 -- **负载均衡**:配置一个或多个上游服务器,以及权重、失败次数、连接数和失败超时等参数。 -- **代号**:用于在 1Panel 中标识该代理配置。 -- **监听 IPv6**:按服务器网络配置决定是否同时监听 IPv6。 + - **监听端口**:对外监听的一个或多个端口,多个端口使用英文逗号分隔。 + - **UDP**:开启后使用 UDP,否则使用 TCP。 + - **负载均衡**:配置一个或多个上游服务器,以及权重、失败次数、连接数和失败超时等参数。 + - **代号**:用于在 1Panel 中标识该代理配置。 + - **监听 IPv6**:按服务器网络配置决定是否同时监听 IPv6。 !!! warning "端口与访问控制" 创建前应确认监听端口未被占用,并在主机防火墙和云安全组中按需放行。TCP/UDP 代理不提供网站 HTTPS 配置,应由上游协议自身负责认证和加密。 diff --git a/docs/user_manual/websites/website_group.md b/docs/user_manual/websites/website_group.md index 8f195b7f5..bf25252bc 100644 --- a/docs/user_manual/websites/website_group.md +++ b/docs/user_manual/websites/website_group.md @@ -5,7 +5,6 @@ ## 1 创建分组 ![img.png](../../img/websites/website_group.png) -{: .browser-mockup} ## 2 默认分组 @@ -14,9 +13,7 @@ 设置网站默认分组后,创建新网站时会自动将其归入该分组。 ![img.png](../../img/websites/default_group.png) -{: .browser-mockup} ## 3 修改/删除分组 ![img.png](../../img/websites/edit_group.png) -{: .browser-mockup} diff --git a/docs/user_manual/websites/websites.md b/docs/user_manual/websites/websites.md index 23731d239..5ee32b159 100644 --- a/docs/user_manual/websites/websites.md +++ b/docs/user_manual/websites/websites.md @@ -11,12 +11,12 @@ schema_type: TechArticle 网站功能基于应用商店安装的 OpenResty,统一管理 HTTP/HTTPS 网站和 TCP/UDP 代理。社区版、专业版和企业版均可使用;企业版用户还需要相应的网站查看或管理权限。 ## 1 支持的网站类型 - -- 一键部署应用网站; -- PHP、Java、Node.js、Go、Python 和 .NET 运行环境网站; -- 反向代理和静态网站; -- PHP 或静态网站的子网站; -- TCP/UDP 代理。 +!!! note "" + - 一键部署应用网站; + - PHP、Java、Node.js、Go、Python 和 .NET 运行环境网站; + - 反向代理和静态网站; + - PHP 或静态网站的子网站; + - TCP/UDP 代理。 具体参数参见 [创建网站](./website_create.md)。 @@ -26,9 +26,8 @@ schema_type: TechArticle 列表支持按类型、分组和名称筛选,显示网站类型、目录、状态、协议和到期时间。可直接启动或停止 HTTP 网站,并进入配置、备份、恢复和删除操作;TCP/UDP 代理的状态和操作方式以页面显示为准。 ![网站列表](../../img/websites/website.png) -{: .browser-mockup} - -页面还提供分组、网站默认设置和批量操作。多节点环境下,网站及其 OpenResty、目录和证书都属于当前节点,操作前应确认节点选择器。 +!!! note "" + 页面还提供分组、网站默认设置和批量操作。多节点环境下,网站及其 OpenResty、目录和证书都属于当前节点,操作前应确认节点选择器。 !!! warning "依赖 OpenResty" 停止、卸载或升级 OpenResty 会影响当前节点上的网站。执行 OpenResty 维护前,应确认网站备份、配置备份和回滚方案。 diff --git a/docs/user_manual/xpack/appearance.md b/docs/user_manual/xpack/appearance.md index 33d1f439f..0cd3d3296 100644 --- a/docs/user_manual/xpack/appearance.md +++ b/docs/user_manual/xpack/appearance.md @@ -14,10 +14,10 @@ schema_type: TechArticle 进入 **高级功能 -> 界面设置**,可以配置面板品牌和登录页外观。 ## 1 品牌配置 - -- **带文字 Logo**:用于展开状态下的导航区域; -- **Logo**:用于收起状态或其他紧凑区域; -- **Favicon**:浏览器标签页图标。 +!!! note "" + - **带文字 Logo**:用于展开状态下的导航区域; + - **Logo**:用于收起状态或其他紧凑区域; + - **Favicon**:浏览器标签页图标。 ## 2 登录页配置 diff --git a/docs/user_manual/xpack/database_cluster.md b/docs/user_manual/xpack/database_cluster.md index 7febae220..6cae9153d 100644 --- a/docs/user_manual/xpack/database_cluster.md +++ b/docs/user_manual/xpack/database_cluster.md @@ -14,20 +14,20 @@ schema_type: TechArticle 进入 **高级功能 -> 数据库集群**,可以管理 MySQL、PostgreSQL 和 Redis 的主从部署。页面按数据库类型提供独立标签。 ## 1 使用前提 - -- 已在节点管理中添加并检查目标节点; -- 源节点和目标节点之间网络互通; -- 应用商店可用,目标节点具备足够磁盘和内存; -- 数据库端口未被占用,防火墙策略允许集群内部通信; -- 已完成业务数据备份。 +!!! note "" + - 已在节点管理中添加并检查目标节点; + - 源节点和目标节点之间网络互通; + - 应用商店可用,目标节点具备足够磁盘和内存; + - 数据库端口未被占用,防火墙策略允许集群内部通信; + - 已完成业务数据备份。 ## 2 创建集群 - -1. 选择 MySQL、PostgreSQL 或 Redis 标签。 -2. 点击 **添加集群**,填写集群名称。 -3. 选择安装节点并配置主节点参数。 -4. 提交任务并在任务日志中确认安装完成。 -5. 在已有集群中添加从节点,等待初始化和复制状态正常。 +!!! note "" + 1. 选择 MySQL、PostgreSQL 或 Redis 标签。 + 2. 点击 **添加集群**,填写集群名称。 + 3. 选择安装节点并配置主节点参数。 + 4. 提交任务并在任务日志中确认安装完成。 + 5. 在已有集群中添加从节点,等待初始化和复制状态正常。 ## 3 日常管理 diff --git a/docs/user_manual/xpack/mobile_app.md b/docs/user_manual/xpack/mobile_app.md index a23ffa64d..5c0089bdc 100644 --- a/docs/user_manual/xpack/mobile_app.md +++ b/docs/user_manual/xpack/mobile_app.md @@ -14,11 +14,11 @@ schema_type: TechArticle 进入 **高级功能 -> 移动端**,可以生成用于 1Panel 移动端 App 绑定面板的二维码。 ## 1 绑定前提 - -- 移动设备可以访问当前面板地址; -- 面板地址、端口、HTTPS 和安全入口配置正确; -- 如开启授权 IP、域名绑定或防火墙限制,已允许移动设备访问; -- 当前账号已启用 API 接口,并配置 API Key、IP 白名单和接口密钥有效期。 +!!! note "" + - 移动设备可以访问当前面板地址; + - 面板地址、端口、HTTPS 和安全入口配置正确; + - 如开启授权 IP、域名绑定或防火墙限制,已允许移动设备访问; + - 当前账号已启用 API 接口,并配置 API Key、IP 白名单和接口密钥有效期。 ## 2 生成二维码 @@ -29,10 +29,10 @@ schema_type: TechArticle 绑定二维码和 API Key 都属于敏感凭据。二维码过期后应重新生成。 ## 3 API 接口配置 +!!! note "" + 移动端绑定依赖当前账号的 API 接口设置: -移动端绑定依赖当前账号的 API 接口设置: - -- **API Key**:移动端请求凭据; -- **IP 白名单**:限制允许调用 API 的来源地址或网段; -- **接口密钥有效期**:校验接口请求时间戳与当前时间的间隔,单位为分钟;设置为 `0` 时不校验请求时间戳。该设置不会让 API Key 自动失效;如需撤销访问,应重置 API Key 或禁用 API 接口; -- **API 接口状态**:禁用后,已绑定客户端无法继续调用。 + - **API Key**:移动端请求凭据; + - **IP 白名单**:限制允许调用 API 的来源地址或网段; + - **接口密钥有效期**:校验接口请求时间戳与当前时间的间隔,单位为分钟;设置为 `0` 时不校验请求时间戳。该设置不会让 API Key 自动失效;如需撤销访问,应重置 API Key 或禁用 API 接口; + - **API 接口状态**:禁用后,已绑定客户端无法继续调用。 diff --git a/docs/user_manual/xpack/node.md b/docs/user_manual/xpack/node.md index 74e298a0d..1b72c5e41 100644 --- a/docs/user_manual/xpack/node.md +++ b/docs/user_manual/xpack/node.md @@ -29,7 +29,6 @@ schema_type: TechArticle 在节点概览页面,可以查看当前集群所有节点的整体状态,包括节点数量、在线状态、资源使用情况、应用分布等统计信息。 ![img.png](../../img/xpack/node_overview.png) -{: .browser-mockup} ## 3 添加节点 @@ -59,7 +58,6 @@ schema_type: TechArticle - **备份账号设置** ![img.png](../../img/xpack/node_add.png) -{: .browser-mockup} ### 3.2 可用性检查 @@ -67,7 +65,6 @@ schema_type: TechArticle 添加节点前,需要先进行可用性检查,以验证网络连通性和认证信息的正确性。只有通过可用性检查的节点才能成功添加。 ![img.png](../../img/xpack/node_add_check.png) -{: .browser-mockup} ### 3.3 添加节点 @@ -90,7 +87,6 @@ schema_type: TechArticle - **数据同步状态**:显示节点的数据同步状态 ![img.png](../../img/xpack/node_list.png) -{: .browser-mockup} ### 4.2 节点操作 @@ -110,7 +106,6 @@ schema_type: TechArticle 节点分组功能允许用户按照业务需求、环境类型或地理位置对节点进行分类管理。 ![img.png](../../img/xpack/node_group.png) -{: .browser-mockup} ## 6 节点切换 @@ -118,12 +113,10 @@ schema_type: TechArticle 在面板管理页面左下角,显示当前节点信息,点击节点名称,可以切换到其他节点。后续进行的所有操作,例如应用部署、网站管理等,都会在当前节点上进行。 ![img.png](../../img/xpack/node_switch.png) -{: .browser-mockup} ## 7 故障处理 ![img.png](../../img/xpack/node_fault.png) -{: .browser-mockup} !!! note "" 当节点状态异常时,可以点击节点列表状态列上的异常图标,查看异常原因。 @@ -131,4 +124,3 @@ schema_type: TechArticle 节点添加和日常通信依赖管理端到节点的网络连通性。排查时应依次确认 SSH、Agent 端口、节点服务状态、证书与版本兼容性,不要在未确认数据备份的情况下直接删除节点。 ![img.png](../../img/xpack/node_fault_detail.png) -{: .browser-mockup} diff --git a/docs/user_manual/xpack/tamper.md b/docs/user_manual/xpack/tamper.md index 0f46b7773..93a279c3b 100644 --- a/docs/user_manual/xpack/tamper.md +++ b/docs/user_manual/xpack/tamper.md @@ -53,7 +53,7 @@ schema_type: TechArticle - 排除目录:log - 设置: - 和规则 1 相比,access.log 会被限制不允许删除修改,如果保护文件是具体文件目录,具有最高优先级 - - 其他和规则一相同 + - 其他和规则 1 相同 ## 3 说明 diff --git a/docs/user_manual/xpack/waf/blackwhite.md b/docs/user_manual/xpack/waf/blackwhite.md index 1aea9c7b5..0c9b01798 100644 --- a/docs/user_manual/xpack/waf/blackwhite.md +++ b/docs/user_manual/xpack/waf/blackwhite.md @@ -14,20 +14,20 @@ schema_type: TechArticle 进入 **WAF -> 黑白名单**,可以配置全局 IP、URL、User-Agent 黑白名单,并维护可复用的 IP 组。规则作用于已启用 WAF 的网站。 ## 1 IP - -IP 规则支持黑名单和白名单,可以填写 IPv4、IPv6、IP 段或已创建的 IP 组。黑名单用于拒绝匹配的来源,白名单允许匹配的来源跳过后续 WAF 规则。 +!!! note "" + IP 规则支持黑名单和白名单,可以填写 IPv4、IPv6、IP 段或已创建的 IP 组。黑名单用于拒绝匹配的来源,白名单允许匹配的来源跳过后续 WAF 规则。 ## 2 URL - -URL 黑名单用于阻止匹配的请求路径,URL 白名单用于让匹配路径跳过后续 WAF 规则。规则采用页面提示的匹配方式,添加前应确认是否需要包含路径前缀或完整路径。 +!!! note "" + URL 黑名单用于阻止匹配的请求路径,URL 白名单用于让匹配路径跳过后续 WAF 规则。规则采用页面提示的匹配方式,添加前应确认是否需要包含路径前缀或完整路径。 ## 3 User-Agent - -User-Agent 黑名单和白名单根据请求头中的 User-Agent 内容进行匹配,可用于限制已知扫描器或放行可信客户端。User-Agent 可以被客户端伪造,不能单独作为身份认证依据。 +!!! note "" + User-Agent 黑名单和白名单根据请求头中的 User-Agent 内容进行匹配,可用于限制已知扫描器或放行可信客户端。User-Agent 可以被客户端伪造,不能单独作为身份认证依据。 ## 4 IP 组 - -IP 组用于集中维护一组 IPv4、IPv6 或 CIDR 地址,并在 IP 黑白名单中重复引用。页面支持创建、编辑、删除、导入和导出 IP 组;每行填写一个 IP 或 IP 段。 +!!! note "" + IP 组用于集中维护一组 IPv4、IPv6 或 CIDR 地址,并在 IP 黑白名单中重复引用。页面支持创建、编辑、删除、导入和导出 IP 组;每行填写一个 IP 或 IP 段。 !!! warning "规则范围" 过宽的黑名单可能阻断正常业务,过宽的白名单会降低防护范围。修改后应验证登录、上传、API 和回调等关键路径;专业版和企业版还可以结合拦截记录确认规则效果。 diff --git a/docs/user_manual/xpack/waf/dashboard.md b/docs/user_manual/xpack/waf/dashboard.md index 0bd2f376e..5feef5b5e 100644 --- a/docs/user_manual/xpack/waf/dashboard.md +++ b/docs/user_manual/xpack/waf/dashboard.md @@ -14,5 +14,5 @@ schema_type: TechArticle 首页展示今日请求数、拦截数、4xx 和 5xx 状态数量,以及请求来源地图、请求趋势和拦截趋势。WAF 未开启时,专业版和企业版用户可以通过页面顶部的开关启用全局防护。 社区版进入首页时会看到版本能力说明,可以继续使用 **黑白名单**、**网站设置** 和 **全局设置**。社区版需要在 **全局设置** 中操作 WAF 总开关。 - -页面无统计数据时,依次检查 OpenResty 状态、WAF 总开关、网站 WAF 开关、网站是否产生请求,以及当前查询节点是否正确。关闭总开关会使所有网站失去 WAF 防护,但不会自动删除已配置的规则。 +!!! note "" + 页面无统计数据时,依次检查 OpenResty 状态、WAF 总开关、网站 WAF 开关、网站是否产生请求,以及当前查询节点是否正确。关闭总开关会使所有网站失去 WAF 防护,但不会自动删除已配置的规则。 diff --git a/docs/user_manual/xpack/waf/log.md b/docs/user_manual/xpack/waf/log.md index be4cf0d78..f7369c2ac 100644 --- a/docs/user_manual/xpack/waf/log.md +++ b/docs/user_manual/xpack/waf/log.md @@ -14,13 +14,14 @@ schema_type: TechArticle 拦截记录展示 WAF 已记录的请求,可以按网站、命中规则、处理动作、URL 和来源 IP 筛选。列表包含 IP、域名、URL、IP 归属地、处理动作、命中规则、规则类型和时间,点击 **查看** 可以打开请求详情。 处理动作包括允许、拦截和观察。观察模式只记录命中结果,不会阻断请求。 + +!!! note "" + 页面支持以下批量操作: -页面支持以下批量操作: - -- 将选中记录的来源 IP 或 IP 段加入黑名单; -- 将选中记录的 URL 加入白名单; -- 按筛选条件创建导出任务,并在导出记录中下载文件; -- 清空全部 WAF 拦截日志。 + - 将选中记录的来源 IP 或 IP 段加入黑名单; + - 将选中记录的 URL 加入白名单; + - 按筛选条件创建导出任务,并在导出记录中下载文件; + - 清空全部 WAF 拦截日志。 !!! warning "日志与白名单" 清空日志后无法从 1Panel 页面恢复。将 URL 或 IP 加入白名单会跳过相应范围的后续 WAF 检查,处理误拦截时应先确认请求方法、参数和命中规则,再选择最小放行范围。 diff --git a/docs/user_manual/xpack/waf/site.md b/docs/user_manual/xpack/waf/site.md index e394d9438..4d5627949 100644 --- a/docs/user_manual/xpack/waf/site.md +++ b/docs/user_manual/xpack/waf/site.md @@ -16,20 +16,20 @@ schema_type: TechArticle 进入 **WAF -> 网站设置**,选择一个已创建的网站后,可以配置仅作用于该网站的 WAF 开关、执行策略、检测强度、频率限制、默认规则和自定义类配置。 ## 1 网站开关与执行策略 - -- **网站开关**:只有 WAF 总开关和当前网站开关同时开启,网站规则才会生效; -- **防护模式**:命中规则后按规则动作处理请求; -- **观察模式**:记录命中结果但不阻断请求,适合上线前观察; -- **检测强度**:可以选择标准或严格。网站使用严格模式前,需要先在全局默认规则的 **其他** 页面开启严格模式。 +!!! note "" + - **网站开关**:只有 WAF 总开关和当前网站开关同时开启,网站规则才会生效; + - **防护模式**:命中规则后按规则动作处理请求; + - **观察模式**:记录命中结果但不阻断请求,适合上线前观察; + - **检测强度**:可以选择标准或严格。网站使用严格模式前,需要先在全局默认规则的 **其他** 页面开启严格模式。 ## 2 频率限制 +!!! note "" + 网站设置提供 **访问频率限制**,可以为当前网站配置统计周期、请求阈值、封锁时间和统计模式。 -网站设置提供 **访问频率限制**,可以为当前网站配置统计周期、请求阈值、封锁时间和统计模式。 - -- **全局模式**:统计单位时间内该 IP 对网站任意 URL 的请求总数; -- **URL 模式**:分别统计单位时间内该 IP 对单个 URL 的请求数。 + - **全局模式**:统计单位时间内该 IP 对网站任意 URL 的请求总数; + - **URL 模式**:分别统计单位时间内该 IP 对单个 URL 的请求数。 -攻击频率限制、404 频率限制和专业版 URL 频率限制位于 **全局设置 -> 频率限制**,不在网站设置中单独配置。 + 攻击频率限制、404 频率限制和专业版 URL 频率限制位于 **全局设置 -> 频率限制**,不在网站设置中单独配置。 ## 3 默认规则 @@ -38,8 +38,8 @@ schema_type: TechArticle | 参数、URL、HTTP、Cookie、Header、User-Agent 规则 | 为当前网站启用或停用对应默认规则 | 社区版、专业版、企业版 | | SQL 注入、XSS | 为当前网站启用或停用对应防护 | 社区版、专业版、企业版 | | 应用规则 | 为当前网站选择应用防护规则 | 专业版、企业版 | - -全局默认规则用于提供初始配置,已有网站的实际状态以本页为准。HTTP 规则采用允许列表逻辑,关闭某个方法后,该网站使用该方法的正常请求也可能被阻止。 +!!! note "" + 全局默认规则用于提供初始配置,已有网站的实际状态以本页为准。HTTP 规则采用允许列表逻辑,关闭某个方法后,该网站使用该方法的正常请求也可能被阻止。 ## 4 自定义规则 diff --git a/docs/user_manual/xpack/waf/stat.md b/docs/user_manual/xpack/waf/stat.md index 6efaa1dc6..93f0bda72 100644 --- a/docs/user_manual/xpack/waf/stat.md +++ b/docs/user_manual/xpack/waf/stat.md @@ -13,11 +13,11 @@ schema_type: TechArticle !!! note "" 攻击报表按所选时间范围汇总命中 WAF 规则的来源 IP 和 URL,默认查询当天数据,分别展示前 100 条记录。 -- **IP 报表**:展示来源 IP、IP 归属地、命中次数和占比; -- **URL 报表**:展示请求 URL、命中次数和占比; -- **拉黑**:可以将报表中的 IP 或 URL 加入对应黑名单。 - -页面没有数据时,应确认 WAF 总开关和目标网站 WAF 均已开启、查询时间范围内存在请求,并检查日志配置是否允许记录相应请求。 + - **IP 报表**:展示来源 IP、IP 归属地、命中次数和占比; + - **URL 报表**:展示请求 URL、命中次数和占比; + - **拉黑**:可以将报表中的 IP 或 URL 加入对应黑名单。 +!!! warning "注意" + 页面没有数据时,应确认 WAF 总开关和目标网站 WAF 均已开启、查询时间范围内存在请求,并检查日志配置是否允许记录相应请求。 !!! warning "加入黑名单" 拉黑 IP 或 URL 会影响后续访问。操作前应确认目标不是正常用户、CDN 出口、共享代理或业务接口,并优先使用最小匹配范围。 diff --git a/docs/user_manual/xpack/waf/waf.md b/docs/user_manual/xpack/waf/waf.md index 32bb81763..63e8e8f8d 100644 --- a/docs/user_manual/xpack/waf/waf.md +++ b/docs/user_manual/xpack/waf/waf.md @@ -15,23 +15,23 @@ WAF(Web Application Firewall)用于检测和处理进入 1Panel 网站的 HT 专业版和企业版在此基础上提供首页统计、攻击报表、拦截记录、封锁记录,以及 URL 频率限制、漏洞防御、应用规则、自定义规则、地区访问限制、自定义拦截页面和日志配置等能力,需要有效许可证。企业版普通用户还需要 WAF 查看权限;修改规则和开关需要 WAF 管理权限。 ## 1 使用前提 +!!! note "" + - 已通过 1Panel 应用商店安装并运行 OpenResty; + - OpenResty 版本满足当前 WAF 页面提示的最低版本要求; + - 使用网站设置前,至少已在 1Panel 中创建一个网站。 -- 已通过 1Panel 应用商店安装并运行 OpenResty; -- OpenResty 版本满足当前 WAF 页面提示的最低版本要求; -- 使用网站设置前,至少已在 1Panel 中创建一个网站。 - -页面检测到 OpenResty 未安装或版本不兼容时,会提供安装或升级入口。OpenResty 停止运行时,网站及 WAF 防护也无法正常工作。 + 页面检测到 OpenResty 未安装或版本不兼容时,会提供安装或升级入口。OpenResty 停止运行时,网站及 WAF 防护也无法正常工作。 ## 2 入口与启用方式 +!!! note "" + 入口为左侧菜单 **WAF**。社区版页面提供 **首页**、**黑白名单**、**网站设置** 和 **全局设置**;导入专业版或企业版许可证后,还会显示 **攻击报表**、**拦截记录** 和 **封锁记录**。 -入口为左侧菜单 **WAF**。社区版页面提供 **首页**、**黑白名单**、**网站设置** 和 **全局设置**;导入专业版或企业版许可证后,还会显示 **攻击报表**、**拦截记录** 和 **封锁记录**。 - -首次配置时,建议按以下顺序操作: + 首次配置时,建议按以下顺序操作: -1. 进入 **WAF -> 全局设置**,开启 WAF 总开关并配置需要使用的全局规则; -2. 进入 **WAF -> 网站设置**,选择目标网站并开启网站 WAF; -3. 根据业务情况调整频率限制、默认规则、黑白名单和其他规则; -4. 验证网站登录、上传、API 和回调等关键请求。专业版和企业版可以结合拦截记录确认命中规则,社区版可以结合网站访问结果和 OpenResty 日志排查。 + 1. 进入 **WAF -> 全局设置**,开启 WAF 总开关并配置需要使用的全局规则; + 2. 进入 **WAF -> 网站设置**,选择目标网站并开启网站 WAF; + 3. 根据业务情况调整频率限制、默认规则、黑白名单和其他规则; + 4. 验证网站登录、上传、API 和回调等关键请求。专业版和企业版可以结合拦截记录确认命中规则,社区版可以结合网站访问结果和 OpenResty 日志排查。 !!! note "规则生效范围" WAF 总开关和网站开关需要同时开启。全局设置中带有 **网站** 标识的项目用于新建网站的默认配置,已有网站仍需在 **网站设置** 中单独确认;网站设置只影响当前选择的网站。 diff --git a/docs/user_manual/xpack/website_monitor.md b/docs/user_manual/xpack/website_monitor.md index 2154b0ace..8cb9068ba 100644 --- a/docs/user_manual/xpack/website_monitor.md +++ b/docs/user_manual/xpack/website_monitor.md @@ -14,26 +14,26 @@ schema_type: TechArticle 网站监控通过 OpenResty 访问日志统计网站请求情况。入口为 **高级功能 -> 网站监控**。 ## 1 页面结构 - -- **首页**:查看核心访问指标和趋势摘要; -- **访问统计**:按来源域名、浏览器、操作系统、设备和状态码等维度排行; -- **趋势统计**:按时间查看请求变化; -- **请求日志**:筛选和查看单条请求,并创建导出任务; -- **网站列表**:按网站查看 PV、UV、IP、流量和蜘蛛访问量; -- **设置**:配置采集、保留和排除规则。 +!!! note "" + - **首页**:查看核心访问指标和趋势摘要; + - **访问统计**:按来源域名、浏览器、操作系统、设备和状态码等维度排行; + - **趋势统计**:按时间查看请求变化; + - **请求日志**:筛选和查看单条请求,并创建导出任务; + - **网站列表**:按网站查看 PV、UV、IP、流量和蜘蛛访问量; + - **设置**:配置采集、保留和排除规则。 ## 2 启用监控 - -1. 确认 OpenResty 已安装并运行,版本符合页面检查要求。 -2. 进入 **设置**,在全局设置中启用监控。 -3. 根据需要切换到网站设置,为指定网站调整采集规则。 -4. 等待新请求产生后,在首页、趋势统计和请求日志页面查看数据。 +!!! note "" + 1. 确认 OpenResty 已安装并运行,版本符合页面检查要求。 + 2. 进入 **设置**,在全局设置中启用监控。 + 3. 根据需要切换到网站设置,为指定网站调整采集规则。 + 4. 等待新请求产生后,在首页、趋势统计和请求日志页面查看数据。 ## 3 设置说明 - -- **日志保留天数、日志保留大小**:共同限制监控日志的保留范围; -- **排除状态码、扩展名、URI、IP、User-Agent**:匹配的数据不进入统计; -- **CDN 配置**:在网站位于 CDN 或反向代理之后时,从指定请求头提取真实客户端 IP。 +!!! note "" + - **日志保留天数、日志保留大小**:共同限制监控日志的保留范围; + - **排除状态码、扩展名、URI、IP、User-Agent**:匹配的数据不进入统计; + - **CDN 配置**:在网站位于 CDN 或反向代理之后时,从指定请求头提取真实客户端 IP。 !!! warning "真实 IP" 只有请求确实经过可信 CDN 或代理时才应信任其转发头。配置错误可能导致访问来源被伪造,进而影响统计和安全分析。