Files
OrbitWard/docs/plugin-design.md
T
Keith Smith 3b75075426 Rename project to OrbitalWard
Add optional TLS certificate expiry checks for website monitors and update product, package, environment, Docker, and documentation naming.
2026-05-23 14:36:28 -06:00

37 lines
706 B
Markdown

# Plugin Design
Plugins will let OrbitalWard add collectors and discovery logic without hard-coding every integration into the core API.
Target shape:
```python
class OrbitalWardPlugin:
name: str
display_name: str
def test_connection(self, target, credentials):
pass
def discover(self, target, credentials):
pass
def collect(self, monitor):
pass
def default_alert_rules(self, discovered_item):
pass
```
The first implementation can use simple internal collectors, but the interfaces should preserve this path.
Planned plugin areas:
- Website checks
- Generic SNMP
- Proxmox VE
- Docker
- UniFi
- TrueNAS
- Technitium DNS
- Active Directory