<div align="center"> <img src="resources/logo.png" alt="Nginx UI Logo"> </div>

Nginx UI

Yet another Nginx Web UI, developed by 0xJacky, Hintay and Akino.

<p> <a href="https://atomgit.com/uozi/nginx-ui" target="_blank" title="This project is part of the AtomGit G-Star program"> <img src="resources/atomgit-logo.svg" alt="AtomGit" height="20" align="middle"> </a> &nbsp;Proudly hosted on <a href="https://atomgit.com/uozi/nginx-ui">AtomGit</a> — a part of the <b>G-Star</b> program. </p>

Documentation

To check out docs, visit nginxui.com.

Sponsor

If you find this project helpful, please consider sponsoring us to support ongoing development and maintenance.

Sponsors

<a href="https://www.axisnow.io/" target="_blank"> <img src="resources/axisnow-logo.png" alt="AxisNow" width="220px"> </a>

Protect and accelerate websites and APIs with consistent access performance across mainland China and worldwide, and extend acceleration and security to native and mobile apps through client SDKs — Self-hosted private CDN｜Subscription-based anti-DDoS CDN｜A self-controlled, flexibly composable CDN network.

Official Community Group

Join the official Nginx UI WeChat community group to discuss usage, deployment ideas, and troubleshooting with other community members.

Scan the QR code below to add us on WeChat, and include Nginx UI Community Group in your request. The administrator will invite you to the official community group.

<p align="center"> <img src="docs/public/assets/wechat-community-qr.png" alt="Nginx UI WeChat Community QR Code" width="320"> </p>

Your support helps us:

• 🚀 Accelerate the development of new features
• 🐛 Fix bugs and improve stability
• 📚 Enhance documentation and tutorials
• 🌐 Provide better community support
• 💻 Maintain infrastructure and demo servers

Tooling Support

<a href="https://www.jetbrains.com/?from=nginx-ui" target="_blank"> <img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg" alt="JetBrains Logo" width="200px"> </a>

Thanks to JetBrains for supporting us with free open source licenses.

Stargazers over time

English | Español | 简体中文 | 繁體中文 | Tiếng Việt | 日本語

<details> <summary>Table of Contents</summary> <ol> <li> <a href="#about-the-project">About The Project</a> <ul> <li><a href="#demo">Demo</a></li> <li><a href="#features">Features</a></li> <li><a href="#internationalization">Internationalization</a></li> </ul> </li> <li> <a href="#getting-started">Getting Started</a> <ul> <li><a href="#before-use">Before Use</a></li> <li><a href="#installation">Installation</a></li> <li> <a href="#usage">Usage</a> <ul> <li><a href="#from-executable">From Executable</a></li> <li><a href="#with-systemd">With Systemd</a></li> <li><a href="#with-docker">With Docker</a></li> </ul> </li> </ul> </li> <li> <a href="#manual-build">Manual Build</a> <ul> <li><a href="#prerequisites">Prerequisites</a></li> <li><a href="#build-app">Build Frontend</a></li> <li><a href="#build-backend">Build Backend</a></li> </ul> </li> <li> <a href="#script-for-linux">Script for Linux</a> <ul> <li><a href="#basic-usage">Basic Usage</a></li> <li><a href="#more-usage">More Usage</a></li> </ul> </li> <li><a href="#example-of-nginx-reverse-proxy-configuration">Example of Nginx Reverse Proxy Configuration</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> </ol> </details>

About The Project

Demo

URL：https://demo.nginxui.com

• Username：admin
• Password：admin

Features

• Online statistics for server indicators such as CPU usage, memory usage, load average, and disk usage.
• Automatic configuration backup after changes, with version comparison and restore capabilities
• Cluster management supporting mirroring operations to multiple nodes, making multi-server environments easy to manage
• Export encrypted Nginx / Nginx UI configurations for quick deployment and recovery to new environments
• Enhanced online ChatGPT assistant supporting multiple models, including Deepseek-R1's chain-of-thought display to help you better understand and optimize configurations
• MCP (Model Context Protocol) provides special interfaces for AI agents to interact with Nginx UI, enabling automated configuration management and service control.
• One-click deployment and automatic renewal Let's Encrypt certificates.
• Online editing websites configurations with our self-designed NgxConfigEditor which is a user-friendly block editor for nginx configurations or Ace Code Editor which supports LLM Code Completion and highlighting nginx configuration syntax.
• Online view Nginx logs
• Written in Go and Vue, distribution is a single executable binary.
• Automatically test configuration file and reload nginx after saving configuration.
• Web Terminal
• Dark Mode
• Responsive Web Design

Internationalization

We proudly offer official support for:

• English
• Simplified Chinese
• Traditional Chinese

As non-native English speakers, we strive for accuracy, but we know there's always room for improvement. If you spot any issues, we'd love your feedback!

Thanks to our amazing community, additional languages are also available! Explore and contribute to translations on Weblate.

Getting Started

Before Use

The Nginx UI follows the Debian web server configuration file standard. Created site configuration files will be placed in the sites-available folder that under the Nginx configuration folder (auto-detected). The configuration files for an enabled site will create a soft link to the sites-enabled folder. You may need to adjust the way the configuration files are organised.

For non-Debian (and Ubuntu) systems, you may need to change the contents of the nginx.conf configuration file to the Debian style as shown below.

http {
	# ...
	include /etc/nginx/conf.d/*.conf;
	include /etc/nginx/sites-enabled/*;
}

For more information: debian/conf/nginx.conf

Installation

Nginx UI is available on the following platforms:

• macOS 11 Big Sur and later (amd64 / arm64)
• Windows 10 and later (amd64 / arm64)
• Linux 2.6.23 and later (x86 / amd64 / arm64 / armv5 / armv6 / armv7 / mips32 / mips64 / riscv64 / loongarch64)
  • Including but not limited to Debian 7 / 8, Ubuntu 12.04 / 14.04 and later, CentOS 6 / 7, Arch Linux
• FreeBSD
• OpenBSD
• Dragonfly BSD
• Openwrt

You can visit latest release to download the latest distribution, or just use [installation scripts for Linux](#scri