Install Script

This shell script currently only supports Linux systems. If you are using another operating system, please refer to the quick start guide for manual installation or use Docker.

Install or Upgrade

install.sh install

Install or Update Nginx UI.

Usage

install.sh install [OPTIONS]

Options

Options
-l, --local <file>	Install Nginx UI from a local file (string)
-p, --proxy <url>	Download through a proxy server (string) e.g., -p http://127.0.0.1:8118 or -p socks5://127.0.0.1:1080
-r, --reverse-proxy	Download through a reverse proxy server (string) e.g., -r https://cloud.nginxui.com/

Quick Usage

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

The default listening port is 9000, and the default HTTP Challenge port is 9180. If there is a port conflict, please modify /usr/local/etc/nginx-ui/app.ini manually, then use systemctl restart nginx-ui to restart the Nginx UI service. For more information, please check reference for config.

Remove

install.sh remove

Remove Nginx UI.

Usage

install.sh remove [OPTIONS]

Options

Options
--purge	Remove all the Nginx UI files, include logs, configs, etc (boolean)

Quick Usage

Remove

# Remove Nginx UI, except configuration and database files
bash -c "$(curl -L https://raw.githubusercontent.com/0xJacky/nginx-ui/main/install.sh)" @ remove

Purge

# Remove all the Nginx UI file, include configuration and database files
bash -c "$(curl -L https://raw.githubusercontent.com/0xJacky/nginx-ui/main/install.sh)" @ remove --purge

Help

install.sh help

Display available options.

Usage

install.sh help

Quick Usage

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

Control Service

By this script, the Nginx UI will be installed as nginx-ui service in systemd. Please use the follow systemctl command to control it.

Start

systemctl start nginx-ui

Stop

systemctl stop nginx-ui

Restart

systemctl restart nginx-ui

Show Status

systemctl status nginx-ui