文档

功能说明

本项目可以使用MOTUI配置nginx的各项功能, 包括http协议转发, tcp协议转发, 反向代理, 负载均衡, ssl证书自动申请、续签、配置等, 最终生成nginx.conf文件并覆盖nginx的默认配置文件, 完成nginx的最终功能配置.

本项目可管理多个nginx服务器集群, 随时一键切换到对应服务器上进行nginx配置, 也可以一键将某台服务器配置同步到其他服务器, 方便集群管理

nginx本身功能复杂, 本项目并不能涵盖nginx所有功能, 只能配置常用功能, 更高级的功能配置仍然需要在最终生成的nginx.conf中进行手动编写。

部署此项目后, 配置nginx再也不用上网各种搜索, 再也不用手动申请和配置ssl证书, 只需要在本项目中进行增删改查就可方便的配置nginx。

技术说明

本项目是基于solon的web系统, 数据库使用h2, 因此服务器上不需要安装任何数据库

本系统通过Let's encrypt申请证书, 使用acme.sh脚本进行自动化申请和续签, 开启续签的证书将在每天凌晨2点进行续签, 只有超过60天的证书才会进行续签. 只支持在linux下签发证书.

添加tcp/ip转发配置支持时, 一些低版本的nginx可能需要重新编译，通过添加–with-stream参数指定安装stream模块才能使用, 但在ubuntu 18.04下, 官方软件库中的nginx已经带有stream模块, 不需要重新编译. 本系统如果配置了tcp转发项的话, 会自动引入ngx_stream_module.so的配置项, 如果没有开启则不引入, 最大限度优化ngnix配置文件.

jar安装说明

以Ubuntu操作系统为例

注意：本项目需要在root用户下运行系统命令，极容易被黑客利用，请一定修改密码为复杂密码

1.安装java运行环境和nginx

Ubuntu:

apt install openjdk-8-jdk
sudo apt install nginx

Centos:

yum install java-1.8.0-openjdk
yum install nginx

Windows:

下载JDK安装包 https://www.oracle.com/java/technologies/downloads/
配置JAVA运行环境
JAVA_HOME : JDK安装目录
Path : JDK安装目录\bin
重启电脑

2.下载最新版发行包jar

Linux: wget -O /home/nginxMOTUI/nginxMOTUI.jar http://file.nginxMOTUI.cn/nginxMOTUI-3.3.3.jar
Windows: 直接使用浏览器下载 http://file.nginxMOTUI.cn/nginxMOTUI-3.3.3.jar

有新版本只需要修改路径中的版本即可

3.启动程序

Linux: nohup java -jar -Dfile.encoding=UTF-8 /home/nginxMOTUI/nginxMOTUI.jar --server.port=8080 --project.home=/home/nginxMOTUI/ > /dev/null &
Windows: java -jar -Dfile.encoding=UTF-8 D:/home/nginxMOTUI/nginxMOTUI.jar --server.port=8080 --project.home=D:/home/nginxMOTUI/

参数说明(都是非必填)

--server.port 占用端口, 默认以8080端口启动

--project.home 项目配置文件目录，存放数据库文件，证书文件，日志等, 默认为/home/nginxMOTUI/

--spring.database.type=mysql 使用其他数据库，不填为使用本地h2，可选mysql

--spring.datasource.url=jdbc:mysql://ip:port/nginxMOTUI 数据库url

--spring.datasource.username=root 数据库用户

--spring.datasource.password=pass 数据库密码

注意Linux命令最后加一个&号, 表示项目后台运行

docker安装说明

本项目制作了docker镜像, 同时包含nginx和nginxMOTUI在内, 一体化管理与运行nginx.

1.安装docker容器环境

ubuntu:

apt install docker.io

centos:

yum install docker

2.下载镜像:

docker pull cym1102/nginxMOTUI:latest

启动容器:

docker run -itd -v /home/nginxMOTUI:/home/nginxMOTUI -e BOOT_OPTIONS="--server.port=8080" --privileged=true --net=host cym1102/nginxMOTUI:latest

注意:

启动容器时请使用--net=host参数, 直接映射本机端口, 因为内部nginx可能使用任意一个端口, 所以必须映射本机所有端口.

容器需要映射路径/home/nginxMOTUI:/home/nginxMOTUI, 此路径下存放项目所有数据文件, 包括数据库, nginx配置文件, 日志, 证书等, 升级镜像时, 此目录可保证项目数据不丢失. 请注意备份.

-e BOOT_OPTIONS 参数可填充java启动参数, 可以靠此项参数修改端口号, "--server.port 占用端口", 不填默认以8080端口启动

日志默认存放在/home/nginxMOTUI/log/nginxMOTUI.log

编译说明

1.使用maven编译打包

mvn clean package

2.使用docker构建镜像

docker build -t nginxMOTUI:3.5.0 .

接口开发

本系统提供http接口调用, 只要打开 http://xxx.xxx.xxx.xxx:8080/doc.html即可查看knife4j接口页面.

接口调用需要在header中添加token, 其中token的获取需要在管理员管理中, 打开用户的接口调用权限, 然后通过用户名密码调用获取token接口, 才能得到token, 然后在knife4j的文档管理中设置全局token.

找回密码

如果忘记了登录密码或没有保存两步验证二维码，可按如下教程重置密码和关闭两步验证.

1. 停止nginxMOTUI进程或停止docker容器运行

2. 使用找回密码参数运行nginxMOTUI.jar, docker用户需单独下载nginxMOTUI.jar运行此命令

java -jar nginxMOTUI.jar --project.home=/home/nginxMOTUI/ --project.findPass=true

--project.home 为项目文件所在目录, 使用docker容器时为映射目录

--project.findPass 为是否打印用户名密码

运行成功后即可重置并打印出全部用户名密码并关闭两步验证