Skip to content

Commit 7baa070

Browse files
committed
Added example config file.
1 parent 3b915b0 commit 7baa070

File tree

2 files changed

+72
-0
lines changed

2 files changed

+72
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ outputs:
6767
broker_port: 1883
6868
```
6969
70+
See `examples/config.yaml` for a complete configuration example with all available options.
71+
7072
### Available Plugins
7173

7274
#### Sources

examples/config.yaml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# eoAPI Notifier Configuration Example
2+
# This file shows how to configure sources and outputs for the notifier
3+
4+
# Sources: Define where notifications come from
5+
sources:
6+
# PostgreSQL/pgSTAC source for database changes
7+
- type: postgres
8+
config:
9+
host: localhost
10+
port: 5432
11+
database: postgis
12+
username: username
13+
password: password
14+
# Optional: specific table patterns to monitor
15+
# tables: ["items", "collections"]
16+
# Optional: connection pool settings
17+
# min_connections: 1
18+
# max_connections: 10
19+
20+
# Outputs: Define where notifications are sent
21+
outputs:
22+
# MQTT output for publishing events
23+
- type: mqtt
24+
config:
25+
broker_host: localhost
26+
broker_port: 1883
27+
# Optional: authentication
28+
# username: mqtt_user
29+
# password: mqtt_password
30+
# Optional: TLS settings
31+
# use_tls: true
32+
# ca_cert: /path/to/ca.pem
33+
# Optional: topic configuration
34+
# topic_prefix: "eoapi/"
35+
# qos: 1
36+
37+
# Example with multiple sources and outputs:
38+
# sources:
39+
# - type: postgres
40+
# config:
41+
# host: db1.example.com
42+
# port: 5432
43+
# database: stac_db
44+
# username: notifier
45+
# password: secret123
46+
#
47+
# - type: postgres
48+
# config:
49+
# host: db2.example.com
50+
# port: 5432
51+
# database: another_db
52+
# username: notifier
53+
# password: secret456
54+
55+
# outputs:
56+
# - type: mqtt
57+
# config:
58+
# broker_host: mqtt.example.com
59+
# broker_port: 8883
60+
# username: publisher
61+
# password: pub_secret
62+
# use_tls: true
63+
#
64+
# # Future: webhook output example
65+
# # - type: webhook
66+
# # config:
67+
# # url: https://api.example.com/notifications
68+
# # headers:
69+
# # Authorization: Bearer token123
70+
# # timeout: 30

0 commit comments

Comments
 (0)