chore: update docs

This commit is contained in:
Jacky 2025-04-16 15:48:06 +08:00
parent a57748a432
commit 00251a7159
No known key found for this signature in database
GPG key ID: 215C21B10DF38B4D
17 changed files with 86 additions and 144 deletions

View file

@ -1,59 +0,0 @@
---
# https://vitepress.dev/reference/default-theme-home-page
layout: home
title: Nginx UI
titleTemplate: واجهة ويب أخرى لـ Nginx
hero:
name: "Nginx UI"
text: "Yet another Nginx Web UI"
tagline: Simple, powerful, and fast.
image:
src: /assets/icon.svg
alt: Nginx UI
actions:
- theme: brand
text: Get Started
link: /guide/about
- theme: alt
text: View on Github
link: https://github.com/0xJacky/nginx-ui
features:
- icon: 📊
title: Online Statistics for Server Indicators
details: Monitor CPU usage, memory usage, load average, and disk usage in real-time.
- icon: 💬
title: Online ChatGPT Assistant
details: Get assistance from an AI-powered ChatGPT directly within the platform.
- icon: 🖱️
title: One-Click Deployment and Automatic Renewal
details: Easily deploy and auto-renew Let's Encrypt certificates with just one click.
- icon: 🛠️
title: Online Editing Websites Configurations
details: Edit configurations using our NgxConfigEditor block editor or Ace Code Editor with nginx syntax highlighting.
- icon: 📜
title: Online View Nginx Logs
details: Access and view your Nginx logs directly online.
- icon: 💻
title: Written in Go and Vue
details: The platform is built with Go and Vue, and distributed as a single executable binary.
- icon: 🔄
title: Automatically Test and Reload Configurations
details: Test configuration files and reload nginx automatically after saving changes.
- icon: 🖥️
title: Web Terminal
details: Access a web-based terminal for easy management.
- icon: 🌙
title: Dark Mode
details: Enable dark mode for a comfortable user experience.
- icon: 📱
title: Responsive Web Design
details: Enjoy a seamless experience on any device with responsive web design.
- icon: 🔐
title: 2FA Authentication
details: Secure sensitive actions with two-factor authentication.
---

View file

@ -43,9 +43,10 @@ Just want to try it out? Skip to the [Quickstart](./getting-started).
</div>
Nginx UI is a comprehensive web-based interface designed to simplify the management and configuration of Nginx servers.
It offers real-time server statistics, AI-powered ChatGPT assistance, one-click deployment, automatic renewal of Let's
Encrypt certificates, and user-friendly editing tools for website configurations. Additionally, Nginx UI provides
Nginx UI is a comprehensive web-based interface designed to simplify the management and configuration of Nginx single-node and cluster nodes.
It offers real-time server statistics, Nginx performance monitoring, AI-powered ChatGPT assistance,
the code editor that supports LLM Code Completion,
one-click deployment, automatic renewal of Let's Encrypt certificates, and user-friendly editing tools for website configurations. Additionally, Nginx UI provides
features such as online access to Nginx logs, automatic testing and reloading of configuration files, a web terminal,
dark mode, and responsive web design. Built with Go and Vue, Nginx UI ensures a seamless and efficient experience for
managing your Nginx server.
@ -59,11 +60,11 @@ managing your Nginx server.
- Online statistics for server indicators such as CPU usage, memory usage, load average, and disk usage.
- Configurations are automatically backed up after modifications, allowing you to compare any versions or restore to any previous version.
- Support for mirroring operations to multiple cluster nodes, easily manage multi-server environments.
- Export encrypted Nginx/NginxUI configurations for quick deployment and recovery to new environments.
- Export encrypted Nginx / Nginx UI configurations for quick deployment and recovery to new environments.
- Enhanced Online ChatGPT Assistant with support for multiple models, including displaying Deepseek-R1's chain of thought to help you better understand and optimize configurations.
- One-click deployment and automatic renewal Let's Encrypt certificates.
- Online editing websites configurations with our self-designed **NgxConfigEditor** which is a user-friendly block
editor for nginx configurations, or **Ace Code Editor** which supports highlighting nginx configuration syntax.
editor for nginx configurations, or **Ace Code Editor** which supports **LLM Code Completion** and highlighting nginx configuration syntax.
- Online view Nginx logs.
- Written in Go and Vue, distribution is a single executable binary.
- Automatically test configuration file and reload nginx after saving configuration.

View file

@ -28,7 +28,7 @@ region, you can use an HTTP proxy and set this option to the corresponding URL.
- Type: `string`
- Default: `gpt-3.5-turbo`
This option is used to set the ChatGPT model. If your account has the privilege to access the gpt-4 model, you can
This option is used to set the chat model. If your account has the privilege to access the gpt-4 model, you can
configure this option accordingly.
## APIType
@ -40,3 +40,18 @@ This option is used to set the type of the API.
- `OPEN_AI`: Use the OpenAI API.
- `AZURE`: Use the Azure API.
## EnableCodeCompletion
- Type: `boolean`
- Default: `false`
- Version: `>=2.0.0-rc.6`
This option is used to enable the code completion feature in the code editor.
## CodeCompletionModel
- Type: `string`
- Version: `>=2.0.0-rc.6`
This option is used to set the code completion model, leave it blank if you want to use the chat model.

