Updated README.

2025-05-10 18:05:48 +02:00 · 2022-07-27 20:56:51 +08:00 · 2022-07-27 20:56:51 +08:00 · f526cd0ade
commit f526cd0ade
parent 32153a9b00
3 changed files with 96 additions and 57 deletions
--- a/README-zh_CN.md
+++ b/README-zh_CN.md
@ -20,6 +20,7 @@ Nginx 网络管理界面，由  [0xJacky](https://jackyu.cn/) 与 [Hintay](https
    <li>
      <a href="#关于项目">关于项目</a>
      <ul>
+        <li><a href="#在线预览">在线预览</a></li>
        <li><a href="#特色">特色</a></li>
        <li><a href="#国际化">国际化</a></li>
        <li><a href="#构建基于">构建基于</a></li>
@ -61,6 +62,7 @@ Nginx 网络管理界面，由  [0xJacky](https://jackyu.cn/) 与 [Hintay](https
  </ol>
 </details>

+
 ## 关于项目

 ![Dashboard](resources/screenshots/dashboard_zh_CN.png)
@ -76,10 +78,10 @@ Nginx 网络管理界面，由  [0xJacky](https://jackyu.cn/) 与 [Hintay](https
 - 一键申请和自动续签 Let's encrypt 证书
 - 在线编辑 Nginx 配置文件，编辑器支持 Nginx 配置语法高亮
 - 使用 Go 和 Vue 开发，发行版本为单个可执行的二进制文件
- 保存配置文件后自动测试配置文件并重载 Nginx
- 基于 Web 浏览器的高级命令行终端
- 前端支持暗夜模式
- 前端支持屏幕自适应
+- 保存配置后自动测试配置文件并重载 Nginx
+- 基于网页浏览器的高级命令行终端
+- 支持深色模式
+- 自适应网页设计

 ### 国际化

@ -101,9 +103,19 @@ Nginx 网络管理界面，由  [0xJacky](https://jackyu.cn/) 与 [Hintay](https

 ### 使用前注意

-Nginx UI 遵循 Nginx 的标准，创建的网站配置文件位于 Nginx 配置目录（自动检测）下的 `sites-available` 目录，
-启用后的网站的配置文件将会创建一份软连接到 `sites-enabled`
-目录中。因此，您可能需要提前调整配置文件的组织方式。
+Nginx UI 遵循 Debian 的网页服务器配置文件标准。创建的网站配置文件将会放置于 Nginx 配置文件夹（自动检测）下的 `sites-available` 中，启用后的网站将会创建一份配置文件软连接到 `sites-enabled` 文件夹。您可能需要提前调整配置文件的组织方式。
+
+对于非 Debian (及 Ubuntu) 系统，您可能需要将 `nginx.conf` 配置文件中的内容修改为如下所示的 Debian 风格。
+
+```nginx
+http {
+	# ...
+	include /etc/nginx/conf.d/*.conf;
+	include /etc/nginx/sites-enabled/*;
+}
+```
+
+更多信息请参阅：[debian/conf/nginx.conf](https://salsa.debian.org/nginx-team/nginx/-/blob/master/debian/conf/nginx.conf#L59-L60)

 ### 安装

@ -117,7 +129,7 @@ Nginx UI 可在以下平台中使用：
 - Dragonfly BSD
 - Openwrt

-您可以在 [最新发行 (latest release)](https://github.com/0xJacky/nginx-ui/releases/latest) 中下载最新版本，或使用 [Linux 安装脚本](#scripts-for-linux).
+您可以在 [最新发行 (latest release)](https://github.com/0xJacky/nginx-ui/releases/latest) 中下载最新版本，或使用 [Linux 安装脚本](#scripts-for-linux)。

 ### 使用方法

@ -160,15 +172,15 @@ systemctl stop nginx-ui
 systemctl restart nginx-ui
 ```

-## 使用 Docker
+#### 使用 Docker

-Docker 示例
- `uozi/nginx-ui:latest` 镜像基于 `nginx:latest` 构建，
-您可以直接将该镜像监听到 80 和 443 端口以取代宿主机上的 Nginx
+您可以在 docker 中使用我们提供的 `uozi/nginx-ui:latest` [镜像](https://hub.docker.com/r/uozi/nginx-ui)，此镜像基于 `nginx:latest` 构建。您可以直接将其监听到 80 和 443 端口以取代宿主机上的 Nginx。

- 映射到 `/etc/nginx` 的文件夹应该为一个空目录
+注意：映射到 `/etc/nginx` 的文件夹应该为一个空目录。

-```
+**Docker 示例**
+
+```bash
 docker run -dit \
  --name=nginx-ui \
  --restart=always \
--- a/README-zh_TW.md
+++ b/README-zh_TW.md
@ -20,6 +20,7 @@ Nginx 網路管理介面，由  [0xJacky](https://jackyu.cn/) 與 [Hintay](https
    <li>
      <a href="#關於專案">關於專案</a>
      <ul>
+        <li><a href="#線上預覽">線上預覽</a></li>
        <li><a href="#特色">特色</a></li>
        <li><a href="#國際化">國際化</a></li>
        <li><a href="#構建基於">構建基於</a></li>
@ -57,31 +58,32 @@ Nginx 網路管理介面，由  [0xJacky](https://jackyu.cn/) 與 [Hintay](https
    </li>
    <li><a href="#nginx-反向代理配置示例">Nginx 反向代理配置示例</a></li>
    <li><a href="#貢獻">貢獻</a></li>
-    <li><a href="#開源許可">開源許可</a></li>
+    <li><a href="#開源軟體授權條款">開源軟體授權條款</a></li>
  </ol>
 </details>

+
 ## 關於專案

 ![Dashboard](resources/screenshots/dashboard_zh_TW.png)

-### 在线预览
+### 線上預覽

-网址：[https://nginxui.jackyu.cn](https://nginxui.jackyu.cn)
+位址：[https://nginxui.jackyu.cn](https://nginxui.jackyu.cn)

- 用户名：admin
- 密码：admin
+- 使用者：admin
+- 密碼：admin

 ### 特色

 - 線上檢視伺服器 CPU、記憶體、系統負載、磁碟使用率等指標
- 一鍵申請和自動續簽 Let's encrypt 證書
- 線上編輯 Nginx 配置檔案，編輯器支援 Nginx 配置語法高亮
- 使用 Go 和 Vue 開發，發行版本為單個可執行的二進位制檔案
- 保存配置文件後自動測試配置文件並重載 Nginx
- 基於 Web 瀏覽器的高級命令行終端
- 前端支援暗夜模式
- 前端支持屏幕自適應
+- 一鍵申請和自動續簽 Let's encrypt 憑證
+- 線上編輯 Nginx 配置檔案，編輯器支援 Nginx 配置語法突顯
+- 使用 Go 和 Vue 開發，發行版本為單個可執行檔案
+- 保存配置後自動測試配置檔案並重載 Nginx
+- 基於網頁瀏覽器的高級命令行終端
+- 支援暗黑模式
+- 自適應網頁設計

 ### 國際化

@ -103,11 +105,23 @@ Nginx 網路管理介面，由  [0xJacky](https://jackyu.cn/) 與 [Hintay](https

 ### 使用前注意

-Nginx UI 遵循 Nginx 的標準，建立的網站配置檔案位於 Nginx 配置目錄（自動檢測）下的 `sites-available` 目錄，啟用後的網站的配置檔案將會建立一份軟連線到 `sites-enabled`目錄中。因此，您可能需要提前調整配置檔案的組織方式。
+Nginx UI 遵循 Debian 的網頁伺服器配置檔案標準。建立的網站配置檔案將會放置於 Nginx 配置資料夾（自動檢測）下的 `sites-available` 中，啟用後的網站將會建立一份配置檔案軟連結檔到 `sites-enabled` 資料夾。您可能需要提前調整配置檔案的組織方式。
+
+對於非 Debian (及 Ubuntu) 作業系統，您可能需要將 `nginx.conf` 配置檔案中的內容修改為如下所示的 Debian 風格。
+
+```nginx
+http {
+	# ...
+	include /etc/nginx/conf.d/*.conf;
+	include /etc/nginx/sites-enabled/*;
+}
+```
+
+更多資訊請參閱：[debian/conf/nginx.conf](https://salsa.debian.org/nginx-team/nginx/-/blob/master/debian/conf/nginx.conf#L59-L60)

 ### 安裝

-Nginx UI 可在以下平臺中使用：
+Nginx UI 可在以下作業系統中使用：

 - Mac OS X 10.10 Yosemite 及之後版本（amd64 / arm64）
 - Linux 2.6.23 及之後版本（x86 / amd64 / arm64 / armv5 / armv6 / armv7）
@ -117,11 +131,11 @@ Nginx UI 可在以下平臺中使用：
 - Dragonfly BSD
 - Openwrt

-您可以在 [最新發行 (latest release)](https://github.com/0xJacky/nginx-ui/releases/latest) 中下載最新版本，或使用 [Linux 安裝指令碼](#scripts-for-linux).
+您可以在 [最新释出 (latest release)](https://github.com/0xJacky/nginx-ui/releases/latest) 中下載最新版本，或使用 [Linux 安裝指令碼](#scripts-for-linux)。

 ### 使用方法

-第一次執行 Nginx UI 時，請在瀏覽器中訪問 `http://<your_server_ip>:<listen_port>/install` 完成後續配置。
+第一次執行 Nginx UI 時，請在網頁瀏覽器中訪問 `http://<your_server_ip>:<listen_port>/install` 完成後續配置。

 #### 透過執行檔案執行
 **在終端中執行 Nginx UI**
@ -131,7 +145,7 @@ nginx-ui -config app.ini
 ```
 在終端使用 `Control+C` 退出 Nginx UI。

-**在後臺執行 Nginx UI**
+**在背景執行 Nginx UI**

 ```shell
 nohup ./nginx-ui -config app.ini &
@ -142,7 +156,7 @@ nohup ./nginx-ui -config app.ini &
 kill -9 $(ps -aux | grep nginx-ui | grep -v grep | awk '{print $2}')
 ```
 #### 使用 Systemd
-如果你使用的是 [Linux 安裝指令碼](#scripts-for-linux)，Nginx UI 將作為 `nginx-ui` 服務安裝在 systemd 中。請使用 `systemctl` 命令控制。
+如果你使用的是 [Linux 安裝指令碼](#scripts-for-linux)，Nginx UI 將作為 `nginx-ui` 守護行程安裝在 systemd 中。請使用 `systemctl` 指令控制。

 **啟動 Nginx UI**

@ -160,15 +174,15 @@ systemctl stop nginx-ui
 systemctl restart nginx-ui
 ```

-## 使用 Docker
+#### 使用 Docker

-Docker 示例
- `uozi/nginx-ui:latest` 鏡像基於 `nginx:latest` 構建，
-  您可以直接將該鏡像監聽到 80 和 443 端口以取代宿主機上的 Nginx
+您可以在 docker 中使用我們提供的 `uozi/nginx-ui:latest`  [鏡像](https://hub.docker.com/r/uozi/nginx-ui)，此鏡像基於 `nginx:latest` 構建。您可以直接將其監聽到 80 和 443 埠以取代宿主機上的 Nginx。

- 映射到 `/etc/nginx` 的文件夾應該為一個空目錄
+注意：映射到 `/etc/nginx` 的資料夾應是一個空資料夾。

-```
+**Docker 示例**
+
+```bash
 docker run -dit \
  --name=nginx-ui \
  --restart=always \
@ -181,7 +195,7 @@ docker run -dit \

 ## 手動構建

-對於沒有官方構建版本的平臺，可以嘗試手動構建。
+對於沒有官方構建版本的作業系統，可以嘗試手動構建。

 ### 依賴

@ -197,7 +211,7 @@ docker run -dit \

 ### 構建前端

-請在 `frontend` 目錄中執行以下命令。
+請在 `frontend` 資料夾中執行以下命令。

 ```shell
 yarn install
@ -222,7 +236,7 @@ go build -o nginx-ui -v main.go
 ```shell
 bash <(curl -L -s https://raw.githubusercontent.com/0xJacky/nginx-ui/master/install.sh) install
 ```
-一鍵安裝指令碼預設設定的監聽埠為 `9000`，HTTP Challenge 埠預設為 `9180`，如果出現埠衝突請進入 `/usr/local/etc/nginx-ui/app.ini` 修改，並使用 `systemctl restart nginx-ui` 重啟 Nginx UI 服務。
+一鍵安裝指令碼預設的監聽埠為 `9000`，HTTP Challenge 埠預設為 `9180`，如果出現埠衝突請修改 `/usr/local/etc/nginx-ui/app.ini`，並使用 `systemctl restart nginx-ui` 重啟 Nginx UI 守護行程。

 **解除安裝 Nginx UI 但保留配置和資料庫檔案**

@ -278,7 +292,7 @@ server {

 貢獻使開源社群成為學習、啟發和創造的絕佳場所。我們**非常感謝**您所做的任何貢獻。

-如果您有讓這個專案變得更強的建議，歡迎 fork 這個倉庫並建立一個 Pull Request。您也可以建立一個帶有 `enhancement` （加強）標籤的 Issue。最後，不要忘記給我們的專案點個 Star！再次感謝！
+如果您有讓這個專案變得更強的建議，歡迎 fork 這個程式庫 (repository) 並建立一個 Pull Request。您也可以建立一個帶有 `enhancement` （加強）標籤的 Issue。最後，不要忘記給我們的專案點個 Star！再次感謝！

 1. Fork 專案
 2. 建立您的分支 (`git checkout -b feature/AmazingFeature`)
@ -286,6 +300,6 @@ server {
 4. 推送到您的分支 (`git push origin feature/AmazingFeature`)
 5. 建立一個 Pull Request

-## 開源許可
+## 開源軟體授權條款

-此專案基於 GNU Affero Public License v3.0 (AGPLv3) 許可，請參閱 [LICENSE](LICENSE) 檔案。透過使用、分發或對本專案做出貢獻，表明您已同意本許可證的條款和條件。
+此專案基於 GNU Affero Public License v3.0 (AGPLv3) 授權條款，請參閱 [LICENSE](LICENSE) 檔案。透過使用、分發或對本專案做出貢獻，表明您已同意本許可證的條款和條件。
--- a/README.md
+++ b/README.md
@ -18,6 +18,7 @@ Yet another Nginx Web UI, developed by [0xJacky](https://jackyu.cn/) and [Hintay
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
+        <li><a href="#demo">Demo</a></li>
        <li><a href="#features">Features</a></li>
        <li><a href="#internationalization">Internationalization</a></li>
        <li><a href="#built-with">Built With</a></li>
@ -33,7 +34,7 @@ Yet another Nginx Web UI, developed by [0xJacky](https://jackyu.cn/) and [Hintay
          <ul>
            <li><a href="#from-executable">From Executable</a></li>
            <li><a href="#with-systemd">With Systemd</a></li>
-            <li><a href="#use-docker">Use Docker</a></li>
+            <li><a href="#with-docker">With Docker</a></li>
          </ul>
        </li>
      </ul>
@ -59,14 +60,15 @@ Yet another Nginx Web UI, developed by [0xJacky](https://jackyu.cn/) and [Hintay
  </ol>
 </details>

+
 ## About The Project

 ![Dashboard](resources/screenshots/dashboard_en.png)

 ### Demo
 URL：[https://nginxui.jackyu.cn](https://nginxui.jackyu.cn)
- username：admin
- password：admin
+- Username：admin
+- Password：admin

 ### Features

@ -76,8 +78,8 @@ URL：[https://nginxui.jackyu.cn](https://nginxui.jackyu.cn)
 - Written in Go and Vue, distribution is a single executable binary.
 - Automatically test configuration file and reload nginx after saving configuration.
 - Web Terminal
- Frontend support Dark Mode
- Frontend use Responsive Web Design
+- Dark Mode
+- Responsive Web Design

 ### Internationalization

@ -99,9 +101,19 @@ We welcome translations into any language.

 ### Before Use

-The Nginx UI follows the Nginx standard of creating site configuration files in the `sites-available` directory under
-the Nginx configuration directory (auto-detected). The configuration files for an enabled site will create a soft link
-to the `sites-enabled` directory. Therefore, you may need to adjust the way the configuration files are organised.
+The Nginx UI follows the Debian web server configuration file standard. Created site configuration files will be placed in the `sites-available` folder that under the Nginx configuration folder (auto-detected). The configuration files for an enabled site will create a soft link to the `sites-enabled` folder. You may need to adjust the way the configuration files are organised.
+
+For non-Debian (and Ubuntu) systems, you may need to change the contents of the `nginx.conf` configuration file to the Debian style as shown below.
+
+```nginx
+http {
+	# ...
+	include /etc/nginx/conf.d/*.conf;
+	include /etc/nginx/sites-enabled/*;
+}
+```
+
+For more information: [debian/conf/nginx.conf](https://salsa.debian.org/nginx-team/nginx/-/blob/master/debian/conf/nginx.conf#L59-L60)

 ### Installation

@ -159,14 +171,15 @@ systemctl stop nginx-ui
 systemctl restart nginx-ui
 ```

-## Use Docker
+#### With Docker

-Docker deploy example
- `uozi/nginx-ui:latest` base on `nginx:latest`, you can replace the Nginx on host by publishing port 80 and 443 to host
+You can use our `uozi/nginx-ui:latest` [image](https://hub.docker.com/r/uozi/nginx-ui) in docker, which is base on `nginx:latest`. You can replace the Nginx on host by publishing port 80 and 443 to host.

- The volume mapping to `/etc/nginx` should be empty.
+Note: The volume mapping to `/etc/nginx` should be empty.

-```
+**Docker Deploy Example**
+
+```bash
 docker run -dit \
  --name=nginx-ui \
  --restart=always \