nginx-ui  by 0xJacky

WebUI for Nginx management

Created 4 years ago
9,543 stars

Top 5.3% on SourcePulse

GitHubView on GitHub
Project Summary

This project provides a comprehensive Web UI for managing Nginx configurations, targeting system administrators and DevOps engineers. It simplifies Nginx setup, monitoring, and maintenance with features like automated backups, cluster management, and an integrated AI assistant for configuration optimization.

How It Works

Built with Go and Vue.js, Nginx UI compiles into a single executable binary. It interacts with Nginx by managing configuration files in the standard Debian format (sites-available, sites-enabled) and automatically testing configurations before reloading Nginx. Key features include an online NgxConfigEditor for user-friendly configuration editing, an AI assistant for optimization, and Let's Encrypt integration for certificate management.

Quick Start & Requirements

  • Install/Run: Download latest release binary or use Linux install script (bash -c "$(curl -L https://raw.githubusercontent.com/0xJacky/nginx-ui/main/install.sh)" @ install). Docker images are also available.
  • Prerequisites: Nginx must be installed and configured to follow Debian standards (e.g., include /etc/nginx/sites-enabled/*;). For manual builds: Go 1.23+, Node.js 21+.
  • Setup: Single binary execution is straightforward. Docker setup involves mapping volumes for Nginx configuration and data.
  • Docs: nginxui.com
  • Demo: demo.nginxui.com (admin/admin)

Highlighted Details

  • AI assistant supports multiple models, including Deepseek-R1, for configuration optimization.
  • Cluster management allows mirroring operations across multiple Nginx nodes.
  • Includes an NgxConfigEditor with LLM code completion and syntax highlighting.
  • Supports one-click Let's Encrypt certificate deployment and automatic renewal.

Maintenance & Community

The project is actively developed by 0xJacky, Hintay, and Akino. Translations are managed via Weblate.

Licensing & Compatibility

Licensed under GNU Affero General Public License v3.0 (AGPL-3.0). This is a strong copyleft license, requiring derivative works to also be open-sourced under AGPL-3.0. Commercial use or linking with closed-source applications may require careful consideration of license obligations.

Limitations & Caveats

The project follows Debian Nginx configuration standards, which may require adjustments for non-Debian-based systems. The AGPL-3.0 license has significant implications for commercial use and integration into proprietary software.

Health Check
Last Commit

22 hours ago

Responsiveness

1 day

Pull Requests (30d)
16
Issues (30d)
28
Star History
273 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.