{"id":13569281,"url":"https://github.com/cym1102/nginxWebUI","last_synced_at":"2025-04-04T05:31:53.203Z","repository":{"id":37747469,"uuid":"264408495","full_name":"cym1102/nginxWebUI","owner":"cym1102","description":"Nginx Web page configuration tool. Use web pages to quickly configure Nginx. Nginx网页管理工具，使用网页来快速配置与管理nginx单机与集群","archived":false,"fork":false,"pushed_at":"2024-09-07T09:58:55.000Z","size":95265,"stargazers_count":2305,"open_issues_count":3,"forks_count":354,"subscribers_count":32,"default_branch":"master","last_synced_at":"2024-10-29T15:26:10.448Z","etag":null,"topics":["java","layui","nginx"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cym1102.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-16T10:04:14.000Z","updated_at":"2024-10-29T11:03:07.000Z","dependencies_parsed_at":"2023-11-23T04:32:29.771Z","dependency_job_id":"92997114-f019-45d2-bdd0-dd16bf7421b1","html_url":"https://github.com/cym1102/nginxWebUI","commit_stats":{"total_commits":214,"total_committers":5,"mean_commits":42.8,"dds":0.02336448598130836,"last_synced_commit":"ab4c4402df97c15000ae9562ea1a28f1f1ccf447"},"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cym1102%2FnginxWebUI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cym1102%2FnginxWebUI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cym1102%2FnginxWebUI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cym1102%2FnginxWebUI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cym1102","download_url":"https://codeload.github.com/cym1102/nginxWebUI/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247014523,"owners_count":20869376,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["java","layui","nginx"],"created_at":"2024-08-01T14:00:38.068Z","updated_at":"2025-04-04T05:31:53.197Z","avatar_url":"https://github.com/cym1102.png","language":"HTML","readme":"# nginxWebUI\n\n### [README.md English version](README_EN.md)\n\n#### 介绍\nnginx网页配置工具\n\nQQ技术交流群1: 1106758598\n\nQQ技术交流群2: 560797506\n\n邮箱: cym1102@qq.com\n\n官网地址: [https://www.nginxwebui.cn](https://www.nginxwebui.cn)\n\n专业版地址: [https://pro.nginxwebui.cn](https://pro.nginxwebui.cn)\n\nGitee: [https://gitee.com/cym1102/nginxWebUI](https://gitee.com/cym1102/nginxWebUI)\n\nGithub: [https://github.com/cym1102/nginxWebUI](https://github.com/cym1102/nginxWebUI)\n\n视频教程: [https://www.bilibili.com/video/BV18A4y1D7GZ](https://www.bilibili.com/video/BV18A4y1D7GZ)\n\n微信捐赠二维码\n\n\u003cimg src=\"README/weixin.png\"  height=\"200\" width=\"200\"\u003e\n\n#### 功能说明\n\nnginxWebUI是一款图形化管理nginx配置得工具, 可以使用网页来快速配置nginx的各项功能, 包括http协议转发, tcp协议转发, 反向代理, 负载均衡, 静态html服务器, ssl证书自动申请、续签、配置等, 配置好后可一建生成nginx.conf文件, 同时可控制nginx使用此文件进行启动与重载, 完成对nginx的图形化控制闭环.\n\nnginxWebUI也可管理多个nginx服务器集群, 随时一键切换到对应服务器上进行nginx配置, 也可以一键将某台服务器配置同步到其他服务器, 方便集群管理.\n\nnginx本身功能复杂, nginxWebUI并不能涵盖nginx所有功能, 但能覆盖nginx日常90%的功能使用配置, 平台没有涵盖到的nginx配置项, 可以使用自定义参数模板, 在conf文件中生成配置独特的参数。\n\n部署此项目后, 配置nginx再也不用上网各种搜索配置代码, 再也不用手动申请和配置ssl证书, 只需要在本项目中进行增删改查就可方便的配置和启动nginx。\n\n#### 技术说明\n\n本项目是基于solon的web系统, 数据库使用sqlite, 因此服务器上不需要安装任何数据库\n\n本系统通过Let's encrypt申请证书, 使用acme.sh脚本进行自动化申请和续签, 开启续签的证书将在每天凌晨2点进行续签, 只有超过60天的证书才会进行续签. 只支持在linux下签发证书.\n\n添加tcp/ip转发配置支持时, 一些低版本的nginx可能需要重新编译，通过添加–with-stream参数指定安装stream模块才能使用, 但在ubuntu 18.04下, 官方软件库中的nginx已经带有stream模块, 不需要重新编译. 本系统如果配置了tcp转发项的话, 会自动引入ngx_stream_module.so的配置项, 如果没有开启则不引入, 最大限度优化ngnix配置文件. \n\n\n#### 专业版与开源版区别\n\n专业版地址: [https://pro.nginxwebui.cn](https://pro.nginxwebui.cn)\n\n| 功能         | 专业版        | 开源版        |\n| ----------- | ----------- | ----------- |\n| 基本参数配置       | √  | √ |\n| http参数配置      | √  | √ |\n| 反向代理配置       | √  | √ |\n| Stream参数配置    | √  | √ |\n| 负载均衡配置       | √  | √ |\n| 参数模板          | √  | √ |\n| 静态网页上传       | √  | √ |\n| 密码文件管理       | √  | √ |\n| 黑白名单IP        | √  | √ |\n| 证书申请          | √  | √ |\n| API接口文档       | √  | √ |\n| 远程管理          | √  | √ |\n| 节点及分组统一管理   | √  | × |\n| 节点配置文件统一同步 | √  | × |\n| 节点信息数据采集    | √  | × |\n| 节点状态统计       | √  | × |\n| 缓存配置         | √  | × |\n| nginx日志采集    | √  | × |\n| nginx日志查看    | √  | × |\n| nginx日志统计    | √  | × |\n| nginx流量统计    | √  | × |\n\n\n#### jar安装说明\n以Ubuntu操作系统为例,\n\n **注意：本项目需要在root用户下运行系统命令，极容易被黑客利用，请一定修改密码为复杂密码**\n\n1.安装java环境和nginx\n\nUbuntu:\n\n```\napt update\napt install openjdk-11-jdk\napt install nginx\n```\n\nCentos:\n\n```\nyum install java-11-openjdk\nyum install nginx\n```\n\nWindows:\n\n```\n下载JDK安装包 https://www.oracle.com/java/technologies/downloads/\n下载nginx http://nginx.org/en/download.html\n配置JAVA环境变量 \nJAVA_HOME : JDK安装目录\nPath : JDK安装目录\\bin\n重启电脑\n```\n\n\n2.下载最新版发行包jar\n\n```\nLinux: mkdir /home/nginxWebUI/ \n       wget -O /home/nginxWebUI/nginxWebUI.jar https://gitee.com/cym1102/nginxWebUI/releases/download/4.3.0/nginxWebUI-4.3.0.jar\n\nWindows: 直接使用浏览器下载 https://gitee.com/cym1102/nginxWebUI/releases/download/4.3.0/nginxWebUI-4.3.0.jar 到 D:/home/nginxWebUI/nginxWebUI.jar\n```\n\n有新版本只需要修改路径中的版本即可\n\n3.启动程序\n\n```\nLinux: nohup java -jar -Dfile.encoding=UTF-8 /home/nginxWebUI/nginxWebUI.jar --server.port=8080 --project.home=/home/nginxWebUI/ \u003e /dev/null \u0026\n\nWindows: java -jar -Dfile.encoding=UTF-8 D:/home/nginxWebUI/nginxWebUI.jar --server.port=8080 --project.home=D:/home/nginxWebUI/\n```\n\n参数说明(都是非必填)\n\n--server.port 占用端口, 默认以8080端口启动\n\n--project.home 项目配置文件目录，存放数据库文件，证书文件，日志等, 默认为/home/nginxWebUI/\n\n--spring.database.type=mysql 使用其他数据库，不填为使用本地sqlite数据库，可选mysql\n\n--spring.datasource.url=jdbc:mysql://ip:port/nginxwebui 数据库url\n\n--spring.datasource.username=root  数据库用户\n\n--spring.datasource.password=pass  数据库密码\n\n--initAdmin=admin 初始用户名\n\n--initPass=admin 初始用户密码\n\n--initApi=true 初始用户开启api权限\n\n注意Linux命令最后加一个\u0026号, 表示项目后台运行\n\n#### docker安装说明\n\n本项目制作了docker镜像, 支持 x86_64/arm64/arm v7 平台，同时包含nginx和nginxWebUI在内, 一体化管理与运行nginx. \n\n1.安装docker容器环境\n\nUbuntu:\n\n```\napt install docker.io\n```\n\nCentos:\n\n```\nyum install docker\n```\n\n2.拉取镜像: \n\n```\ndocker pull cym1102/nginxwebui:latest\n\n或者\n\ndocker pull registry.cn-hangzhou.aliyuncs.com/cym19871102/nginxwebui:latest\n```\n\n3.启动容器: \n\n```\ndocker run -itd \\\n  -v /home/nginxWebUI:/home/nginxWebUI \\\n  -e BOOT_OPTIONS=\"--server.port=8080\" \\\n  --net=host \\\n  --restart=always \\\n  cym1102/nginxwebui:latest\n  \n或者\n\ndocker run -itd \\\n  -v /home/nginxWebUI:/home/nginxWebUI \\\n  -e BOOT_OPTIONS=\"--server.port=8080\" \\\n  --net=host \\\n  --restart=always \\\n  registry.cn-hangzhou.aliyuncs.com/cym19871102/nginxwebui:latest\n```\n\n注意: \n\n1. 启动容器时请使用--net=host参数, 直接映射本机端口, 因为内部nginx可能使用任意一个端口, 所以必须映射本机所有端口. \n\n2. 容器需要映射路径/home/nginxWebUI:/home/nginxWebUI, 此路径下存放项目所有数据文件, 包括数据库, nginx配置文件, 日志, 证书等, 升级镜像时, 此目录可保证项目数据不丢失. 请注意备份.\n\n3. -e BOOT_OPTIONS 参数可填充java启动参数, 可以靠此项参数修改端口号\n\n--server.port 占用端口, 不填默认以8080端口启动\n\n4. 日志默认存放在/home/nginxWebUI/log/nginxWebUI.log\n\n另: 使用docker-compose时配置文件如下\n\n```\nversion: \"3.2\"\nservices:\n  nginxWebUi-server:\n    image: cym1102/nginxwebui:latest\n    volumes:\n      - type: bind\n        source: \"/home/nginxWebUI\"\n        target: \"/home/nginxWebUI\"\n    environment:\n      BOOT_OPTIONS: \"--server.port=8080\"\n    network_mode: \"host\"\n    restart: always\n\n或者\n\nversion: \"3.2\"\nservices:\n  nginxWebUi-server:\n    image: registry.cn-hangzhou.aliyuncs.com/cym19871102/nginxwebui:latest\n    volumes:\n      - type: bind\n        source: \"/home/nginxWebUI\"\n        target: \"/home/nginxWebUI\"\n    environment:\n      BOOT_OPTIONS: \"--server.port=8080\"\n    network_mode: \"host\"\n    restart: always\n```\n\n\n#### 编译说明\n\n使用maven编译打包\n\n```\nmvn clean package\n```\n\n使用docker构建镜像\n\n```\ndocker build -t nginxwebui:latest .\n```\n\n#### 添加开机启动\n\n\n1. 编辑service配置\n\n```\nvim /etc/systemd/system/nginxwebui.service\n```\n\n```\n[Unit]\nDescription=NginxWebUI\nAfter=syslog.target\nAfter=network.target\n \n[Service]\nType=simple\nUser=root\nGroup=root\nWorkingDirectory=/home/nginxWebUI\nExecStart=/usr/bin/java -jar -Dfile.encoding=UTF-8 /home/nginxWebUI/nginxWebUI.jar\nRestart=always\n \n[Install]\nWantedBy=multi-user.target\n```\n\n之后执行\n\n```\nsystemctl daemon-reload\nsystemctl enable nginxwebui.service\nsystemctl start nginxwebui.service\n```\n\n#### 使用说明\n\n打开 http://xxx.xxx.xxx.xxx:8080 进入主页\n\n![输入图片说明](README/login.jpeg \"login.jpg\")\n\n登录页面, 第一次打开会要求初始化管理员账号\n\n![输入图片说明](README/admin.jpeg \"admin.jpg\")\n\n进入系统后, 可在管理员管理里面添加修改管理员账号\n\n![输入图片说明](README/http.jpeg \"http.jpg\")\n\n在http参数配置中可以配置nginx的http项目,进行http转发, 默认会给出几个常用配置, 其他需要的配置可自由增删改查. 可以勾选开启日志跟踪, 生成日志文件。\n\n![输入图片说明](README/tcp.jpeg \"tcp.jpg\")\n\n在TCP参数配置中可以配置nginx的stream项目参数, 大多数情况下可不配.\n\n![输入图片说明](README/server.jpeg \"server.jpg\")\n\n在反向代理中可配置nginx的反向代理即server项功能, 可开启ssl功能, 可以直接从网页上上传pem文件和key文件, 或者使用系统内申请的证书, 可以直接开启http转跳https功能，也可开启http2协议\n\n![输入图片说明](README/upstream.jpeg \"upstream.jpg\")\n\n在负载均衡中可配置nginx的负载均衡即upstream项功能, 在反向代理管理中可选择代理目标为配置好的负载均衡\n\n![输入图片说明](README/html.jpeg \"html.jpg\")\n\n在html静态文件上传中可直接上传html压缩包到指定路径,上传后可直接在反向代理中使用,省去在Linux中上传html文件的步骤\n\n![输入图片说明](README/cert.jpeg \"cert.jpg\")\n\n在证书管理中可添加证书, 并进行签发和续签, 开启定时续签后, 系统会自动续签即将过期的证书, 注意:证书的签发是用的acme.sh的dns模式, 需要配合阿里云的aliKey和aliSecret来使用. 请先申请好aliKey和aliSecret\n\n![输入图片说明](README/bak.jpeg \"bak.jpg\")\n\n备份文件管理, 这里可以看到nginx.cnf的备份历史版本, nginx出现错误时可以选择回滚到某一个历史版本\n\n![输入图片说明](README/conf.jpeg \"conf.jpg\")\n\n最终生成conf文件,可在此进行进一步手动修改,确认修改无误后,可覆盖本机conf文件,并进行效验和重启, 可以选择生成单一nginx.conf文件还是按域名将各个配置文件分开放在conf.d下\n \n![输入图片说明](README/remote.jpeg \"remote.jpg\")\n\n远程服务器管理, 如果有多台nginx服务器, 可以都部署上nginxWebUI, 然后登录其中一台, 在远程管理中添加其他服务器的ip和用户名密码, 就可以在一台机器上管理所有的nginx服务器了.\n\n提供一键同步功能, 可以将某一台服务器的数据配置和证书文件同步到其他服务器中\n\n#### 接口开发\n\n本系统提供http接口调用, 打开 http://xxx.xxx.xxx.xxx:8080/doc.html 即可查看smart-doc接口页面.\n\n接口调用需要在http请求header中添加token, 其中token的获取需要先在管理员管理中, 打开用户的接口调用权限, 然后通过用户名密码调用获取token接口, 才能得到token \n\n![输入图片说明](README/smart-doc.png \"smart-doc.png\")\n\n#### 找回密码\n\n如果忘记了登录密码或没有保存两步验证二维码，可按如下教程重置密码和关闭两步验证.\n\n1.jar安装方式, 执行命令\n\n```\njava -jar /home/nginxWebUI/nginxWebUI.jar --project.home=/home/nginxWebUI/ --project.findPass=true\n```\n\n--project.home 为项目文件所在目录, 使用docker容器时为映射目录\n\n--project.findPass 为是否打印用户名密码\n\n运行成功后即可重置并打印出全部用户名密码并关闭两步验证\n\n2.docker安装方式, 首先执行进入docker容器的命令, 其中{ID}为容器的id\n\n```\ndocker exec -it {ID} /bin/sh\n```\n\n再执行命令\n\n```\njava -jar /home/nginxWebUI.jar --project.findPass=true\n```\n\n运行成功后即可重置并打印出全部用户名密码并关闭两步验证","funding_links":[],"categories":["HTML"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcym1102%2FnginxWebUI","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcym1102%2FnginxWebUI","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcym1102%2FnginxWebUI/lists"}