Skip to content
Back to search

nginx-ui

Yet another WebUI for Nginx

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/0xJacky/nginx-ui with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/0xJacky/nginx-ui'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/0xjacky--nginx-ui/badge.svg)](/listings/0xjacky--nginx-ui)

HTML

<a href="/listings/0xjacky--nginx-ui"><img src="/api/listings/0xjacky--nginx-ui/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

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](https://salsa.debian.org/nginx-team/nginx/-/blob/debian/latest/debian/conf/nginx.conf#L60-L61)

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](https://github.com/0xJacky/nginx-ui/releases/latest) to download the latest distribution, or just use [installation scripts for Linux](#script-for-linux).

Usage

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

From Executable

**Run Nginx UI in Terminal**

nginx-ui -config app.ini

Press `Control+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}')

With Systemd

If you are using the [installation script for Linux](#script-for-linux), the Nginx UI will be installed as `nginx-ui` service in systemd. Please use the `systemctl` 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

With Docker

Our docker image [uozi/nginx-ui:latest](https://hub.docker.com/r/uozi/nginx-ui) is based on the latest nginx image and can 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.

Note

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. 3. If you are upgrading from an older image, see the [Docker WebSocket fix guide](https://nginxui.com/guide/docker-websocket-fix.html) for required `conf.d/nginx-ui.conf` updates.

<details> <summary><b>Deploy with Docker</b></summary>

1. [Install Docker.](https://docs.docker.com/install/)

2. Then deploy nginx-ui like this:

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

3. When your docker container is running, Log in to nginx-ui panel with `http://<your_server_ip>:8080/install`. If you change the port mapping, access Nginx UI through the host port mapped to container port `80` instead. </details>

<details> <summary><b>Deploy with Docker-Compose</b></summary>

1. [Install Docker-Compose.](https://docs.docker.com/compose/install/)

2. Create a docker-compose.yml file like this:

services:
    nginx-ui:
        stdin_open: true
        tty: true
        container_name: nginx-ui
        restart: always
        environment:
            - TZ=Asia/Shanghai
        volumes:

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 427 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <div align="center">
  2. <img src="resources/logo.png" alt="Nginx UI Logo">
  3. </div>
  4. # Nginx UI
  5. Yet another Nginx Web UI, developed by [0xJacky](https://jackyu.cn/), [Hintay](https://blog.kugeek.com/) and [Akino](https://github.com/akinoccc).
  6. <div align="center">
  7. [![DeepWiki](https://img.shields.io/badge/DeepWiki-0xJacky%2Fnginx--ui-blue.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/0xJacky/nginx-ui) [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/0xJacky/nginx-ui) [![Documentation](https://img.shields.io/badge/Documentation-nginxui.com-1f6feb?logo=readthedocs&logoColor=white)](https://nginxui.com)
  8. <p align="center">
  9. <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" style="vertical-align: middle;"></a>
  10. &nbsp;Proudly hosted on <a href="https://atomgit.com/uozi/nginx-ui">AtomGit</a> — a part of the <b>G-Star</b> program.
  11. </p>
  12. [![AtomGit Stars](https://atomgit.com/uozi/nginx-ui/star/badge.svg)](https://atomgit.com/uozi/nginx-ui)
  13. [![Build and Publish](https://github.com/0xJacky/nginx-ui/actions/workflows/build.yml/badge.svg)](https://github.com/0xJacky/nginx-ui/actions/workflows/build.yml) [![GitHub license](https://img.shields.io/github/license/0xJacky/nginx-ui?label=License&logo=github)](https://github.com/0xJacky/nginx-ui "Click to view the repo on GitHub") [![Release Version](https://img.shields.io/github/release/0xJacky/nginx-ui?include_prereleases&label=Release&logo=github)](https://github.com/0xJacky/nginx-ui/releases/latest "Click to view the repo on GitHub") [![GitHub Stars](https://img.shields.io/github/stars/0xJacky/nginx-ui?label=Stars&logo=github)](https://github.com/0xJacky/nginx-ui "Click to view the repo on GitHub") [![GitHub Forks](https://img.shields.io/github/forks/0xJacky/nginx-ui?label=Forks&logo=github)](https://github.com/0xJacky/nginx-ui "Click to view the repo on GitHub") [![Repo Size](https://img.shields.io/github/repo-size/0xJacky/nginx-ui?label=Size&logo=github)](https://github.com/0xJacky/nginx-ui "Click to view the repo on GitHub") [![Closed Issues](https://img.shields.io/github/issues-closed-raw/0xJacky/nginx-ui?label=Closed%20Issues&logo=github)](https://github.com/0xJacky/nginx-ui/issues "View issues on GitHub")
  14. [![Docker Stars](https://img.shields.io/docker/stars/uozi/nginx-ui?label=Stars&logo=docker)](https://hub.docker.com/r/uozi/nginx-ui "Click to view the image on Docker Hub") [![Docker Pulls](https://img.shields.io/docker/pulls/uozi/nginx-ui?label=Pulls&logo=docker)](https://hub.docker.com/r/uozi/nginx-ui "Click to view the image on Docker Hub") [![Image Size](https://img.shields.io/docker/image-size/uozi/nginx-ui/latest?label=Image%20Size&logo=docker)](https://hub.docker.com/r/uozi/nginx-ui "Click to view the image on Docker Hub")
  15. [![Featured|HelloGitHub](https://abroad.hellogithub.com/v1/widgets/recommend.svg?rid=86f3a8f779934748a34fe6f1b5cd442f&claim_uid=MOFqadzAShCBeQj&theme=small)](https://hellogithub.com/repository/86f3a8f779934748a34fe6f1b5cd442f) [![Plumber Score](https://score.getplumber.io/github.com/0xJacky/nginx-ui.svg)](https://score.getplumber.io/github.com/0xJacky/nginx-ui)
  16. [![Deploy on RainYun](https://rainyun-apps.cn-nb1.rains3.com/materials/deploy-on-rainyun-en.svg)](https://app.rainyun.com/apps/rca/store/8035/nginxui_)
  17. </div>
  18. ## Documentation
  19. To check out docs, visit [nginxui.com](https://nginxui.com).
  20. ## Sponsor
  21. If you find this project helpful, please consider sponsoring us to support ongoing development and maintenance.
  22. [![GitHub Sponsors](https://img.shields.io/badge/GitHub-Sponsors-ea4aaa?style=for-the-badge&logo=github-sponsors&logoColor=white)](https://github.com/sponsors/nginxui)
  23. [![Afdian](https://img.shields.io/badge/爱发电-Support-946ce6?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTEyIDJMMTMuMDkgOC4yNkwyMCA5TDEzLjA5IDE1Ljc0TDEyIDIyTDEwLjkxIDE1Ljc0TDQgOUwxMC45MSA4LjI2TDEyIDJaIiBmaWxsPSJ3aGl0ZSIvPgo8L3N2Zz4K)](https://afdian.com/a/nginxui)
  24. ### Sponsors
  25. <a href="https://www.axisnow.io/" target="_blank">
  26. <img src="resources/axisnow-logo.png" alt="AxisNow" width="220px">
  27. </a>
  28. 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.**
  29. ### Official Community Group
  30. Join the official Nginx UI WeChat community group to discuss usage, deployment ideas, and troubleshooting with other community members.
  31. 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.
  32. <p align="center">
  33. <img src="docs/public/assets/wechat-community-qr.png" alt="Nginx UI WeChat Community QR Code" width="320">
  34. </p>
  35. Your support helps us:
  36. - 🚀 Accelerate the development of new features
  37. - 🐛 Fix bugs and improve stability
  38. - 📚 Enhance documentation and tutorials
  39. - 🌐 Provide better community support
  40. - 💻 Maintain infrastructure and demo servers
  41. ### Tooling Support
  42. <a href="https://www.jetbrains.com/?from=nginx-ui" target="_blank">
  43. <img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg" alt="JetBrains Logo" width="200px">
  44. </a>
  45. Thanks to [JetBrains](https://www.jetbrains.com/?from=nginx-ui) for supporting us with free open source licenses.
  46. ## Stargazers over time
  47. [![Stargazers over time](https://cloud.nginxui.com/stars/0xJacky/nginx-ui.svg)](https://cloud.nginxui.com/stars/0xJacky/nginx-ui.svg)
  48. English | [Español](resources/readme/README-es.md) | [简体中文](resources/readme/README-zh_CN.md) | [繁體中文](resources/readme/README-zh_TW.md) | [Tiếng Việt](resources/readme/README-vi_VN.md) | [日本語](resources/readme/README-ja_JP.md)
  49. <details>
  50. <summary>Table of Contents</summary>
  51. <ol>
  52. <li>
  53. <a href="#about-the-project">About The Project</a>
  54. <ul>
  55. <li><a href="#demo">Demo</a></li>
  56. <li><a href="#features">Features</a></li>
  57. <li><a href="#internationalization">Internationalization</a></li>
  58. </ul>
  59. </li>
  60. <li>
  61. <a href="#getting-started">Getting Started</a>
  62. <ul>
  63. <li><a href="#before-use">Before Use</a></li>
  64. <li><a href="#installation">Installation</a></li>
  65. <li>
  66. <a href="#usage">Usage</a>
  67. <ul>
  68. <li><a href="#from-executable">From Executable</a></li>
  69. <li><a href="#with-systemd">With Systemd</a></li>
  70. <li><a href="#with-docker">With Docker</a></li>
  71. </ul>
  72. </li>
  73. </ul>
  74. </li>
  75. <li>
  76. <a href="#manual-build">Manual Build</a>
  77. <ul>
  78. <li><a href="#prerequisites">Prerequisites</a></li>
  79. <li><a href="#build-app">Build Frontend</a></li>
  80. <li><a href="#build-backend">Build Backend</a></li>
  81. </ul>
  82. </li>
  83. <li>
  84. <a href="#script-for-linux">Script for Linux</a>
  85. <ul>
  86. <li><a href="#basic-usage">Basic Usage</a></li>
  87. <li><a href="#more-usage">More Usage</a></li>
  88. </ul>
  89. </li>
  90. <li><a href="#example-of-nginx-reverse-proxy-configuration">Example of Nginx Reverse Proxy Configuration</a></li>
  91. <li><a href="#contributing">Contributing</a></li>
  92. <li><a href="#license">License</a></li>
  93. </ol>
  94. </details>
  95. ## About The Project
  96. ![Dashboard](resources/screenshots/dashboard_en.png)
  97. ### Demo
  98. URL:[https://demo.nginxui.com](https://demo.nginxui.com)
  99. - Username:admin
  100. - Password:admin
  101. ### Features
  102. - Online statistics for server indicators such as CPU usage, memory usage, load average, and disk usage.
  103. - Automatic configuration backup after changes, with version comparison and restore capabilities
  104. - Cluster management supporting mirroring operations to multiple nodes, making multi-server environments easy to manage
  105. - Export encrypted Nginx / Nginx UI configurations for quick deployment and recovery to new environments
  106. - Enhanced online **ChatGPT** assistant supporting multiple models, including Deepseek-R1's chain-of-thought display to help you better understand and optimize configurations
  107. - **MCP** (Model Context Protocol) provides special interfaces for AI agents to interact with Nginx UI, enabling automated configuration management and service control.
  108. - One-click deployment and automatic renewal Let's Encrypt certificates.
  109. - 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.
  110. - View Nginx logs online, with indexed search, a traffic dashboard and visitor maps
  111. - Plugin system: install signed plugins from the marketplace, an uploaded file or an offline directory, for example the official DNS-01 plugin with the DNS providers for certificates
  112. - Written in Go and Vue, distribution is a single executable binary.
  113. - Automatically test configuration file and reload nginx after saving configuration.
  114. - Web Terminal
  115. - Dark Mode
  116. - Responsive Web Design
  117. ### Internationalization
  118. We proudly offer official support for:
  119. - English
  120. - Simplified Chinese
  121. - Traditional Chinese
  122. 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!
  123. Thanks to our amazing community, additional languages are also available! Explore and contribute to translations on [Weblate](https://weblate.nginxui.com).
  124. ## Getting Started
  125. ### Before Use
  126. 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.
  127. 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.
  128. ```nginx
  129. http {
  130. # ...
  131. include /etc/nginx/conf.d/*.conf;
  132. include /etc/nginx/sites-enabled/*;
  133. }
  134. ```
  135. For more information: [debian/conf/nginx.conf](https://salsa.debian.org/nginx-team/nginx/-/blob/debian/latest/debian/conf/nginx.conf#L60-L61)
  136. ### Installation
  137. Nginx UI is available on the following platforms:
  138. - macOS 11 Big Sur and later (amd64 / arm64)
  139. - Windows 10 and later (amd64 / arm64)
  140. - Linux 2.6.23 and later (x86 / amd64 / arm64 / armv5 / armv6 / armv7 / mips32 / mips64 / riscv64 / loongarch64)
  141. - Including but not limited to Debian 7 / 8, Ubuntu 12.04 / 14.04 and later, CentOS 6 / 7, Arch Linux
  142. - FreeBSD
  143. - OpenBSD
  144. - Dragonfly BSD
  145. - Openwrt
  146. You can visit [latest release](https://github.com/0xJacky/nginx-ui/releases/latest) to download the latest distribution, or just use [installation scripts for Linux](#script-for-linux).
  147. ### Usage
  148. In the first runtime of Nginx UI, please visit `http://<your_server_ip>:<listen_port>`
  149. in your browser to complete the follow-up configurations.
  150. #### From Executable
  151. **Run Nginx UI in Terminal**
  152. ```shell
  153. nginx-ui -config app.ini
  154. ```
  155. Press `Control+C` in the terminal to exit Nginx UI.
  156. **Run Nginx UI in Background**
  157. ```shell
  158. nohup ./nginx-ui -config app.ini -pidfile nginx-ui.pid &
  159. ```
  160. Stop Nginx UI gracefully with the following command.
  161. ```shell
  162. kill -TERM "$(cat nginx-ui.pid)"
  163. ```
  164. #### With Systemd
  165. If you are using the [installation script for Linux](#script-for-linux), the Nginx UI will be installed as `nginx-ui` service in systemd. Please use the `systemctl` command to control it.
  166. **Start Nginx UI**
  167. ```shell
  168. systemctl start nginx-ui
  169. ```
  170. **Stop Nginx UI**
  171. ```shell
  172. systemctl stop nginx-ui
  173. ```
  174. **Restart Nginx UI**
  175. ```shell
  176. systemctl restart nginx-ui
  177. ```
  178. #### With Docker
  179. Our docker image [uozi/nginx-ui:latest](https://hub.docker.com/r/uozi/nginx-ui) is based on the latest nginx image and
  180. can be used to replace the Nginx on the host. By publishing the container's port 80 and 443 to the host,
  181. you can easily make the switch.
  182. ##### Note
  183. 1. When using this container for the first time, ensure that the volume mapped to /etc/nginx is empty.
  184. 2. If you want to host static files, you can map directories to container.
  185. 3. If you are upgrading from an older image, see the [Docker WebSocket fix guide](https://nginxui.com/guide/docker-websocket-fix.html) for required `conf.d/nginx-ui.conf` updates.
  186. 4. The image bundles the official DNS-01 plugin and installs it on the first start. Installed plugins are kept in `/etc/nginx-ui/plugins`, so keep `/etc/nginx-ui` on a volume. When upgrading from v2, see [Upgrading to v3](https://nginxui.com/guide/upgrade-v3.html).
  187. <details>
  188. <summary><b>Deploy with Docker</b></summary>
  189. 1. [Install Docker.](https://docs.docker.com/install/)
  190. 2. Then deploy nginx-ui like this:
  191. ```bash
  192. docker run -dit \
  193. --name=nginx-ui \
  194. --restart=always \
  195. -e TZ=Asia/Shanghai \
  196. -v /mnt/user/appdata/nginx:/etc/nginx \
  197. -v /mnt/user/appdata/nginx-ui:/etc/nginx-ui \
  198. -v /var/run/docker.sock:/var/run/docker.sock \
  199. -p 8080:80 -p 8443:443 \
  200. uozi/nginx-ui:latest
  201. ```
  202. 3. When your docker container is running, Log in to nginx-ui panel with `http://<your_server_ip>:8080/install`.
  203. If you change the port mapping, access Nginx UI through the host port mapped to container port `80` instead.
  204. </details>
  205. <details>
  206. <summary><b>Deploy with Docker-Compose</b></summary>
  207. 1. [Install Docker-Compose.](https://docs.docker.com/compose/install/)
  208. 2. Create a docker-compose.yml file like this:
  209. ```yml
  210. services:
  211. nginx-ui:
  212. stdin_open: true
  213. tty: true
  214. container_name: nginx-ui
  215. restart: always
  216. environment:
  217. - TZ=Asia/Shanghai
  218. volumes:
  219. - '/mnt/user/appdata/nginx:/etc/nginx'
  220. - '/mnt/user/appdata/nginx-ui:/etc/nginx-ui'
  221. - '/var/www:/var/www'
  222. - '/var/run/docker.sock:/var/run/docker.sock'
  223. ports:
  224. - 8080:80
  225. - 8443:443
  226. image: 'uozi/nginx-ui:latest'
  227. ```
  228. 3. Then creat your container by:
  229. ```bash
  230. docker compose up -d
  231. ```
  232. 4. When your docker container is running, Log in to nginx-ui panel with `http://<your_server_ip>:8080/install`.
  233. If you change the port mapping, access Nginx UI through the host port mapped to container port `80` instead.
  234. </details>
  235. ## Manual Build
  236. On platforms that do not have an official build version, they can be built manually.
  237. ### Prerequisites
  238. - Make
  239. - Golang 1.27.2+
  240. - Bun 1.4.3 (the version pinned by this repository's package manifest and CI)
  241. - node.js 21+
  242. ```shell
  243. npx browserslist@latest --update-db
  244. ```
  245. ### Build Frontend
  246. Please execute the following command in `app` directory.
  247. ```shell
  248. bun install
  249. bun run build
  250. ```
  251. ### Build Backend
  252. Please build the app first, and then execute the following command in the project root directory.
  253. ```shell
  254. go generate
  255. go build -tags=jsoniter -ldflags "$LD_FLAGS -X 'github.com/0xJacky/Nginx-UI/settings.buildTime=$(date +%s)'" -o nginx-ui -v main.go
  256. ```
  257. ## Script for Linux
  258. ### Basic Usage
  259. **Install and Upgrade**
  260. ```shell
  261. bash -c "$(curl -L https://cloud.nginxui.com/install.sh)" @ install
  262. ```
  263. The default listening port is `9000`, and the default HTTP Challenge port is `9180`.
  264. If there is a port conflict, please modify `/usr/local/etc/nginx-ui/app.ini` manually,
  265. then use `systemctl restart nginx-ui` to reload the Nginx UI service.
  266. **Remove Nginx UI, except configuration and database files**
  267. ```shell
  268. bash -c "$(curl -L https://cloud.nginxui.com/install.sh)" @ remove
  269. ```
  270. ### More Usage
  271. ````shell
  272. bash -c "$(curl -L https://cloud.nginxui.com/install.sh)" @ help
  273. ````
  274. ## Example of Nginx Reverse Proxy Configuration
  275. ```nginx
  276. server {
  277. listen 80;
  278. listen [::]:80;
  279. server_name <your_server_name>;
  280. rewrite ^(.*)$ https://$host$1 permanent;
  281. }
  282. map $http_upgrade $connection_upgrade {
  283. default upgrade;
  284. '' close;
  285. }
  286. server {
  287. listen 443 ssl;
  288. listen [::]:443 ssl;
  289. http2 on;
  290. server_name <your_server_name>;
  291. ssl_certificate /path/to/ssl_cert;
  292. ssl_certificate_key /path/to/ssl_cert_key;
  293. location / {
  294. proxy_set_header Host $host;
  295. proxy_set_header X-Real-IP $remote_addr;
  296. proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  297. proxy_set_header X-Forwarded-Proto $scheme;
  298. proxy_http_version 1.1;
  299. proxy_set_header Upgrade $http_upgrade;
  300. proxy_set_header Connection $connection_upgrade;
  301. proxy_pass http://127.0.0.1:9000/;
  302. }
  303. }
  304. ```
  305. ## Contributing
  306. Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
  307. 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!
  308. 1. Fork the Project
  309. 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
  310. 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
  311. 4. Push to the Branch (`git push origin feature/AmazingFeature`)
  312. 5. Open a Pull Request
  313. ## License
  314. This project is provided under a GNU Affero General Public License v3.0 license that can be found in the [LICENSE](LICENSE) file. By using, distributing, or contributing to this project, you agree to the terms and conditions of this license.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.