[READ-ONLY] Mirror of https://github.com/FoxxMD/deploy-ntfy-alerter.
feat: Add initial implementation
+91
-1
+21
LICENSE
+21
LICENSE
···
1
+
MIT License
2
+
3
+
Copyright (c) 2024 Matt Foxx
4
+
5
+
Permission is hereby granted, free of charge, to any person obtaining a copy
6
+
of this software and associated documentation files (the "Software"), to deal
7
+
in the Software without restriction, including without limitation the rights
8
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+
copies of the Software, and to permit persons to whom the Software is
10
+
furnished to do so, subject to the following conditions:
11
+
12
+
The above copyright notice and this permission notice shall be included in all
13
+
copies or substantial portions of the Software.
14
+
15
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+
SOFTWARE.
+59
-1
README.md
+59
-1
README.md
···
1
-
# deploy-ntfy-alerter
1
+
# Deploy a Gotify [Alerter](https://komo.do/docs/resources#alerter)
2
+
3
+
Part of the [*Komodo Hub* collection.](https://github.com/komodo-hub/komodo-hub)
4
+
5
+
Deploys an [Alerter](https://komo.do/docs/resources#alerter) that pushes to [ntfy](https://ntfy.sh/). Docker image built from [foxxmd/komodo-utilities](https://github.com/FoxxMD/komodo-utilities).
6
+
7
+
## Requirements
8
+
9
+
* A running ntfy instance ([installation docs](https://docs.ntfy.sh/))
10
+
* A topic to push to
11
+
12
+
## Komodo Resource TOML
13
+
14
+
```toml
15
+
[[stack]]
16
+
name = "ntfy-alerter"
17
+
[stack.config]
18
+
repo = "foxxmd/deploy-ntfy-alerter"
19
+
file_paths = [
20
+
"compose.yaml",
21
+
]
22
+
environment = """
23
+
## Required
24
+
25
+
# Your Gotify instance URL
26
+
NTFY_URL = https://ntfy.example.com
27
+
28
+
# App Token created for Komodo
29
+
NTFY_TOPIC = MyTopic
30
+
31
+
## Optional
32
+
33
+
# Auth
34
+
#NTFY_USER=[[NTFY_USER]]
35
+
#NTFY_PASSWORD=[[NTFY_PASSWORD]]
36
+
37
+
# Set the Gotify Priority level based on Komodo alert severity
38
+
#NTFY_OK_PRIORITY=3
39
+
#NTFY_WARNING_PRIORITY=5
40
+
#NTFY_CRITICAL_PRIORITY=8
41
+
"""
42
+
43
+
[[variable]]
44
+
name = "NTFY_USER"
45
+
value = "MyUser"
46
+
is_secret = true
47
+
48
+
[[variable]]
49
+
name = "NTFY_PASSWORD"
50
+
value = "MyPass"
51
+
is_secret = true
52
+
53
+
[[alerter]]
54
+
name = "ntfy"
55
+
[alerter.config]
56
+
enabled = true
57
+
endpoint.type = "Custom"
58
+
endpoint.params.url = "http://ntfy-alerter-ip:7000"
59
+
```