Skip to content

Commit b1ea269

Browse files
committed
Added the missing Traditional Chinese README.
1 parent adf1f07 commit b1ea269

File tree

3 files changed

+263
-2
lines changed

3 files changed

+263
-2
lines changed

README-zh_CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Nginx 网络管理界面,由 [0xJacky](https://jackyu.cn/) 与 [Hintay](https
6262

6363
## 关于项目
6464

65-
[![Dashboard](resources/screenshots/dashboard_zh_CN.png)]()
65+
![Dashboard](resources/screenshots/dashboard_zh_CN.png)
6666

6767
### 在线预览
6868
网址:[https://nginxui.jackyu.cn](https://nginxui.jackyu.cn)

README-zh_TW.md

Lines changed: 261 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,261 @@
1+
<div align="center">
2+
<img src="resources/logo.png" alt="Nginx UI Logo">
3+
</div>
4+
5+
# Nginx UI
6+
7+
Yet another Nginx Web UI
8+
9+
Nginx 網路管理介面,由 [0xJacky](https://jackyu.cn/)[Hintay](https://blog.kugeek.com/) 開發。
10+
11+
[![Build and Publish](https://github.com/0xJacky/nginx-ui/actions/workflows/build.yml/badge.svg)](https://github.com/0xJacky/nginx-ui/actions/workflows/build.yml)
12+
13+
[For English](README.md)
14+
15+
[简体中文](README-zh_CN.md)
16+
17+
<details>
18+
<summary>目錄</summary>
19+
<ol>
20+
<li>
21+
<a href="#關於專案">關於專案</a>
22+
<ul>
23+
<li><a href="#特色">特色</a></li>
24+
<li><a href="#國際化">國際化</a></li>
25+
<li><a href="#構建基於">構建基於</a></li>
26+
</ul>
27+
</li>
28+
<li>
29+
<a href="#入門指南">入門指南</a>
30+
<ul>
31+
<li><a href="#使用前注意">使用前注意</a></li>
32+
<li><a href="#安裝">安裝</a></li>
33+
<li>
34+
<a href="#使用方法">使用方法</a>
35+
<ul>
36+
<li><a href="#透過執行檔案執行">透過執行檔案執行</a></li>
37+
<li><a href="#使用-systemd">使用 Systemd</a></li>
38+
</ul>
39+
</li>
40+
</ul>
41+
</li>
42+
<li>
43+
<a href="#手動構建">手動構建</a>
44+
<ul>
45+
<li><a href="#依賴">依賴</a></li>
46+
<li><a href="#構建前端">構建前端</a></li>
47+
<li><a href="#構建後端">構建後端</a></li>
48+
</ul>
49+
</li>
50+
<li>
51+
<a href="#linux-安裝指令碼">Linux 安裝指令碼</a>
52+
<ul>
53+
<li><a href="#基本用法">基本用法</a></li>
54+
<li><a href="#更多用法">更多用法</a></li>
55+
</ul>
56+
</li>
57+
<li><a href="#nginx-反向代理配置示例">Nginx 反向代理配置示例</a></li>
58+
<li><a href="#貢獻">貢獻</a></li>
59+
<li><a href="#開源許可">開源許可</a></li>
60+
</ol>
61+
</details>
62+
63+
## 關於專案
64+
65+
![Dashboard](resources/screenshots/dashboard_zh_TW.png)
66+
67+
### 在线预览
68+
69+
网址:[https://nginxui.jackyu.cn](https://nginxui.jackyu.cn)
70+
71+
- 用户名:admin
72+
- 密码:admin
73+
74+
### 特色
75+
76+
- 線上檢視伺服器 CPU、記憶體、系統負載、磁碟使用率等指標
77+
- 一鍵申請和自動續簽 Let's encrypt 證書
78+
- 線上編輯 Nginx 配置檔案,編輯器支援 Nginx 配置語法高亮
79+
- 使用 Go 和 Vue 開發,發行版本為單個可執行的二進位制檔案
80+
- 前端支援暗夜模式
81+
82+
### 國際化
83+
84+
- 英語
85+
- 簡體中文
86+
- 繁體中文
87+
88+
我們歡迎您將專案翻譯成任何語言。
89+
90+
### 構建基於
91+
92+
- [The Go Programming Language](https://go.dev/)
93+
- [Gin Web Framework](https://gin-gonic.com)
94+
- [GORM](http://gorm.io/index.html)
95+
- [Vue 2](https://vuejs.org)
96+
- [vue-gettext](https://github.com/Polyconseil/vue-gettext)
97+
98+
## 入門指南
99+
100+
### 使用前注意
101+
102+
Nginx UI 遵循 Nginx 的標準,建立的網站配置檔案位於 Nginx 配置目錄(自動檢測)下的 `sites-available` 目錄,啟用後的網站的配置檔案將會建立一份軟連線到 `sites-enabled`目錄中。因此,您可能需要提前調整配置檔案的組織方式。
103+
104+
### 安裝
105+
106+
Nginx UI 可在以下平臺中使用:
107+
108+
- Mac OS X 10.10 Yosemite 及之後版本(amd64 / arm64)
109+
- Linux 2.6.23 及之後版本(x86 / amd64 / arm64)
110+
- 包括但不限於 Debian 7 / 8、Ubuntu 12.04 / 14.04 及後續版本、CentOS 6 / 7、Arch Linux
111+
- FreeBSD (x86 / amd64)
112+
- OpenBSD (x86 / amd64)
113+
- Dragonfly BSD (amd64)
114+
115+
您可以在 [最新發行 (latest release)](https://github.com/0xJacky/nginx-ui/releases/latest) 中下載最新版本,或使用 [Linux 安裝指令碼](#scripts-for-linux).
116+
117+
### 使用方法
118+
119+
第一次執行 Nginx UI 時,請在瀏覽器中訪問 `http://<your_server_ip>:<listen_port>/install` 完成後續配置。
120+
121+
#### 透過執行檔案執行
122+
**在終端中執行 Nginx UI**
123+
124+
```shell
125+
nginx-ui -config app.ini
126+
```
127+
在終端使用 `Control+C` 退出 Nginx UI。
128+
129+
**在後臺執行 Nginx UI**
130+
131+
```shell
132+
nohup ./nginx-ui -config app.ini &
133+
```
134+
使用以下命令停止 Nginx UI。
135+
136+
```shell
137+
kill -9 $(ps -aux | grep nginx-ui | grep -v grep | awk '{print $2}')
138+
```
139+
#### 使用 Systemd
140+
如果你使用的是 [Linux 安裝指令碼](#scripts-for-linux),Nginx UI 將作為 `nginx-ui` 服務安裝在 systemd 中。請使用 `systemctl` 命令控制。
141+
142+
**啟動 Nginx UI**
143+
144+
```shell
145+
systemctl start nginx-ui
146+
```
147+
**停止 Nginx UI**
148+
149+
```shell
150+
systemctl stop nginx-ui
151+
```
152+
**重啟 Nginx UI**
153+
154+
```shell
155+
systemctl restart nginx-ui
156+
```
157+
## 手動構建
158+
159+
對於沒有官方構建版本的平臺,可以嘗試手動構建。
160+
161+
### 依賴
162+
163+
- Make
164+
165+
- Golang 1.17+
166+
167+
- node.js 14+
168+
169+
```shell
170+
npx browserslist@latest --update-db
171+
```
172+
173+
### 構建前端
174+
175+
請在 `frontend` 目錄中執行以下命令。
176+
177+
```shell
178+
yarn install
179+
make translations
180+
yarn build
181+
```
182+
183+
### 構建後端
184+
185+
請先完成前端編譯,再回到專案的根目錄執行以下命令。
186+
187+
```shell
188+
go build -o nginx-ui -v main.go
189+
```
190+
191+
## Linux 安裝指令碼
192+
193+
### 基本用法
194+
195+
**安裝或升級**
196+
197+
```shell
198+
bash <(curl -L -s https://raw.githubusercontent.com/0xJacky/nginx-ui/master/install.sh) @ install
199+
```
200+
一鍵安裝指令碼預設設定的監聽埠為 `9000`,HTTP Challenge 埠預設為 `9180`,如果出現埠衝突請進入 `/usr/local/etc/nginx-ui/app.ini` 修改,並使用 `systemctl restart nginx-ui` 重啟 Nginx UI 服務。
201+
202+
**解除安裝 Nginx UI 但保留配置和資料庫檔案**
203+
204+
```shell
205+
bash <(curl -L -s https://raw.githubusercontent.com/0xJacky/nginx-ui/master/install.sh) @ remove
206+
```
207+
208+
### 更多用法
209+
210+
````shell
211+
bash <(curl -L -s https://raw.githubusercontent.com/0xJacky/nginx-ui/master/install.sh) @ help
212+
````
213+
214+
## Nginx 反向代理配置示例
215+
216+
```nginx
217+
server {
218+
listen 80;
219+
listen [::]:80;
220+
221+
server_name <your_server_name>;
222+
rewrite ^(.*)$ https://$host$1 permanent;
223+
}
224+
225+
server {
226+
listen 443 ssl http2;
227+
listen [::]:443 ssl http2;
228+
229+
server_name <your_server_name>;
230+
231+
ssl_certificate /path/to/ssl_cert;
232+
ssl_certificate_key /path/to/ssl_cert_key;
233+
234+
location / {
235+
proxy_set_header Host $host;
236+
proxy_set_header X-Real-IP $remote_addr;
237+
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
238+
proxy_set_header X-Forwarded-Proto $scheme;
239+
proxy_http_version 1.1;
240+
proxy_set_header Upgrade $http_upgrade;
241+
proxy_set_header Connection upgrade;
242+
proxy_pass http://127.0.0.1:9000/;
243+
}
244+
}
245+
```
246+
247+
## 貢獻
248+
249+
貢獻使開源社群成為學習、啟發和創造的絕佳場所。我們**非常感謝**您所做的任何貢獻。
250+
251+
如果您有讓這個專案變得更強的建議,歡迎 fork 這個倉庫並建立一個 Pull Request。您也可以建立一個帶有 `enhancement` (加強)標籤的 Issue。最後,不要忘記給我們的專案點個 Star!再次感謝!
252+
253+
1. Fork 專案
254+
2. 建立您的分支 (`git checkout -b feature/AmazingFeature`)
255+
3. 提交您的修改 (`git commit -m 'Add some AmazingFeature'`)
256+
4. 推送到您的分支 (`git push origin feature/AmazingFeature`)
257+
5. 建立一個 Pull Request
258+
259+
## 開源許可
260+
261+
此專案基於 GNU Affero Public License v3.0 (AGPLv3) 許可,請參閱 [LICENSE](LICENSE) 檔案。透過使用、分發或對本專案做出貢獻,表明您已同意本許可證的條款和條件。

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Yet another Nginx Web UI, developed by [0xJacky](https://jackyu.cn/) and [Hintay
6060

6161
## About The Project
6262

63-
[![Dashboard](resources/screenshots/dashboard_en.png)]()
63+
![Dashboard](resources/screenshots/dashboard_en.png)
6464

6565
### Demo
6666
URL:[https://nginxui.jackyu.cn](https://nginxui.jackyu.cn)

0 commit comments

Comments
 (0)