Skip to content

Commit 284c37d

Browse files
committed
Update documentation
1 parent 0aa4d8b commit 284c37d

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,24 @@ This mod adds a dashboard to SWAG powered by [Goaccess](https://goaccess.io/).
66

77
# Enable
88

9-
In the container's docker arguments, set an environment variable DOCKER_MODS=linuxserver/mods:swag-dashboard
9+
In the container's docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:swag-dashboard`.
1010

11-
If adding multiple mods, enter them in an array separated by |, such as DOCKER_MODS=linuxserver/mods:swag-dashboard|linuxserver/mods:swag-mod2
11+
If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:swag-dashboard|linuxserver/mods:swag-mod2`.
1212

1313
## Internal access using `<server-ip>:81`
1414

15-
Add a mapping of `81:81` to swag's docker run command or compose
15+
Add a mapping of `81:81` to swag's docker run command or compose.
1616

1717
## Internal access using `dashboard.domain.com`
1818

19-
Requires an internal DNS, add a rewrite of `dashboard.domain.com` to your server's IP address
19+
Requires an internal DNS, add a rewrite of `dashboard.domain.com` to your server's IP address.
2020

2121
## External access using `dashboard.domain.com`
2222

2323
Remove the allow/deny lines in `/config/nginx/proxy-confs/dashboard.subdomain.com`, and instead secure it some other way (like Authelia for example).
2424

25-
## Notes
25+
## Usage
26+
2627
- The application discovery scans for a list of known services, as well as enabled custom proxy confs that contain the following format:
2728
```yaml
2829
set $upstream_app <container/address>;
@@ -31,9 +32,15 @@ Remove the allow/deny lines in `/config/nginx/proxy-confs/dashboard.subdomain.co
3132
proxy_pass $upstream_proto://$upstream_app:$upstream_port;
3233
```
3334
- 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.
34-
- The host's fail2ban can be supported by mounting it to swag `- /path/to/host/fail2ban.sqlite3:/dashboard/fail2ban.sqlite3:ro`
35-
- The host's logs can be supported by mounting it to swag `- /path/to/host/logs:/dashboard/logs:ro`
3635
- To clear the dashboard stats, you must remove the logs (/config/log/nginx) and **recreate** the container.
3736

37+
## Dashboard Support
38+
39+
There's a stats endpoint for integration with dashboards under `https://dashboard.domain.com/?stats=true`.
40+
41+
## External Support
42+
- External fail2ban (not required when using swag's fail2ban) can be supported by mounting it to swag `- /path/to/host/fail2ban.sqlite3:/dashboard/fail2ban.sqlite3:ro`.
43+
- External logs (not required when using swag's logs) can be supported by mounting it to swag `- /path/to/host/logs:/dashboard/logs:ro`.
44+
3845
# Example
3946
![Example](.assets/example.png)

0 commit comments

Comments
 (0)