1. 前言
为什么要学习这个项目
一直想为Nginx中网站的管理,找一个优美的后台。找到了就是这个项目。
而且这个项目中还有一个功能挺吸引我的,就是他能自动的为你的https证书续期。
但是免费也是有代价的。
从6月份使用到11月份,每次证书过期,系统都没有续期成功。导致网站无法访问。
所以必须要看一下代码了,不然真的没有底。
而且发现,这套系统的文档的确是不够详细。
2. 本地运行
项目地址:https://github.com/0xJacky/nginx-ui
2.1 编译并运行前端
cd app
npm install
npm run build //一定要做,因为服务端编译时需要dist目录
npm run dev
2.2 启动后端(需要linux)
下载第2项: tdm64-gcc-10.3.0-2.exe,然后一路next就可以
安装库
go mod tidy
编译
go build -tags=jsoniter -o nginx-ui -v main.go
生成配置
建一个文件app.ini
[server]
HttpPort = 9001
Host =
Port = 9001
RunMode = debug
运行
nginx-ui.exe -config app.ini
2.3 使用说明
第一次启动:
3. 项目说明
服务器是golang
前端是vue
3.1 cosy
服务器使用了作者自己写的cosy框架:github.com/uozi-tech/cosy
这个cosy是基于gin:https://github.com/gin-gonic/gin做了进一步的封装
为了方便调试,我把cosy也移到了项目中。修改了一下项目结构:参考:
ftyszyx/nginx-ui.git
3.2 risefront
https://pkg.go.dev/code.pfad.fr/risefront
服务器主入口是用这个库启动的
这个库好像是用来做热更新的
怎么实现的:
因为这个项目是基于overseer:https://github.com/jpillora/overseer
overseer这个主进程,为程序创建一个运行子进程
overseer
uses the main process to check for and install upgrades and a child process to runProgram
.
主进程会代理所有子进程的通信
参考文档:https://blog.csdn.net/flynetcn/article/details/134084549
3.3 sse
项目还用到一个sse
主要是服务器向客户端推送消息,但他是单向的
这里有介绍:
https://www.ruanyifeng.com/blog/2017/05/server-sent_events.html
服务器怎么实现的?
3.4 zaplog
项目使用zaplog来记录日志:
https://github.com/uber-go/zap
zaplog有两个日志记录器,一个是logger,一个是Sugared Logger
logger记录日志时,需要明确的类型。而sugaredlog不用。
nginx-ui为了方便记录日志,使用了sugared log
但sugar log默认不记录到文件。
所以需要加一个文件记录的功能
有两个第三方库:
一个是以时间来分割文件:
[github.com/lestrrat-go/file-rotatelogs](https://github.com/lestrrat-go/file-rotatelogs)
一个是文件大小分割。
gopkg.in/natefinch/lumberjack.v2
我还是使用时间分割吧。
import rotatelogs "github.com/lestrrat-go/file-rotatelogs"
l, _ **:=** rotatelogs.New(
filename **+**".%Y%m%d%H%M",
rotatelogs.WithMaxAge(30 *****24 *****time.Hour), _// 最长保存30天_ rotatelogs.WithRotationTime(time.Hour *****24), _// 24小时切割一次_)
zapcore.AddSync(l)
测试了一下的确可以,不过发现,日志文件中有不可见的字符
应该是console的颜色控制符
怎么去掉颜色字符
encoderConfig.EncodeLevel = colorLevelEncoder
改成
encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
完美
3.5 nginx的配置
3.5.1 站点列表
可以自定义配置
settings.NginxSettings.ConfigDir
3.6 证书的更新机制
/api/acme_users?
对应的数据层
在系统启动时会执行注册
使用了lego这个库
https://github.com/go-acme/lego
使用方法 如下:
https://go-acme.github.io/lego/usage/library/index.html
3.6.1 Acme
ACME是自动证书管理环境(Automatic Certificate Management Environment)的缩写,是一个由IETF(Internet Engineering Task Force)制定的协议标准,用于自动化证书颁发和管理。ACME协议的主要目的是使得证书颁发过程自动化、安全化和可扩展化,同时减少人工干预的成本和风险。
ACME协议的流程如下:
- 客户端向CA发送证书请求,并提供验证信息。
- CA验证客户端提供的信息,如果验证通过,则向客户端颁发一个签名证书。
- 客户端使用签名证书进行加密通信。
- 客户端定期更新证书,以保证证书的有效性。
Let’s Encrypt是一个免费的证书颁发机构,它支持ACME协议,并提供了Certbot客户端工具,可以自动化地申请、更新和管理SSL证书。Certbot客户端工具可以通过命令行工具或者Web界面进行操作。
3.7 Gorm
数据库是使用这个库
通过这个命令生成数据库的代码