From 82c0e4f6982e14520d5fad1cff4f3e1851ae6dc3 Mon Sep 17 00:00:00 2001 From: aptalca <541623+aptalca@users.noreply.github.com> Date: Thu, 13 Apr 2023 14:55:23 -0400 Subject: [PATCH] simplify readme --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index 977a89e..f5f8088 100644 --- a/README.md +++ b/README.md @@ -23,16 +23,13 @@ Requires an internal DNS, add a rewrite of `dashboard.domain.com` to your server Remove the allow/deny lines in `/config/nginx/proxy-confs/dashboard.subdomain.com`, and instead secure it some other way (like Authelia for example). ## Notes -- The application discovery scans all files, irrespective of extension, under the nginx config directories and looks for the following structure in accordance with the samples: +- The application discovery scans for a list of known services, as well as enabled custom proxy confs that contain the following format: ```yaml set $upstream_app ; set $upstream_port ; set $upstream_proto ; proxy_pass $upstream_proto://$upstream_app:$upstream_port; ``` - The following directories are scanned for configurations: - - `/config/nginx` - - `/etc/nginx/http.d` - Either [Swag Maxmind mod](https://github.com/linuxserver/docker-mods/tree/swag-maxmind) or [Swag DBIP mod](https://github.com/linuxserver/docker-mods/tree/swag-dbip) are required to enable the geo location graph. - The host's fail2ban can be supported by mounting it to swag `- /path/to/host/fail2ban.sqlite3:/dashboard/fail2ban.sqlite3:ro` - The host's logs can be supported by mounting it to swag `- /path/to/host/logs:/dashboard/logs:ro`