---
title: ntfy Stack
description: Notification Service for NetGrimoire
published: true
date: 2026-05-01T13:56:08.936Z
tags: docker,swarm,ntfy,netgrimoire
editor: markdown
dateCreated: 2026-05-01T13:56:08.936Z
---

# ntfy

## Overview
The ntfy stack is a Notification Service for NetGrimoire, responsible for managing push notifications and integration with other services.

---

## Architecture
| Service | Image | Port | Role |
|-|-|-|-|
- **Host:** docker4
- **Network:** netgrimoire
- **Exposed via:** <caddy domains from labels: ntfy.netgrimoire.com, caddy.reverse_proxy: ntfy:80>
- **Homepage group:** Notify

---

## Build & Configuration

### Prerequisites
No specific prerequisites are required for this stack.

### Volume Setup
```bash
mkdir -p /DockerVol/ntfy/cache
chown -R user:group /DockerVol/ntfy/cache
```

### Environment Variables
```bash
generate: openssl rand -hex 32
```

### Deploy
```bash
cd services/swarm/stack/ntfy
set -a && source .env && set +a
docker stack config --compose-file ntfy-stack.yml > resolved.yml
docker stack deploy --compose-file resolved.yml ntfy
rm resolved.yml
docker stack services ntfy
```

### First Run
After deployment, verify that the service is running and expose the Caddy reverse proxy.

---

## User Guide

### Accessing ntfy
| Service | URL | Purpose |
|-|-|-|
- **ntfy:** https://ntfy.netgrimoire.com

### Primary Use Cases
To use this service in NetGrimoire, set up notifications for specific events or integrate with other services using the environment variables.

### NetGrimoire Integrations
This service connects to other services via environment variables, such as `CROWDSecs`.

---

## Operations

### Monitoring
```bash
docker stack services ntfy
docker service logs -f ntfy
```

### Backups
Critical services are stored on `/DockerVol/ntfy/cache`. Regular backups can be performed using a cron job.

### Restore
To restore the service, run `./deploy.sh` in the services/swarm/stack/ntfy directory.

---

## Common Failures

| Symptom | Cause | Fix |
|-|-|-|
- No connection to Caddy | Incorrect caddy.reverse_proxy label | Verify that the correct value is set in the docker stack config. |
- Service not running | Insufficient resources on node | Increase resource allocation or upgrade node hardware. |

---

## Changelog

| Date | Commit | Summary |
|-|-|-|
| 2026-05-01 | 983e707b | Initial documentation for ntfy stack |
| 2026-05-01 | de8ddef0 | Update to use swarm configuration |
| 2026-05-01 | f88c14c9 | Add notes section |
| 2026-05-01 | c6ec8a2f | Update changelog format |
| 2026-04-07 | 5058dbe5 | Initial deployment |

Generated by Gremlin on 2026-05-01T13:56:08.936Z
Source: swarm/ntfy.yaml
Review User Guide and Changelog sections