uozi/nginx-ui

Nginx UI

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

Documentation

To check out docs, visit nginxui.com.

Stargazers over time

Features

• Online statistics for server indicators such as CPU usage, memory usage, load average, and disk usage.
• Online *** Assistant
• 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 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

• English
• Simplified Chinese
• Traditional Chinese

We welcome translations into any language.

Built With

• https://go.dev
• Gin Web Framework
• GORM
• https://v3.vuejs.org
• https://vitejs.dev
• https://www.typescriptlang.org/
• Ant Design Vue
• https://github.com/jshmrtn/vue3-gettext
• https://github.com/CarterLi/vue3-ace-editor
• https://github.com/tufanbarisyildirim/gonginx

Getting Started

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.

With Docker

Our docker image 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.

Deploy with Docker

1. https://docs.docker.com/install/

2. Then deploy nginx-ui like this:

bash
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 \
  -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.

Deploy with Docker-Compose

1. https://docs.docker.com/compose/install/

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

yml
services:
    nginx-ui:
        stdin_open: true
        tty: true
        container_name: nginx-ui
        restart: always
        environment:
            - TZ=Asia/Shanghai
        volumes:
            - '/mnt/user/appdata/nginx:/etc/nginx'
            - '/mnt/user/appdata/nginx-ui:/etc/nginx-ui'
            - '/var/www:/var/www'
        ports:
            - 8080:80
            - 8443:443
        image: 'uozi/nginx-ui:latest'

3. Then creat your container by:

bash
docker compose up -d

4. When your docker container is running, Log in to nginx-ui panel with http://<your_server_ip>:8080/install.

Example of Nginx Reverse Proxy Configuration

nginx
server {
    listen          80;
    listen          [::]:80;

    server_name     <your_server_name>;
    rewrite ^(.*)$  https://$host$1 permanent;
}

map $http_upgrade $connection_upgrade {
    default upgrade;
    ''      close;
}

server {
    listen  443       ssl;
    listen  [::]:443  ssl;
    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_pass          http://127.0.0.1:9000/;
    }
}

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly 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

License

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.