vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2025-12-07 09:36:05 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

DOC updates

Browse Source
This commit is contained in:
Ingo Ratsdorf
2025-09-12 14:55:30 +12:00
parent e0ffe8b424
commit 9943c98055
1 changed files with 57 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
docs/REVERSE_PROXY.md
View File

@@ -2,9 +2,13 @@
> Submitted by amazing [cvc90](https://github.com/cvc90) 🙏
> [!NOTE]
> There are 2 NGINX files for NetAlertX, one for the bare-metal Debian install (`netalertx.debian.conf`), and one for the docker container (`netalertx.template.conf`). Both can be found in the [install](https://github.com/jokob-sk/NetAlertX/tree/main/install) folder. Map, or use, the one appropriate for your setup.
> There are various NGINX config files for NetAlertX, some for the bare-metal install, currently Debian 12 and Ubuntu 24 (`netalertx.conf`), and one for the docker container (`netalertx.template.conf`).
>
> The first one you can find in the respective bare metal installer folder `/app/install/\<system\>/netalertx.conf`.
> The docker one can be found in the [install](https://github.com/jokob-sk/NetAlertX/tree/main/install) folder. Map, or use, the one appropriate for your setup.
<br/>
## NGINX HTTP Configuration (Direct Path)
@@ -26,9 +30,11 @@
`nginx -s reload` or `systemctl restart nginx`
4. Once NGINX restarts, you should be able to access the proxy website at http://netalertx/
4. Check your config with `nginx -t`. If there are any issues, it will tell you.
<br>
5. Once NGINX restarts, you should be able to access the proxy website at http://netalertx/
<br/>
## NGINX HTTP Configuration (Sub Path)
@@ -50,13 +56,15 @@
}
```
3. Activate the new website by running the following command:
4. Check your config with `nginx -t`. If there are any issues, it will tell you.
5. Activate the new website by running the following command:
`nginx -s reload` or `systemctl restart nginx`
4. Once NGINX restarts, you should be able to access the proxy website at http://netalertx/netalertx/
6. Once NGINX restarts, you should be able to access the proxy website at http://netalertx/netalertx/
<br>
<br/>
## NGINX HTTP Configuration (Sub Path) with module ngx_http_sub_module
@@ -86,13 +94,15 @@
}
```
3. Activate the new website by running the following command:
3. Check your config with `nginx -t`. If there are any issues, it will tell you.
4. Activate the new website by running the following command:
`nginx -s reload` or `systemctl restart nginx`
4. Once NGINX restarts, you should be able to access the proxy website at http://netalertx/netalertx/
5. Once NGINX restarts, you should be able to access the proxy website at http://netalertx/netalertx/
<br>
<br/>
**NGINX HTTPS Configuration (Direct Path)**
@@ -113,13 +123,15 @@
}
```
3. Activate the new website by running the following command:
4. Check your config with `nginx -t`. If there are any issues, it will tell you.
5. Activate the new website by running the following command:
`nginx -s reload` or `systemctl restart nginx`
4. Once NGINX restarts, you should be able to access the proxy website at https://netalertx/
6. Once NGINX restarts, you should be able to access the proxy website at https://netalertx/
<br>
<br/>
**NGINX HTTPS Configuration (Sub Path)**
@@ -143,13 +155,15 @@
}
```
3. Activate the new website by running the following command:
4. Check your config with `nginx -t`. If there are any issues, it will tell you.
5. Activate the new website by running the following command:
`nginx -s reload` or `systemctl restart nginx`
4. Once NGINX restarts, you should be able to access the proxy website at https://netalertx/netalertx/
6. Once NGINX restarts, you should be able to access the proxy website at https://netalertx/netalertx/
<br>
<br/>
## NGINX HTTPS Configuration (Sub Path) with module ngx_http_sub_module
@@ -181,13 +195,15 @@
}
```
3. Activate the new website by running the following command:
4. Check your config with `nginx -t`. If there are any issues, it will tell you.
5. Activate the new website by running the following command:
`nginx -s reload` or `systemctl restart nginx`
4. Once NGINX restarts, you should be able to access the proxy website at https://netalertx/netalertx/
6. Once NGINX restarts, you should be able to access the proxy website at https://netalertx/netalertx/
<br>
<br/>
## Apache HTTP Configuration (Direct Path)
@@ -204,13 +220,15 @@
</VirtualHost>
```
3. Activate the new website by running the following command:
4. Check your config with `httpd -t`. If there are any issues, it will tell you.
5. Activate the new website by running the following command:
`a2ensite netalertx` or `service apache2 reload`
4. Once Apache restarts, you should be able to access the proxy website at http://netalertx/
6. Once Apache restarts, you should be able to access the proxy website at http://netalertx/
<br>
<br/>
## Apache HTTP Configuration (Sub Path)
@@ -229,13 +247,15 @@
</VirtualHost>
```
3. Activate the new website by running the following command:
4. Check your config with `httpd -t`. If there are any issues, it will tell you.
5. Activate the new website by running the following command:
`a2ensite netalertx` or `service apache2 reload`
4. Once Apache restarts, you should be able to access the proxy website at http://netalertx/
6. Once Apache restarts, you should be able to access the proxy website at http://netalertx/
<br>
<br/>
## Apache HTTPS Configuration (Direct Path)
@@ -255,13 +275,15 @@
</VirtualHost>
```
3. Activate the new website by running the following command:
4. Check your config with `httpd -t`. If there are any issues, it will tell you.
5. Activate the new website by running the following command:
`a2ensite netalertx` or `service apache2 reload`
4. Once Apache restarts, you should be able to access the proxy website at https://netalertx/
6. Once Apache restarts, you should be able to access the proxy website at https://netalertx/
<br>
<br/>
## Apache HTTPS Configuration (Sub Path)
@@ -283,11 +305,15 @@
</VirtualHost>
```
3. Activate the new website by running the following command:
4. Check your config with `httpd -t`. If there are any issues, it will tell you.
5. Activate the new website by running the following command:
`a2ensite netalertx` or `service apache2 reload`
4. Once Apache restarts, you should be able to access the proxy website at https://netalertx/netalertx/
6. Once Apache restarts, you should be able to access the proxy website at https://netalertx/netalertx/
<br/>
## Reverse proxy example by using LinuxServer's SWAG container.
@@ -349,6 +375,7 @@ location ^~ /netalertx/ {
}
```
<br/>
## Traefik
@@ -480,4 +507,3 @@ docker run -d --rm --network=host \
ghcr.io/jokob-sk/netalertx:latest
```