Skip to content

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

shell
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-proxyDownload through a reverse proxy server (string)
e.g., -r https://mirror.ghproxy.com/

Quick Usage

shell
bash <(curl -L -s https://raw.githubusercontent.com/0xJacky/nginx-ui/master/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

shell
install.sh remove [OPTIONS]

Options

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

Quick Usage

shell
# Remove Nginx UI, except configuration and database files
bash <(curl -L -s https://raw.githubusercontent.com/0xJacky/nginx-ui/master/install.sh) remove
shell
# Remove all the Nginx UI file, include configuration and database files
bash <(curl -L -s https://raw.githubusercontent.com/0xJacky/nginx-ui/master/install.sh) remove --purge

Help

install.sh help

Display available options.

Usage

shell
install.sh help

Quick Usage

shell
bash <(curl -L -s https://raw.githubusercontent.com/0xJacky/nginx-ui/master/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.

shell
systemctl start nginx-ui
shell
systemctl stop nginx-ui
shell
systemctl restart nginx-ui
shell
systemctl status nginx-ui

Released under the AGPL-3.0 License. (32663e1c)