Jose Henrique
9639c90799
- haven-notify.yaml: replace hand-rolled build+deploy (broken docker/build-push-action remote-builder path) with pipeline-actions build-and-push + deploy-restart composite actions; full Gitea uses: URLs; ubuntu-amd64 runner label. - main.yaml / test-automated-nfs-backup.yaml: fix runner label ubuntu-latest -> ubuntu-amd64. - Remove haven-notify/deploy manifest; it now lives in the haven homelab repo at infra/haven-notify.yaml. Update README accordingly.
Overview
Haven Notify is an internal service designed to send notifications to a specified Discord channel.
It's built in Go and can be deployed as a container or managed service.
Prerequisites
- Go 1.18 or newer
- Docker
- A Discord Webhook URL
API Specification
Send Notification
- Endpoint:
/notify - Method:
POST - Request Body:
{
"title": "Notification Title",
"message": "Notification Message"
}
Send Backup Notification
- Endpoint:
/template/notify/backup - Method:
POST - Request Body:
{
"title": "Notification Title",
"asset": "Notification Asset Name",
"backupSizeInMB": 500,
"extra": [
{
"name": "Additional Info",
"value": "Some extra information"
}
]
}
Send Update Notification
- Endpoint:
/template/notify/update - Method:
POST - Request Body:
{
"host": "Notification Title",
"asset": "Notification Message",
"time": 500 // in seconds
}
Send Error Notification
- Endpoint:
/template/notify/error - Method:
POST - Request Body:
{
"caller": "Who triggered the error",
"message": "Error while moving file",
"critical": true,
"extra": [
{
"name": "Additional Info",
"value": "Some extra information"
}
]
}
Setup & Usage
Docker
- Build the Docker image:
docker build -t haven-notify . - Run the container:
docker run -e WEBHOOK_URL=your_webhook_url haven-notify
Kubernetes
Deployment manifest is available at deploy/haven-notify.yaml.
- Edit the manifest to set your environment variables.
- Create a generic secret named
WEBHOOK_URLwithdiscord-webhook=your_webhook_url:
kubectl create secret generic WEBHOOK_URL --from-literal=discord-webhook=<your_webhook_url> -n <namespace>
- Apply deployment:
kubectl apply -f deploy/haven-notify.yaml