You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We recommend using the [installation script](./install-script-linux) for Linux users, in which case you can directly
34
-
control the host machine's Nginx. You can also [install via Docker](#install-with-docker), where our provided image
35
-
includes Nginx and can be used bundled. For advanced users, you may also visit the [latest release](https://github.com/0xJacky/nginx-ui/releases/latest)
36
-
to download the latest distribution and [run executable directly](#run-executable-directly), or [manually build it](./build).
33
+
We provide several installation methods to suit different needs:
34
+
35
+
-**macOS/Linux**: Use [Homebrew](./install-homebrew) for the easiest installation
36
+
-**Linux**: Use the [installation script](./install-script-linux) to directly control the host machine's Nginx
37
+
-**Docker**: [Install via Docker](#install-with-docker) with our bundled image that includes Nginx
38
+
-**Advanced**: Download from [latest release](https://github.com/0xJacky/nginx-ui/releases/latest) and [run executable directly](#run-executable-directly), or [manually build it](./build)
37
39
38
40
In the first runtime of Nginx UI, please visit `http://<your_server_ip>:<listen_port>`
39
41
in your browser to complete the follow-up configurations.
40
42
41
43
In addition, we provide [an example](./nginx-proxy-example) of using Nginx to reverse proxy Nginx UI,
42
44
which can be used after installation is complete.
43
45
46
+
## Install with Homebrew
47
+
48
+
For macOS and Linux users, you can install Nginx UI using Homebrew, which provides the easiest installation experience.
49
+
50
+
::: tip
51
+
52
+
This installation method is available for macOS and Linux. For other operating systems, please use alternative installation methods.
53
+
54
+
:::
55
+
56
+
### Install
57
+
58
+
```bash
59
+
brew install 0xjacky/tools/nginx-ui
60
+
```
61
+
62
+
### Start Service
63
+
64
+
```bash
65
+
# Start the service
66
+
brew services start nginx-ui
67
+
68
+
# Or run in foreground
69
+
nginx-ui
70
+
```
71
+
72
+
### Stop Service
73
+
74
+
```bash
75
+
brew services stop nginx-ui
76
+
```
77
+
78
+
### Upgrade
79
+
80
+
```bash
81
+
brew upgrade nginx-ui
82
+
```
83
+
84
+
### Uninstall
85
+
86
+
```bash
87
+
# Stop the service first
88
+
brew services stop nginx-ui
89
+
90
+
# Uninstall the package
91
+
brew uninstall nginx-ui
92
+
93
+
# Optionally remove the tap
94
+
brew untap 0xjacky/tools
95
+
```
96
+
97
+
::: warning
98
+
99
+
After uninstalling, configuration files and data will be preserved in:
0 commit comments