mirror of
https://github.com/0xJacky/nginx-ui.git
synced 2025-05-11 02:15:48 +02:00
update README.md
This commit is contained in:
parent
d3a322c71e
commit
16a3d02d9c
2 changed files with 32 additions and 46 deletions
|
@ -12,6 +12,7 @@ Version: 1.2.0
|
|||
2. 可一键申请和自动续签 Let's encrypt 证书
|
||||
3. 在线编辑 Nginx 配置文件,编辑器支持 Nginx 配置语法高亮
|
||||
4. 使用 Go 和 Vue 开发,发行版本为单个可执行的二进制文件
|
||||
5. 支持简体中文和英语
|
||||
|
||||
## 项目预览
|
||||
|
||||
|
@ -48,18 +49,12 @@ Nginx UI 遵循 Nginx 的标准,创建的网站配置文件位于 Nginx 配置
|
|||
## 安装
|
||||
### 平台支持
|
||||
Nginx UI 可在以下平台中可用:
|
||||
|
||||
Mac OS X 10.10 Yosemite 及之后版本(amd64 / arm64);
|
||||
|
||||
Linux 2.6.23 及之后版本(x86 / amd64 / arm64);
|
||||
|
||||
包括但不限于 Debian 7 / 8、Ubuntu 12.04 / 14.04 及后续版本、CentOS 6 / 7、Arch Linux;
|
||||
|
||||
FreeBSD (x86 / amd64);
|
||||
|
||||
OpenBSD (x86 / amd64);
|
||||
|
||||
Dragonfly BSD (amd64);
|
||||
- Mac OS X 10.10 Yosemite 及之后版本(amd64 / arm64);
|
||||
- Linux 2.6.23 及之后版本(x86 / amd64 / arm64);
|
||||
- 包括但不限于 Debian 7 / 8、Ubuntu 12.04 / 14.04 及后续版本、CentOS 6 / 7、Arch Linux;
|
||||
- FreeBSD (x86 / amd64);
|
||||
- OpenBSD (x86 / amd64);
|
||||
- Dragonfly BSD (amd64);
|
||||
|
||||
您可以在 [latest release](https://github.com/0xJacky/nginx-ui/releases/latest) 中下载最新发行版本
|
||||
|
||||
|
|
59
README.md
59
README.md
|
@ -4,28 +4,18 @@ Yet another Nginx Web UI
|
|||
|
||||
Version: 1.2.0
|
||||
|
||||
*Note: Currently only available in Simplified Chinese.*
|
||||
|
||||
[简体中文说明](README-zh_CN.md)
|
||||
|
||||
## Features
|
||||
|
||||
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.
|
||||
|
||||
## Install
|
||||
```shell
|
||||
curl -OL https://raw.githubusercontent.com/0xJacky/nginx-ui/master/install.sh && chmod +x install.sh && ./install.sh
|
||||
```
|
||||
2. One-click deployment and automatic renewal Let's Encrypt certificates.
|
||||
3. Online editing websites configuration files, online editor support highlight nginx configuration syntax.
|
||||
4. Written in Go and Vue, distribution is a single executable binary.
|
||||
5. Support English and Simplified Chinese.
|
||||
|
||||
## Screenshots
|
||||
|
||||
### Login
|
||||
|
||||

|
||||
|
||||
### Dashboard
|
||||
|
||||

|
||||
|
@ -58,25 +48,30 @@ to the `sites-enabled` directory. Therefore, you may need to adjust the way the
|
|||
|
||||
## Install
|
||||
|
||||
1. Clone
|
||||
Nginx UI is available on the following platforms:
|
||||
- Mac OS X 10.10 Yosemite and later(amd64 / arm64);
|
||||
- Linux 2.6.23 and later(x86 / amd64 / arm64);
|
||||
- Including but not limited to Debian 7 / 8、Ubuntu 12.04 / 14.04 and later、CentOS 6 / 7、Arch Linux;
|
||||
- FreeBSD (x86 / amd64);
|
||||
- OpenBSD (x86 / amd64);
|
||||
- Dragonfly BSD (amd64);
|
||||
|
||||
You can visit [latest release](https://github.com/0xJacky/nginx-ui/releases/latest) to download the latest distribution.
|
||||
|
||||
### One-click installation shell for Linux
|
||||
```shell
|
||||
bash <(curl -L -s https://raw.githubusercontent.com/0xJacky/nginx-ui/master/install.sh)
|
||||
```
|
||||
git clone https://github.com/0xJacky/nginx-ui
|
||||
```
|
||||
The default listing port set by one-click install shell is `9000`
|
||||
while HTTP challenge port is `9180`,
|
||||
|
||||
2. Compiling the backend
|
||||
If a port conflict occurs, please modify `/usr/local/etc/nginx-ui/app.ini` manually,
|
||||
and use `systemctl restart nginx-ui` to reload the Nginx UI service.
|
||||
|
||||
```
|
||||
cd server
|
||||
go build -o nginx-ui-server main.go
|
||||
```
|
||||
|
||||
3. Start up the backend
|
||||
1. `./nginx-ui-server` for direct run.
|
||||
2. `nohup ./nginx-ui-server &` for run as service.
|
||||
|
||||
4. Adding a configuration file to nginx
|
||||
Once the service start successfully, please visit `http://<your_server_ip>:9000/install`
|
||||
in your browser to complete the follow-up configurations.
|
||||
|
||||
### Example of Nginx reverse proxy configuration
|
||||
```
|
||||
server {
|
||||
listen 80;
|
||||
|
@ -108,9 +103,5 @@ server {
|
|||
}
|
||||
```
|
||||
|
||||
4. Installation
|
||||
|
||||
Visit `https://<your_server_name>/install` in your browser.
|
||||
|
||||
Enter your username and password to create initial account.
|
||||
|
||||
## About
|
||||
Nginx UI developed by [0xJacky](https://jackyu.cn/) and [Hintay](https://blog.kugeek.com/).
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue