Repository files navigation

Yet another Nginx Web UI, developed by0xJacky,Hintay andAkino.

To check out docs, visitnginxui.com.

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

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

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

URL：https://demo.nginxui.com

• Username：admin
• Password：admin

• 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 onlineChatGPT 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-designedNgxConfigEditor which is a user-friendly block editor for nginx configurations orAce Code Editor which supportsLLM 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

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 onWeblate.

The Nginx UI follows the Debian web server configuration file standard. Created site configuration files will be placed in thesites-available folder that under the Nginx configuration folder (auto-detected). The configuration files for an enabled site will create a soft link to thesites-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 thenginx.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

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 visitlatest release to download the latest distribution, or just useinstallation scripts for Linux.

In the first runtime of Nginx UI, please visithttp://<your_server_ip>:<listen_port>in your browser to complete the follow-up configurations.

Run Nginx UI in Terminal

nginx-ui -config app.ini

PressControl+C in the terminal to exit Nginx UI.

Run Nginx UI in Background

nohup ./nginx-ui -config app.ini&

Stop Nginx UI with the follow command.

kill -9$(ps -aux| grep nginx-ui| grep -v grep| awk'{print $2}')

If you are using theinstallation script for Linux, the Nginx UI will be installed asnginx-ui service in systemd. Please use thesystemctl command to control it.

Start Nginx UI

systemctl start nginx-ui

Stop Nginx UI

systemctl stop nginx-ui

Restart Nginx UI

systemctl restart nginx-ui

Our docker imageuozi/nginx-ui:latest is based on the latest nginx image andcan be used to replace the Nginx on the host. By publishing the container's port 80 and 443 to the host,you can easily make the switch.

1. When using this container for the first time, ensure that the volume mapped to /etc/nginx is empty.
2. If you want to host static files, you can map directories to container.

docker run -dit \  --name=nginx-ui \  --restart=always \  -e TZ=Asia/Shanghai \  -v /mnt/user/appdata/nginx:/etc/nginx \  -v /mnt/user/appdata/nginx-ui:/etc/nginx-ui \  -v /var/run/docker.sock:/var/run/docker.sock \  -p 8080:80 -p 8443:443 \  uozi/nginx-ui:latest

services:nginx-ui:stdin_open:truetty:truecontainer_name:nginx-uirestart:alwaysenvironment:            -TZ=Asia/Shanghaivolumes:            -'/mnt/user/appdata/nginx:/etc/nginx'            -'/mnt/user/appdata/nginx-ui:/etc/nginx-ui'            -'/var/www:/var/www'            -'/var/run/docker.sock:/var/run/docker.sock'ports:            -8080:80            -8443:443image:'uozi/nginx-ui:latest'

docker compose up -d

On platforms that do not have an official build version, they can be built manually.

• Make

• Golang 1.23+

• node.js 21+

  npx browserslist@latest --update-db

Please execute the following command inapp directory.

pnpm installpnpm build

Please build the app first, and then execute the following command in the project root directory.

go generatego build -tags=jsoniter -ldflags"$LD_FLAGS -X 'github.com/0xJacky/Nginx-UI/settings.buildTime=$(date +%s)'" -o nginx-ui -v main.go

Install and Upgrade

bash -c"$(curl -L https://cloud.nginxui.com/install.sh)" @ install

The default listening port is9000, and the default HTTP Challenge port is9180.If there is a port conflict, please modify/usr/local/etc/nginx-ui/app.ini manually,then usesystemctl restart nginx-ui to reload the Nginx UI service.

Remove Nginx UI, except configuration and database files

bash -c"$(curl -L https://cloud.nginxui.com/install.sh)" @ remove

bash -c"$(curl -L https://cloud.nginxui.com/install.sh)" @help

server{listen80;listen          [::]:80;server_name     <your_server_name>;rewrite ^(.*)$  https://$host$1 permanent;}map$http_upgrade$connection_upgrade{    default upgrade;''      close;}server{listen443ssl;listen  [::]:443ssl;    http2   on;server_name         <your_server_name>;ssl_certificate     /path/to/ssl_cert;ssl_certificate_key /path/to/ssl_cert_key;location /{proxy_set_header    Host$host;proxy_set_header    X-Real-IP$remote_addr;proxy_set_header    X-Forwarded-For$proxy_add_x_forwarded_for;proxy_set_header    X-Forwarded-Proto$scheme;proxy_http_version  1.1;proxy_set_header    Upgrade$http_upgrade;proxy_set_header    Connection$connection_upgrade;proxy_passhttp://127.0.0.1:9000/;}}

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make aregreatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

This project is provided under a GNU Affero General Public License v3.0 license that can be found in theLICENSE file. By using, distributing, or contributing to this project, you agree to the terms and conditions of this license.