Skip to content

Conversation

@muzy
Copy link
Contributor

@muzy muzy commented Sep 4, 2025

Clarify usage of environment variables in configuration file and provide guidance for escaping special characters.

Summary

Documentation fix for issue #1240

Checklist

  • Tested and/or added tests to validate that the changes work as intended, if applicable.
  • Updated documentation in README.md, if applicable.

…ration

Clarify usage of environment variables in configuration file and provide guidance for escaping special characters.
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 4, 2025
Copy link
Owner

@TwiN TwiN left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please include this near the existing documentation about environment variables.

Move comment about escaping to the section with env variables.
@muzy
Copy link
Contributor Author

muzy commented Sep 4, 2025

Moved the information to the section about environment variables.

@TwiN TwiN merged commit 412b6d3 into TwiN:master Sep 16, 2025
@muzy muzy deleted the patch-1 branch September 17, 2025 05:31
alexlebens pushed a commit to alexlebens/infrastructure that referenced this pull request Sep 18, 2025
This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [ghcr.io/twin/gatus](https://github.com/TwiN/gatus) | minor | `v5.23.2` -> `v5.24.0` |

---

### Release Notes

<details>
<summary>TwiN/gatus (ghcr.io/twin/gatus)</summary>

### [`v5.24.0`](https://github.com/TwiN/gatus/releases/tag/v5.24.0)

[Compare Source](TwiN/gatus@v5.23.2...v5.24.0)

Another big update worthy of highlights. There are 3 big changes coming to Gatus with this release.

- **Suites** (ALPHA): To keep it short, this allows you to monitor a list of endpoints in order, but those endpoints have a shared context that allows you to store values and compare or use them in other endpoints. For more information, see <TwiN/gatus#1241>
- **New alerting providers**: 14 new alerting providers have been added, but there's a catch. I don't have time to test this many providers, so I'm trying something new, namely, letting users who want to use those alerting providers test them for me. For more information, see <TwiN/gatus#1223>
- **RDAP support for `[DOMAIN_EXPIRATION]` placeholder**: Some TLDs have started dropping support for WHOIS, as such, support for RDAP has been added. WHOIS will still be used as a fallback if RDAP fails to resolve the domain expiration of a domain.

I am very excited to finally have made some progress on suites. It's missing some features, and it required a lot of redesigning, so I expect some complaints, but with suites, the possibilities feel endless. You can monitor entire workflows, simulate complex user behavior, not just READ-type of behavior, but WRITE as well, as you can configure an endpoint to run even if the workflow fails to clean up whatever resource you created, and so much more. Suites have some serious potential.

#### What's Changed

- feat(suite): Implement Suites by [@&#8203;TwiN](https://github.com/TwiN) in [#&#8203;1239](TwiN/gatus#1239)
- feat(alerting): Add new providers for Datadog, IFTTT, Line, NewRelic, Plivo, RocketChat, SendGrid, Signal, SIGNL4, Splunk, Squadcast, Vonage, Webex and Zapier by [@&#8203;TwiN](https://github.com/TwiN) in [#&#8203;1224](TwiN/gatus#1224)
- feat(client): Add RDAP support for domain expiration by [@&#8203;ju-ef](https://github.com/ju-ef) in [#&#8203;1181](TwiN/gatus#1181)
- feat(client): starttls support for dns resolver by [@&#8203;eleith](https://github.com/eleith) in [#&#8203;1253](TwiN/gatus#1253)
- fix(alerting): Adjust minimum reminder config parsing by [@&#8203;xconverge](https://github.com/xconverge) in [#&#8203;1226](TwiN/gatus#1226)
- fix(client): add forward ip support in PTR query-name by [@&#8203;denis-ev](https://github.com/denis-ev) in [#&#8203;1261](TwiN/gatus#1261)
- docs: Fix typo in Zulip configuration section by [@&#8203;XavierDupuis](https://github.com/XavierDupuis) in [#&#8203;1220](TwiN/gatus#1220)
- docs: information on escaping endpoint url in config by [@&#8203;muzy](https://github.com/muzy) in [#&#8203;1242](TwiN/gatus#1242)

#### New Contributors

- [@&#8203;XavierDupuis](https://github.com/XavierDupuis) made their first contribution in [#&#8203;1220](TwiN/gatus#1220)
- [@&#8203;eleith](https://github.com/eleith) made their first contribution in [#&#8203;1253](TwiN/gatus#1253)
- [@&#8203;ju-ef](https://github.com/ju-ef) made their first contribution in [#&#8203;1181](TwiN/gatus#1181)
- [@&#8203;denis-ev](https://github.com/denis-ev) made their first contribution in [#&#8203;1261](TwiN/gatus#1261)
- [@&#8203;muzy](https://github.com/muzy) made their first contribution in [#&#8203;1242](TwiN/gatus#1242)

**Full Changelog**: <TwiN/gatus@v5.23.2...v5.24.0>

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MS4xMTYuNSIsInVwZGF0ZWRJblZlciI6IjQxLjExNi41IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJpbWFnZSJdfQ==-->

Reviewed-on: https://gitea.alexlebens.dev/alexlebens/infrastructure/pulls/1491
Co-authored-by: Renovate Bot <[email protected]>
Co-committed-by: Renovate Bot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants