Added English version of README. Restructuring the directory of resources.

This commit is contained in:
Hintay 2022-02-18 18:24:57 +08:00
parent 08b54b5bbb
commit 0cf6919d7b
No known key found for this signature in database
GPG key ID: 120FC7FF121F2F2D
11 changed files with 131 additions and 33 deletions

93
README-zh_CN.md Normal file
View file

@ -0,0 +1,93 @@
# Nginx UI
Yet another Nginx Web UI
Version: 1.1.0
[For English](README.md)
## 项目特色
1. 可在线查看服务器 CPU、内存、load average、磁盘使用率等指标
2. 可一键申请 Let's encrypt 证书
3. 可自动续签 Let's encrypt 证书
4. 在线编辑网站配置文件
## 项目预览
### 登录
![](resources/screenshots/login.png)
### 仪表盘
![](resources/screenshots/dashboard.png)
### 用户列表
![](resources/screenshots/user-list.png)
### 域名列表
![](resources/screenshots/domain-list.png)
### 域名编辑
![](resources/screenshots/domain-edit.png)
### 配置列表
![](resources/screenshots/config-list.png)
### 配置编辑
![](resources/screenshots/config-edit.png)
## 使用前注意
Nginx UI 遵循 Nginx 的标准,创建的网站配置文件位于 Nginx 配置目录(自动检测)下的 `sites-available` 目录,
启用后的网站的配置文件将会创建一份软连接到 `sites-enabled` 目录中。因此,您可能需要调整配置文件的组织方式。
## 安装
1. 克隆项目
```
git clone https://github.com/0xJacky/nginx-ui
```
2. 编译后端
```
cd server
go build -o nginx-ui-server main.go
```
3. 启动后端
1. 前台启动 `./nginx-ui-server`
2. 后台启动 `nohup ./nginx-ui-server &`
4. 添加配置文件到 nginx
```
server {
listen 80;
listen [::]:80;
server_name <your_server_name>;
rewrite ^(.*)$ https://$host$1 permanent;
}
server {
listen 443 ssl http2;
listen [::]:443 ssl http2;
server_name <your_server_name>;
ssl_certificate /path/to/ssl_cert;
ssl_certificate_key /path/to/ssl_cert_key;
location / {
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection upgrade;
proxy_pass http://127.0.0.1:9000/;
}
}
```
4. 初始化系统
在浏览器中访问 `https://<your_server_name>/install`
输入用户名和密码创建初始账户。

View file

@ -3,56 +3,60 @@ Yet another Nginx Web UI
Version: 1.1.0
## 项目特色
*Note: Currently only available in Simplified Chinese.*
1. 可在线查看服务器 CPU、内存、load average、磁盘使用率等指标
2. 可一键申请 Let's encrypt 证书
3. 可自动续签 Let's encrypt 证书
4. 在线编辑网站配置文件
[简体中文说明](README-zh_CN.md)
## 项目预览
## Features
### 登录
![](screenshots/login.png)
1. Online view of server CPU, Memory, Load Average, Disk Usage and other indicators.
2. One-click deployment Let's Encrypt certificates.
3. Automatic renewal Let's Encrypt certificates.
4. Online editing websites configuration files.
### 仪表盘
![](screenshots/dashboard.png)
## Screenshots
### 用户列表
![](screenshots/user-list.png)
### Login
![](resources/screenshots/login.png)
### 域名列表
![](screenshots/domain-list.png)
### Dashboard
![](resources/screenshots/dashboard.png)
### 域名编辑
![](screenshots/domain-edit.png)
### Users Management
![](resources/screenshots/user-list.png)
### 配置列表
![](screenshots/config-list.png)
### Domains Management
![](resources/screenshots/domain-list.png)
### 配置编辑
![](screenshots/config-edit.png)
### Domain Editor
![](resources/screenshots/domain-edit.png)
## 使用前注意
### Configurations Management
![](resources/screenshots/config-list.png)
Nginx UI 遵循 Nginx 的标准,创建的网站配置文件位于 Nginx 配置目录(自动检测)下的 `sites-available` 目录,
启用后的网站的配置文件将会创建一份软连接到 `sites-enabled` 目录中。因此,您可能需要调整配置文件的组织方式。
### Configuration Editor
![](resources/screenshots/config-edit.png)
## 安装
1. 克隆项目
## Note 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.
## Install
1. Clone
```
git clone https://github.com/0xJacky/nginx-ui
```
2. 编译后端
2. Compiling the backend
```
cd server
go build -o nginx-ui-server main.go
```
3. 启动后端
1. 前台启动 `./nginx-ui-server`
2. 后台启动 `nohup ./nginx-ui-server &`
3. Start up the backend
1. `./nginx-ui-server` for direct run.
2. `nohup ./nginx-ui-server &` for run as service.
4. 添加配置文件到 nginx
4. Adding a configuration file to nginx
```
server {
listen 80;
@ -84,8 +88,9 @@ server {
}
```
4. 初始化系统
4. Installation
在浏览器中访问 `https://<your_server_name>/install`
Visit `https://<your_server_name>/install` in your browser.
Enter your username and password to create initial account.
输入用户名和密码创建初始账户。

View file

Before

Width:  |  Height:  |  Size: 5.9 KiB

After

Width:  |  Height:  |  Size: 5.9 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 50 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 80 KiB

After

Width:  |  Height:  |  Size: 80 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 46 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 365 KiB

After

Width:  |  Height:  |  Size: 365 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 66 KiB

After

Width:  |  Height:  |  Size: 66 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 204 KiB

After

Width:  |  Height:  |  Size: 204 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 46 KiB

Before After
Before After