Skip to content

Commit f526cd0

Browse files
committed
Updated README.
1 parent 32153a9 commit f526cd0

File tree

3 files changed

+96
-57
lines changed

3 files changed

+96
-57
lines changed

README-zh_CN.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Nginx 网络管理界面,由 [0xJacky](https://jackyu.cn/) 与 [Hintay](https
2020
<li>
2121
<a href="#关于项目">关于项目</a>
2222
<ul>
23+
<li><a href="#在线预览">在线预览</a></li>
2324
<li><a href="#特色">特色</a></li>
2425
<li><a href="#国际化">国际化</a></li>
2526
<li><a href="#构建基于">构建基于</a></li>
@@ -61,6 +62,7 @@ Nginx 网络管理界面,由 [0xJacky](https://jackyu.cn/) 与 [Hintay](https
6162
</ol>
6263
</details>
6364

65+
6466
## 关于项目
6567

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

8486
### 国际化
8587

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

102104
### 使用前注意
103105

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

108120
### 安装
109121

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

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

122134
### 使用方法
123135

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

163-
## 使用 Docker
175+
#### 使用 Docker
164176

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

169-
- 映射到 `/etc/nginx` 的文件夹应该为一个空目录
179+
注意:映射到 `/etc/nginx` 的文件夹应该为一个空目录
170180

171-
```
181+
**Docker 示例**
182+
183+
```bash
172184
docker run -dit \
173185
--name=nginx-ui \
174186
--restart=always \

README-zh_TW.md

Lines changed: 44 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Nginx 網路管理介面,由 [0xJacky](https://jackyu.cn/) 與 [Hintay](https
2020
<li>
2121
<a href="#關於專案">關於專案</a>
2222
<ul>
23+
<li><a href="#線上預覽">線上預覽</a></li>
2324
<li><a href="#特色">特色</a></li>
2425
<li><a href="#國際化">國際化</a></li>
2526
<li><a href="#構建基於">構建基於</a></li>
@@ -57,31 +58,32 @@ Nginx 網路管理介面,由 [0xJacky](https://jackyu.cn/) 與 [Hintay](https
5758
</li>
5859
<li><a href="#nginx-反向代理配置示例">Nginx 反向代理配置示例</a></li>
5960
<li><a href="#貢獻">貢獻</a></li>
60-
<li><a href="#開源許可">開源許可</a></li>
61+
<li><a href="#開源軟體授權條款">開源軟體授權條款</a></li>
6162
</ol>
6263
</details>
6364

65+
6466
## 關於專案
6567

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

68-
### 在线预览
70+
### 線上預覽
6971

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

72-
- 用户名:admin
73-
- 密码:admin
74+
- 使用者:admin
75+
- 密碼:admin
7476

7577
### 特色
7678

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

8688
### 國際化
8789

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

104106
### 使用前注意
105107

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

108122
### 安裝
109123

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

112126
- Mac OS X 10.10 Yosemite 及之後版本(amd64 / arm64)
113127
- Linux 2.6.23 及之後版本(x86 / amd64 / arm64 / armv5 / armv6 / armv7)
@@ -117,11 +131,11 @@ Nginx UI 可在以下平臺中使用:
117131
- Dragonfly BSD
118132
- Openwrt
119133

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

122136
### 使用方法
123137

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

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

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

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

147161
**啟動 Nginx UI**
148162

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

163-
## 使用 Docker
177+
#### 使用 Docker
164178

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

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

171-
```
183+
**Docker 示例**
184+
185+
```bash
172186
docker run -dit \
173187
--name=nginx-ui \
174188
--restart=always \
@@ -181,7 +195,7 @@ docker run -dit \
181195

182196
## 手動構建
183197

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

186200
### 依賴
187201

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

198212
### 構建前端
199213

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

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

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

@@ -278,14 +292,14 @@ server {
278292

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

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

283297
1. Fork 專案
284298
2. 建立您的分支 (`git checkout -b feature/AmazingFeature`)
285299
3. 提交您的修改 (`git commit -m 'Add some AmazingFeature'`)
286300
4. 推送到您的分支 (`git push origin feature/AmazingFeature`)
287301
5. 建立一個 Pull Request
288302

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

291-
此專案基於 GNU Affero Public License v3.0 (AGPLv3) 許可,請參閱 [LICENSE](LICENSE) 檔案。透過使用、分發或對本專案做出貢獻,表明您已同意本許可證的條款和條件。
305+
此專案基於 GNU Affero Public License v3.0 (AGPLv3) 授權條款,請參閱 [LICENSE](LICENSE) 檔案。透過使用、分發或對本專案做出貢獻,表明您已同意本許可證的條款和條件。

README.md

Lines changed: 26 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Yet another Nginx Web UI, developed by [0xJacky](https://jackyu.cn/) and [Hintay
1818
<li>
1919
<a href="#about-the-project">About The Project</a>
2020
<ul>
21+
<li><a href="#demo">Demo</a></li>
2122
<li><a href="#features">Features</a></li>
2223
<li><a href="#internationalization">Internationalization</a></li>
2324
<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
3334
<ul>
3435
<li><a href="#from-executable">From Executable</a></li>
3536
<li><a href="#with-systemd">With Systemd</a></li>
36-
<li><a href="#use-docker">Use Docker</a></li>
37+
<li><a href="#with-docker">With Docker</a></li>
3738
</ul>
3839
</li>
3940
</ul>
@@ -59,14 +60,15 @@ Yet another Nginx Web UI, developed by [0xJacky](https://jackyu.cn/) and [Hintay
5960
</ol>
6061
</details>
6162

63+
6264
## About The Project
6365

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

6668
### Demo
6769
URL:[https://nginxui.jackyu.cn](https://nginxui.jackyu.cn)
68-
- username:admin
69-
- password:admin
70+
- Username:admin
71+
- Password:admin
7072

7173
### Features
7274

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

8284
### Internationalization
8385

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

100102
### Before Use
101103

102-
The Nginx UI follows the Nginx standard of creating site configuration files in the `sites-available` directory under
103-
the Nginx configuration directory (auto-detected). The configuration files for an enabled site will create a soft link
104-
to the `sites-enabled` directory. Therefore, you may need to adjust the way the configuration files are organised.
104+
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.
105+
106+
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.
107+
108+
```nginx
109+
http {
110+
# ...
111+
include /etc/nginx/conf.d/*.conf;
112+
include /etc/nginx/sites-enabled/*;
113+
}
114+
```
115+
116+
For more information: [debian/conf/nginx.conf](https://salsa.debian.org/nginx-team/nginx/-/blob/master/debian/conf/nginx.conf#L59-L60)
105117

106118
### Installation
107119

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

162-
## Use Docker
174+
#### With Docker
163175

164-
Docker deploy example
165-
- `uozi/nginx-ui:latest` base on `nginx:latest`, you can replace the Nginx on host by publishing port 80 and 443 to host
176+
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.
166177

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

169-
```
180+
**Docker Deploy Example**
181+
182+
```bash
170183
docker run -dit \
171184
--name=nginx-ui \
172185
--restart=always \

0 commit comments

Comments
 (0)