## 前言 近期在服务器上配的一些小东西 最近时间稍微多了些，便又开始捣鼓我那迷你服务器，算是有些成果陆陆续续搭建了几个新的服务在博客里。 ## 服务列表 ### `nginxWebUI` - `nginx`网页配置工具 - QQ技术交流群: `1106758598` - 官网地址: `http://www.nginxwebui.cn` - 源码地址：`https://git.chihiro.org.cn/chihiro/nginxWebUI` #### 功能说明 本项目可以使用`WebUI`配置`nginx`的各项功能, 包括`http`协议转发, `tcp`协议转发, 反向代理, 负载均衡, `ssl`证书自动申请、续签、配置等, 最终生成`nginx.conf`文件并覆盖`nginx`的默认配置文件, 完成`nginx`的最终功能配置。 本项目可管理多个`nginx`服务器集群, 随时一键切换到对应服务器上进行`nginx`配置, 也可以一键将某台服务器配置同步到其他服务器, 方便集群管理。 `nginx`本身功能复杂, 本项目并不能涵盖`nginx`所有功能, 只能配置常用功能, 更高级的功能配置仍然需要在最终生成的`nginx.conf`中进行手动编写。 部署此项目后, 配置`nginx`再也不用上网各种搜索, 再也不用手动申请和配置`ssl`证书, 只需要在本项目中进行增删改查就可方便的配置`nginx`。 #### 技术说明 本项目是基于`springBoot`的`web`系统, 数据库使用`sqlite`, 因此服务器上不需要安装任何数据库。 其中`orm`使用了本人自己开源的`sqlHelper`项目作为`orm`, 使用`sqlite`作为数据库, 项目启动时会释放一个`.sqlite.db`到系统用户文件夹中, 注意进行备份。 > `sqlHelper`是一个可以像mongodb一样使用sql数据库的orm, 解放开发者对`sql`数据库表结构的维护工作, 支持`sqlite`, `mysql`, `postgresql`三种数据库, 有兴趣的可以了解一下 `https://gitee.com/cym1102/sqlHelper`。 本系统通过`Let's encrypt`申请证书, 使用`acme.sh`脚本进行自动化申请和续签, 开启续签的证书将在每天凌晨2点进行续签, 只有超过60天的证书才会进行续签. 只支持在`linux`下签发证书。 因为申请证书必须要使用80端口, 因此在申请和续签的时候nginx将会短暂关闭，请注意。 添加`tcp/ip`转发配置支持时, 一些低版本的nginx可能需要重新编译，通过添加`–with-stream`参数指定安装`stream`模块才能使用, 但在`ubuntu 18.04`下, 官方软件库中的`nginx`已经带有`stream`模块, 不需要重新编译. 本系统如果配置了`tcp`转发项的话, 会自动引入`ngx_stream_module.so`的配置项, 如果没有开启则不引入, 最大限度优化`ngnix`配置文件。 #### jar安装说明 以`Ubuntu`操作系统为例, 以下命令请使用`root`账户权限执行 **注意：本项目需要在`root`用户下运行系统命令，极容易被黑客利用，请一定修改密码为复杂密码** 1.安装`java`运行环境和`nginx` ```bash apt install openjdk-8-jdk apt install nginx ``` 2.下载最新版发行包`jar` ```bash wget http://www.nginxwebui.cn/download/nginxWebUI-1.7.3.jar ``` 有新版本只需要修改路径中的版本即可 3.启动程序 ```bash nohup java -jar -Xmx64m nginxWebUI-1.7.3.jar --server.port=8080 --project.home=/home/nginxWebUI/ > /dev/null & ``` 参数说明(都是非必填) `-Xmx64m` 最大分配内存数 `--server.port` 占用端口, 默认以8080端口启动 `--project.home` 项目配置文件目录，存放数据库文件，证书文件，日志等, 默认为`/home/nginxWebUI/` 注意命令最后加一个`&`号, 表示项目后台运行 #### `docker`安装说明 本项目制作了`docker`镜像, 同时包含`nginx`和`nginxWebUI`在内, 一体化管理与运行`nginx`. 1.安装`docker`容器环境 ```bash apt install docker.io ``` 2.下载镜像: ```bash docker pull registry.cn-hangzhou.aliyuncs.com/cym1102/nginxwebui:1.7.3 ``` 3. 启动容器: ```bash docker run -itd -v /home/nginxWebUI:/home/nginxWebUI -e BOOT_OPTIONS="--变量名=变量值 --变量名2=变量值2" --privileged=true --net=host registry.cn-hangzhou.aliyuncs.com/cym1102/nginxwebui:1.7.3 /bin/bash ``` > 注意: > 1. 启动容器时请使用`--net=host`参数, 直接映射本机端口, 因为内部`nginx`可能使用任意一个端口, 所以必须映射本机所有端口. > 2. 容器需要映射路径`/home/nginxWebUI:/home/nginxWebUI`, 此路径下存放项目所有数据文件, 包括数据库, `nginx`配置文件, 日志, 证书等, 升级镜像时, 此目录可保证项目数据不丢失. 请注意备份. > 3. `-e BOOT_OPTIONS` 参数可填充`java`启动参数, `jar`安装教程中的参数均可使用, 可以靠此项参数修改端口号等 > 4. 日志默认存放在`/home/nginxWebUI/log/nginxWebUI.log` #### `docker-compose`安装说明 博主整理出了`docker-compsoe`安装此nginx可视化界面的文件。 `docker-compose.yaml`文件如下 ```yml version: '3' services: nginxwebui: image: registry.cn-hangzhou.aliyuncs.com/cym1102/nginxwebui:1.7.3 container_name: nginxwebui restart: always volumes: - ./data:/home/nginxWebUI environment: - BOOT_OPTIONS==-Xmx64m - TZ=Asia/shanghai privileged: true network_mode: "host" ``` > 注意：项目下所有数据储存在`yaml`文件同目录下的`data`文件夹中。 #### 使用说明 打开 `http://xxx.xxx.xxx.xxx:8080` 进入主页  登录页面, 第一次打开会要求初始化管理员账号  进入系统后, 可在管理员管理里面添加修改管理员账号  在`http`参数配置中可以配置`nginx`的`http`项目,进行`http`转发, 默认会给出几个常用配置, 其他需要的配置可自由增删改查. 可以勾选开启日志跟踪, 生成日志跟踪配置项, 每天0点时刻可生成上一天的日志分析报告. 由于日志文件`access.log`文件过大, 默认只保留7天的`log`文件, 但分析报告可一直保留.  在TCP参数配置中可以配置`nginx`的`steam`项目参数, 大多数情况下可不配.  在反向代理中可配置`nginx`的反向代理即`server`项功能, 可开启`ssl`功能, 可以直接从网页上上传`pem`文件和`key`文件, 或者使用系统内申请的证书, 可以直接开启`http`转跳`https`功能，也可开启`http2`协议  在负载均衡中可配置`nginx`的负载均衡即`upstream`项功能, 在反向代理管理中可选择代理目标为配置好的负载均衡  在`html`静态文件上传中可直接上传`html`压缩包到指定路径,上传后可直接在反向代理中使用,省去在`Linux`中上传`html`文件的步骤  在证书管理中可添加证书, 并进行签发和续签, 开启定时续签后, 系统会自动续签即将过期的证书。 > 注意:证书的签发是用的`acme.sh`的`dns`模式, 需要配合阿里云的`aliKey`和`aliSecret`来使用. 请先申请好`aliKey`和`aliSecret`  备份文件管理, 这里可以看到`nginx.cnf`的备份历史版本, `nginx`出现错误时可以选择回滚到某一个历史版本  最终生成`conf`文件,可在此进行进一步手动修改,确认修改无误后,可覆盖本机`conf`文件,并进行效验和重启, 可以选择生成单一`nginx.conf`文件还是按域名将各个配置文件分开放在`conf.d`下  `log`管理, 在`http`配置中如果开启了`log`监控的话, 会每天在这里生成日志分析报告.  远程服务器管理, 如果有多台`nginx`服务器, 可以都部署上`nginxWebUI`, 然后登录其中一台, 在远程管理中添加其他服务器的`ip`和用户名密码, 就可以在一台机器上管理所有的`nginx`服务器了. 提供一键同步功能, 可以将某一台服务器的数据配置和证书文件同步到其他服务器中 #### 找回密码 如果忘记了登录密码，可按如下教程找回密码 1. 安装`sqlite3`命令 ```bash apt install sqlite3 ``` 2. 读取`sqlite.db`文件 ```bash sqlite3 /home/nginxWebUI/sqlite.db ``` 3. 查找`admin`表 ```bash select * from admin; ``` 4. 退出`sqlite3` ```bash quit ``` ## 后记 博主代码原地址：[点我达](https://gitee.com/cym1102/nginxWebUI)