[READ-ONLY] Mirror of https://github.com/FoxxMD/deploy-ntfy-alerter.
Update readme to add more setup approaches
+103
-2
+103
-2
README.md
+103
-2
README.md
···
11
11
* A running ntfy instance ([installation docs](https://docs.ntfy.sh/))
12
12
* A topic to push to
13
13
14
-
## Komodo Resource TOML
14
+
## Deploying
15
+
16
+
Use **either** of the methods below.
17
+
18
+
### Komodo Resource Sync
19
+
20
+
<details>
21
+
22
+
Create a [Resource Sync](https://komo.do/docs/sync-resources) with the TOML configuration below to
23
+
24
+
* create the [Stack](https://komo.do/docs/resources#stack) to run deploy-ntfy-alerter
25
+
* add the Ntfy User/Password or Token [Variable](https://komo.do/docs/variables) and
26
+
* setup the [Alerter](https://komo.do/docs/resources#alerter) + configuration
27
+
28
+
Steps:
29
+
30
+
* Open Komodo Dashboard -> Syncs -> **New Resource Sync**
31
+
* Choose Mode -> UI Defined
32
+
* Toggle the following to active:
33
+
* Managed
34
+
* Include Sync Resources
35
+
* Include Sync Variables
36
+
37
+
Add the below configuration to **Resource File** field and then modify variables for your environment (NTFY_URL, endpoint.params.url, etc...)
15
38
16
39
```toml
17
40
[[stack]]
···
85
108
enabled = true
86
109
endpoint.type = "Custom"
87
110
endpoint.params.url = "http://ntfy-alerter-ip:7000"
88
-
```
111
+
```
112
+
113
+
**Save** the sync and then **Execute Sync** to create the Alerter.
114
+
115
+
</details>
116
+
117
+
## Manual setup
118
+
119
+
<details>
120
+
121
+
Create a new [**Stack**](https://komo.do/docs/resources#stack) with the following for `compose.yaml` file.
122
+
123
+
```yaml
124
+
services:
125
+
komodo-ntfy:
126
+
image: foxxmd/komodo-ntfy-alerter:latest
127
+
restart: unless-stopped
128
+
env_file:
129
+
- ./.env
130
+
ports:
131
+
- "7000:7000"
132
+
```
133
+
134
+
Add the following to the Stack -> Config -> Environment section:
135
+
136
+
```ini
137
+
## Required
138
+
139
+
## Your ntfy instance URL
140
+
NTFY_URL = https://ntfy.example.com
141
+
142
+
## Topic to be used for for Komodo
143
+
NTFY_TOPIC = MyTopic
144
+
145
+
## Optional
146
+
147
+
## Auth
148
+
149
+
## https://docs.ntfy.sh/publish/#username-password
150
+
#NTFY_USER=[[NTFY_USER]]
151
+
#NTFY_PASSWORD=[[NTFY_PASSWORD]]
152
+
## https://docs.ntfy.sh/publish/#access-tokens
153
+
#NTFY_TOKEN=[[NTFY_TOKEN]]
154
+
155
+
# Below need to add to `compose.yaml` as well
156
+
157
+
## Set the ntfy Priority level based on Komodo alert severity
158
+
#NTFY_OK_PRIORITY=3
159
+
#NTFY_WARNING_PRIORITY=5
160
+
#NTFY_CRITICAL_PRIORITY=8
161
+
162
+
# Set whether to include Komodo Severity Level in notification title
163
+
#LEVEL_IN_TITLE=true
164
+
165
+
# Prefixes messages with a checkmark when the Alert is in the 'Resolved' state
166
+
#INDICATE_RESOLVED=true
167
+
168
+
# Filter if an alert is pushed based on its Resolved status
169
+
# * leave unset to push all alerts
170
+
# * otherwise, alerts will only be pushed if Alert is one of the comma-separated states set here
171
+
#ALLOW_RESOLVED_TYPE=resolved,unresolved
172
+
173
+
## Delay alerts with below types for X milliseconds
174
+
## and cancel pushing alert if it is resolved within that time
175
+
#UNRESOLVED_TIMEOUT_TYPES=ServerCpu,ServerMem
176
+
#UNRESOLVED_TIMEOUT=2000
177
+
```
178
+
179
+
Make sure to replace placeholder values. `[[NTFY_USER]]` is a Komodo [Variable](https://komo.do/docs/variables).
180
+
181
+
After deploying the Stack create a new [Alerter](https://komo.do/docs/resources#alerter)
182
+
183
+
* **Endpoint:** `Custom`
184
+
* In the Endpoint field set the IP:PORT of the `komodo-ntfy-alerter` stack you created IE `http://192.168.YOUR.IP:7000`
185
+
* Optionally, set any **Alert Types** you may need
186
+
187
+
**Save** the Alerter and then **Test Alerter** to make sure everything is ready to use.
188
+
189
+
</details>