Files
ping/README.md
T
Kierre 87499b859e init
2025-10-01 18:28:54 -04:00

21 lines
934 B
Markdown

# velping
a pinger. it pings. this is made specifically for my needs, so you can open an issue for a feature request, but i likely won't accept it unless it's something i want.
## configuration options
### frontend
- `name`: what will show as the header on the landing page.
- `port`: what port the frontend will run on.
- `pings`: how many pings to show on the frontend
### pinging
- `allow_empty_responses`: this does NOT mean HTTP 204, but rather if the connection being suddenly closed after a request should be accepted as online. this option only exists because i run a minecraft server.
- `seconds_between_ping`: how often services should be pinged, in seconds.
### ntfy
- `enabled`: whether or not to enable ntfy.
- `server`: the server to send notifications to.
- `topic`: the ntfy topic.
### services
you can add services here, with the name of the key being the name of the service and the value being the URL to ping.