From 9943c980558e777ba3587515876aaedb06ec689f Mon Sep 17 00:00:00 2001 From: Ingo Ratsdorf Date: Fri, 12 Sep 2025 14:55:30 +1200 Subject: [PATCH] DOC updates --- docs/REVERSE_PROXY.md | 88 ++++++++++++++++++++++++++++--------------- 1 file changed, 57 insertions(+), 31 deletions(-) diff --git a/docs/REVERSE_PROXY.md b/docs/REVERSE_PROXY.md index 81c34692..f0a4c730 100755 --- a/docs/REVERSE_PROXY.md +++ b/docs/REVERSE_PROXY.md @@ -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/\/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. + +
## 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. -
+5. Once NGINX restarts, you should be able to access the proxy website at http://netalertx/ + +
## 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/ -
+
## 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/ -
+
**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/ -
+
**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/ -
+
## 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/ -
+
## Apache HTTP Configuration (Direct Path) @@ -204,13 +220,15 @@ ``` -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/ -
+
## Apache HTTP Configuration (Sub Path) @@ -229,13 +247,15 @@ ``` -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/ -
+
## Apache HTTPS Configuration (Direct Path) @@ -255,13 +275,15 @@ ``` -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/ -
+
## Apache HTTPS Configuration (Sub Path) @@ -283,11 +305,15 @@ ``` -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/ + +
## Reverse proxy example by using LinuxServer's SWAG container. @@ -349,6 +375,7 @@ location ^~ /netalertx/ { } ``` +
## Traefik @@ -480,4 +507,3 @@ docker run -d --rm --network=host \ ghcr.io/jokob-sk/netalertx:latest ``` -