View file

@ -8,7 +8,7 @@ titleTemplate: Yet another Nginx Web UI
hero:
name: "Nginx UI"
text: "Yet another Nginx Web UI"
tagline: Simple, powerful, and fast.
tagline: Intelligent, powerful, and fast.
image:
src: /assets/icon.svg
alt: Nginx UI
@ -32,10 +32,13 @@ features:
details: Support for mirroring operations to multiple cluster nodes, easily manage multi-server environments.
- icon: 📤
title: Encrypted Configuration Export
details: Export encrypted Nginx/NginxUI configurations for quick deployment and recovery to new environments.
details: Export encrypted Nginx / Nginx UI configurations for quick deployment and recovery to new environments.
- icon: 💬
title: Enhanced Online ChatGPT Assistant
details: Support for multiple models, including displaying Deepseek-R1's chain of thought to help you better understand and optimize configurations.
- icon: 🔍
title: Code Completion
details: Code editor supports code completion, help you write configuration faster.
- icon: 🖱️
title: One-Click Deployment and Automatic Renewal
details: Easily deploy and auto-renew Let's Encrypt certificates with just one click.

View file

@ -1,59 +0,0 @@
---
# https://vitepress.dev/reference/default-theme-home-page
layout: home
title: Nginx UI
titleTemplate: Yet another Nginx Web UI
hero:
name: "Nginx UI"
text: "Yet another Nginx Web UI"
tagline: Simple, powerful, and fast.
image:
src: /assets/icon.svg
alt: Nginx UI
actions:
- theme: brand
text: Get Started
link: /guide/about
- theme: alt
text: View on Github
link: https://github.com/0xJacky/nginx-ui
features:
- icon: 📊
title: Online Statistics for Server Indicators
details: Monitor CPU usage, memory usage, load average, and disk usage in real-time.
- icon: 💬
title: Online ChatGPT Assistant
details: Get assistance from an AI-powered ChatGPT directly within the platform.
- icon: 🖱️
title: One-Click Deployment and Automatic Renewal
details: Easily deploy and auto-renew Let's Encrypt certificates with just one click.
- icon: 🛠️
title: Online Editing Websites Configurations
details: Edit configurations using our NgxConfigEditor block editor or Ace Code Editor with nginx syntax highlighting.
- icon: 📜
title: Online View Nginx Logs
details: Access and view your Nginx logs directly online.
- icon: 💻
title: Written in Go and Vue
details: The platform is built with Go and Vue, and distributed as a single executable binary.
- icon: 🔄
title: Automatically Test and Reload Configurations
details: Test configuration files and reload nginx automatically after saving changes.
- icon: 🖥️
title: Web Terminal
details: Access a web-based terminal for easy management.
- icon: 🌙
title: Dark Mode
details: Enable dark mode for a comfortable user experience.
- icon: 📱
title: Responsive Web Design
details: Enjoy a seamless experience on any device with responsive web design.
- icon: 🔐
title: 2FA Authentication
details: Secure sensitive actions with two-factor authentication.
---

View file

