{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/398", "result": {"data":{"issuesJson":{"id":"b7005c58-53b6-5aad-8b5a-63202beed4a8","title":"0xJacky/nginx-ui: 一个基于 Web 的综合界​​面，旨在简化 Nginx 服务器的管理和配置","number":398,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Repos0xJacky/nginx-ui
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n
\n \"Nginx\n
\n

Nginx UI

\n

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

\n

\"DeepWiki\"
\n\"Ask

\n

\"Build
\n\"GitHub
\n\"Release
\n\"GitHub
\n\"GitHub
\n\"Repo
\n\"GitHub

\n

\"Docker
\n\"Docker
\n\"Image

\n

\"Translated
\n\"Featured｜HelloGitHub\"

\n

Documentation

\n

To check out docs, visit nginxui.com.

\n

Stargazers over time

\n

\"Stargazers

\n

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

\n
\n Table of Contents\n
    \n
  1. \n About The Project\n \n
    2. \n
  2. \n Getting Started\n \n
    3. \n
  3. \n Manual Build\n \n
    4. \n
  4. \n Script for Linux\n \n
    5. \n
  5. Example of Nginx Reverse Proxy Configuration
    6. \n
  6. Contributing
    7. \n
  7. License
    8. \n
\n
\n

About The Project

\n

\"Dashboard\"

\n

Demo

\n

URL：https://demo.nginxui.com

\n\n

Features

\n\n

Internationalization

\n

We proudly offer official support for:

\n\n

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!

\n

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

\n

Built With

\n\n

Getting Started

\n

Before Use

\n

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.

\n

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.

\n
http {\n\t# ...\n\tinclude /etc/nginx/conf.d/*.conf;\n\tinclude /etc/nginx/sites-enabled/*;\n}
\n

For more information: debian/conf/nginx.conf

\n

Installation

\n

Nginx UI is available on the following platforms:

\n\n

You can visit latest release to download the latest distribution, or just use installation scripts for Linux.

\n

Usage

\n

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

\n

From Executable

\n

Run Nginx UI in Terminal

\n
nginx-ui -config app.ini
\n

Press Control+C in the terminal to exit Nginx UI.

\n

Run Nginx UI in Background

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

Stop Nginx UI with the follow command.

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

With Systemd

\n

If you are using the installation script for Linux, the Nginx UI will be installed as nginx-ui service in systemd. Please use the systemctl command to control it.

\n

Start Nginx UI

\n
systemctl start nginx-ui
\n

Stop Nginx UI

\n
systemctl stop nginx-ui
\n

Restart Nginx UI

\n
systemctl restart nginx-ui
\n

With Docker

\n

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

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

    Install Docker.

    \n
    2. \n
  2. \n

    Then deploy nginx-ui like this:

    \n
    3. \n
\n
docker run -dit \\\n  --name=nginx-ui \\\n  --restart=always \\\n  -e TZ=Asia/Shanghai \\\n  -v /mnt/user/appdata/nginx:/etc/nginx \\\n  -v /mnt/user/appdata/nginx-ui:/etc/nginx-ui \\\n  -v /var/run/docker.sock:/var/run/docker.sock \\\n  -p 8080:80 -p 8443:443 \\\n  uozi/nginx-ui:latest
\n
    \n
  1. When your docker container is running, Log in to nginx-ui panel with http://<your_server_ip>:8080/install.
    2. \n
\n
\n
\nDeploy with Docker-Compose\n
    \n
  1. \n

    Install Docker-Compose.

    \n
    2. \n
  2. \n

    Create a docker-compose.yml file like this:

    \n
    3. \n
\n
services:\n    nginx-ui:\n        stdin_open: true\n        tty: true\n        container_name: nginx-ui\n        restart: always\n        environment:\n            - TZ=Asia/Shanghai\n        volumes:\n            - '/mnt/user/appdata/nginx:/etc/nginx'\n            - '/mnt/user/appdata/nginx-ui:/etc/nginx-ui'\n            - '/var/www:/var/www'\n            - '/var/run/docker.sock:/var/run/docker.sock'\n        ports:\n            - 8080:80\n            - 8443:443\n        image: 'uozi/nginx-ui:latest'
\n
    \n
  1. Then creat your container by:
    2. \n
\n
docker compose up -d
\n
    \n
  1. When your docker container is running, Log in to nginx-ui panel with http://<your_server_ip>:8080/install.
    2. \n
\n
\n

Manual Build

\n

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

\n

Prerequisites

\n\n

Build Frontend

\n

Please execute the following command in app directory.

\n
pnpm install\npnpm build
\n

Build Backend

\n

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

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

Script for Linux

\n

Basic Usage

\n

Install and Upgrade

\n
bash -c \"$(curl -L https://raw.githubusercontent.com/0xJacky/nginx-ui/main/install.sh)\" @ install
\n

The default listening port is 9000, and the default HTTP Challenge port is 9180.
\nIf there is a port conflict, please modify /usr/local/etc/nginx-ui/app.ini manually,
\nthen use systemctl restart nginx-ui to reload the Nginx UI service.

\n

Remove Nginx UI, except configuration and database files

\n
bash -c \"$(curl -L https://raw.githubusercontent.com/0xJacky/nginx-ui/main/install.sh)\" @ remove
\n

More Usage

\n
bash -c \"$(curl -L https://raw.githubusercontent.com/0xJacky/nginx-ui/main/install.sh)\" @ help
\n

Example of Nginx Reverse Proxy Configuration

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

Contributing

\n

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

\n

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!

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

License

\n

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

","updatedAt":"2025-05-21T16:13:19Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"OpenResty","color":"987b8c"}},{"node":{"name":"0xJacky","color":"bb9484"}}]},"comments":{"edges":[]}}},"pageContext":{"number":398,"previous":{"title":"NginxProxyManager/nginx-proxy-manager: 该项目是一个预构建的Docker镜像，可以让您轻松地将您在家中或其他地方运行的网站转发出去，包括免费SSL，而无需对Nginx或Letsencrypt有太多了解。","number":397},"next":{"title":"ccfos/nightingale: All-in-One 的云原生监控工具，集合了 Prometheus 和 Grafana 的优点，你可以在 WebUI 上管理和配置告警策略，也可以对分布在多个 Region 的指标、日志、链路追踪数据进行统一的可视化和分析","number":399}}}, "staticQueryHashes": ["151096407","2861350382"]}