From b875ba4dfeca4dd118a72ece8d4466c021065e40 Mon Sep 17 00:00:00 2001
From: TwiN <chris@twin.sh>
Date: Thu, 21 Aug 2025 10:11:06 -0400
Subject: [PATCH] docs(ui): Clarify how to sort by group by default

---
 README.md | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b060d7d9..b2977977 100644
--- a/README.md
+++ b/README.md
@@ -111,6 +111,7 @@ Have any feedback or questions? [Create a discussion](https://github.com/TwiN/ga
   - [disable-monitoring-lock](#disable-monitoring-lock)
   - [Reloading configuration on the fly](#reloading-configuration-on-the-fly)
   - [Endpoint groups](#endpoint-groups)
+  - [How do I sort by group by default?](#how-do-i-sort-by-group-by-default)
   - [Exposing Gatus on a custom path](#exposing-gatus-on-a-custom-path)
   - [Exposing Gatus on a custom port](#exposing-gatus-on-a-custom-port)
   - [Configuring a startup delay](#configuring-a-startup-delay)
@@ -659,7 +660,7 @@ endpoints:
 | `alerting.telegram`        | Configuration for alerts of type `telegram`. <br />See [Configuring Telegram alerts](#configuring-telegram-alerts).                     | `{}`    |
 | `alerting.twilio`          | Settings for alerts of type `twilio`. <br />See [Configuring Twilio alerts](#configuring-twilio-alerts).                                | `{}`    |
 | `alerting.zulip`           | Configuration for alerts of type `zulip`. <br />See [Configuring Zulip alerts](#configuring-zulip-alerts).                              | `{}`    |
-| `alerting.homeassistant`   | Configuration for alerts of type `homeassistant`. <br />See [Configuring HomeAssistant alerts](#configuring-homeassistant-alerts).        | `{}`    |
+| `alerting.homeassistant`   | Configuration for alerts of type `homeassistant`. <br />See [Configuring HomeAssistant alerts](#configuring-homeassistant-alerts).      | `{}`    |
 
 
 #### Configuring AWS SES alerts
@@ -2473,6 +2474,16 @@ The configuration above will result in a dashboard that looks like this when sor
 ![Gatus Endpoint Groups](.github/assets/endpoint-groups.jpg)
 
 
+### How do I sort by group by default?
+Set `ui.default-sort-by` to `group` in the configuration file:
+```yaml
+ui:
+  default-sort-by: group
+```
+Note that if a user has already sorted the dashboard by a different field, the default sort will not be applied unless the user
+clears their browser's localstorage. 
+
+
 ### Exposing Gatus on a custom path
 Currently, you can expose the Gatus UI using a fully qualified domain name (FQDN) such as `status.example.org`. However, it does not support path-based routing, which means you cannot expose it through a URL like `example.org/status/`.