@ -43,10 +43,11 @@ const members = [
</div>
Nginx UI 是一个全新的 Nginx 网络管理界面,旨在简化 Nginx 服务器的管理和配置。它提供实时服务器统计数据、ChatGPT
助手、一键部署、Let's Encrypt 证书的自动续签以及用户友好的网站配置编辑工具。此外Nginx UI 还提供了在线访问 Nginx
日志、配置文件的自动测试和重载、网络终端、深色模式和自适应网页设计等功能。Nginx UI 采用 Go 和 Vue 构建,确保在管理 Nginx
服务器时提供无缝高效的体验。
Nginx UI 是一个全新的 Nginx 网络管理界面,旨在简化 Nginx 单机和集群节点的管理和配置。
它提供实时服务器运行数据、Nginx 性能监控、ChatGPT 助手、支持大模型代码补全的代码编辑器、
一键部署 Let's Encrypt 证书的自动续签以及用户友好的网站配置编辑工具。此外Nginx UI 还提供了在线访问 Nginx
日志、配置文件的自动测试和重载、网络终端、深色模式和自适应网页设计等功能。
Nginx UI 采用 Go 和 Vue 构建,确保在管理 Nginx 服务器时提供无缝高效的体验。
## 我们的团队
@ -57,10 +58,10 @@ Nginx UI 是一个全新的 Nginx 网络管理界面,旨在简化 Nginx 服务
- 在线查看服务器 CPU、内存、系统负载、磁盘使用率等指标
- 配置修改后会自动备份,可以对比任意版本或恢复到任意版本
- 支持镜像操作到多个集群节点,轻松管理多服务器环境
- 导出加密的 Nginx/NginxUI 配置,方便快速部署和恢复到新环境
- 导出加密的 Nginx / Nginx UI 配置,方便快速部署和恢复到新环境
- 增强版在线 ChatGPT 助手,支持多种模型,包括显示 Deepseek-R1 的思考链,帮助您更好地理解和优化配置
- 一键申请和自动续签 Let's encrypt 证书
- 在线编辑 Nginx 配置文件,编辑器支持 Nginx 配置语法高亮
- 在线编辑 Nginx 配置文件,编辑器支持 **大模型代码补全** Nginx 配置语法高亮
- 在线查看 Nginx 日志
- 使用 Go 和 Vue 开发,发行版本为单个可执行的二进制文件
- 保存配置后自动测试配置文件并重载 Nginx

View file

@ -27,7 +27,7 @@ URL。
- 类型:`string`
- 默认值:`gpt-3.5-turbo`
此选项用于设置 ChatGPT 模型。如果您的帐户有权限访问 `gpt-4` 模型,可以相应地配置此选项。
此选项用于设置对话模型。如果您的帐户有权限访问 `gpt-4` 模型,可以相应地配置此选项。
## APIType
@ -38,3 +38,17 @@ URL。
- `OPEN_AI`: 使用 OpenAI API。
- `AZURE`: 使用 Azure API。
## EnableCodeCompletion
- 类型:`boolean`
- 默认值:`false`
- 版本:`>=2.0.0-rc.6`
此选项用于启用编辑器代码补全功能。
## CodeCompletionModel
- 类型:`string`
- 版本:`>=2.0.0-rc.6`
此选项用于设置代码补全的模型,留空则使用对话模型。

View file

@ -8,7 +8,7 @@ titleTemplate: Yet another Nginx Web UI
hero:
name: "Nginx UI"
text: "Nginx 网络管理界面的新选择"
tagline: 简单、强大、高速
tagline: 智能、强大、高速
image:
src: /assets/icon.svg
alt: Nginx UI
@ -32,10 +32,13 @@ features:
details: 支持镜像操作到多个集群节点,轻松管理多服务器环境。
- icon: 📤
title: 导出加密配置
details: 导出加密的 Nginx/NginxUI 配置,方便快速部署和恢复到新环境。
details: 导出加密的 Nginx / Nginx UI 配置,方便快速部署和恢复到新环境。
- icon: 💬
title: 增强版在线 ChatGPT 助手
details: 支持多种模型,包括显示 Deepseek-R1 的思考链,帮助您更好地理解和优化配置。
- icon: 🔍
title: 代码补全
details: 代码编辑器支持代码补全,帮助您更快地编写配置。
- icon: 🖱️
title: 一键部署和自动续期
details: 只需一键即可轻松部署和自动续期 Let's Encrypt 证书。

View file

@ -60,7 +60,7 @@ Nginx UI 是一個全新的 Nginx 網路管理介面,目的是簡化 Nginx 伺
- 匯出加密的 Nginx/NginxUI 設定,方便快速部署和恢復到新環境
- 增強版線上 ChatGPT 助手,支援多種模型,包括顯示 Deepseek-R1 的思考鏈,幫助您更好地理解和最佳化設定
- 一鍵申請和自動續簽 Let's encrypt 憑證
- 線上編輯 Nginx 設定檔案,編輯器支援 Nginx 設定語法突顯
- 線上編輯 Nginx 配置檔案,編輯器支援 **大模型代碼補全** 和 Nginx 配置語法突顯
- 線上檢視 Nginx 日誌
- 使用 Go 和 Vue 開發,發行版本為單個可執行檔案
- 儲存設定後自動測試設定檔案並過載 Nginx

View file

@ -27,7 +27,7 @@ URL。
- 型別:`string`
- 預設值:`gpt-3.5-turbo`
此選項用於設定 ChatGPT 模型。如果您的帳戶有許可權存取 `gpt-4` 模型,可以相應地設定此選項。
此選項用於設定對話模型。如果您的帳戶有許可權訪問 `gpt-4` 模型,可以相應地配置此選項。
## APIType
@ -38,3 +38,18 @@ URL。
- `OPEN_AI`: 使用 OpenAI API。
- `AZURE`: 使用 Azure API。
## EnableCodeCompletion
- 型別:`boolean`
- 預設值:`false`
- 版本:`>=2.0.0-rc.6`
此選項用於啟用編輯器代碼補全功能。
## CodeCompletionModel
- 型別:`string`
- 版本:`>=2.0.0-rc.6`
此選項用於設定代碼補全的模型,留空則使用對話模型。

View file

@ -8,7 +8,7 @@ titleTemplate: Yet another Nginx Web UI
hero:
name: "Nginx UI"
text: "Nginx 管理介面新選擇"
tagline: 簡單、強大、高速
tagline: 智能、強大、高速
image:
src: /assets/icon.svg
alt: Nginx UI
@ -36,6 +36,9 @@ features:
- icon: 💬
title: 線上 ChatGPT 助手
details: 支援多種模型,包括顯示 Deepseek-R1 的思考鏈,幫助您更好地理解和最佳化設定。
- icon: 🔍
title: 代碼補全
details: 代碼編輯器支持代碼補全,幫助您更快地編寫配置。
- icon: 🖱️
title: 一鍵部署和自動續期
details: 只需一鍵即可輕鬆部署和自動續期 Let's Encrypt 證書。