8.9 KiB
Self-hosted ntfy delivery
Every stage can have an optional notify property block. Notifications go to
your own ntfy instance and can attach Markdown and output files. It does not ask
an LLM to handle credentials or run curl. The full Markdown remains in the run
audit as well as the ntfy attachment. A separate HTML report viewer is not included.
Per-stage notifications (recommended)
# stage compose
```notify
on=success,failure
artifacts=markdown,files
```
...stage output, prompt, tools, edges, and configs...
onissuccess,failure, orsuccess,failure. A failure is an execution error, theerroroutcome, or a route to#failure; any other completed stage is a success. This reports the stage's result, not the final run's result.- All notification hooks use one system-wide server-to-phone connection. Stages
do not choose topics or addresses. Configure
PIPELINES_NTFY_URL(publishing topic URL),PIPELINES_NTFY_PUBLIC_URL(phone-facing server base URL), andPIPELINES_NTFY_TOKENorPIPELINES_NTFY_TOKEN_FILEonce on the server. The topic ispipelinesin the provided setup. No block means no notifications. Legacydestinationlines remain parseable for immutable-history compatibility but no longer select a connection for notification hooks. Explicit nativetype=ntfystages retain their separate destination configuration. artifacts=markdownsends the string inoutput.markdownasdigest.md.artifacts=filessends paths listed inoutput.artifacts, e.g.["reports/result.txt", "screenshots/chart.png"]. Model stages with this policy are instructed to list files they actually created/modified. No workspace scan or file discovery occurs; an invalid model response may leave no artifact list.- Both artifact kinds can be selected. Each file gets a separate notification (ntfy supports one attachment per notification). If none were produced, an event-only notification is still sent, including on failure.
- Files must be workspace-relative regular files, at most 1 MiB each and 10 files
per stage. Traversal, absolute paths, symlinks, hidden paths, known database/key
paths,
secrets/, andnode_modules/are rejected. These guards are not a content scanner/DLP system: only list files you intend to share. - Notifications have a 30-second total budget, with no automatic retries. Their
receipts/failures appear in the selected run stage's Metadata, separately
from output. They do not change routing or convert a successful stage into a
failed run. A crash can leave a
sendingreceipt with uncertain delivery; notifications are not replayed during recovery. Tool access follows the stage's declared tools; notification settings do not grant additional tools.
Explicit delivery stage (optional)
The preceding stage must output three nonempty UTF-8 strings: title, summary,
and markdown. Title/summary must be single-line (256/2048 byte limits); Markdown
is limited to 1 MiB. Native delivery stages do not accept model prompts/tools or
inline credentials. They require destination and a success edge:
# stage notify
```configs
type=ntfy
destination=anime
```
```edges
success -> #success
error -> #failure
```
Configure the pipeline server process outside the pipeline file:
export PIPELINES_NTFY_ANIME_URL='https://ntfy.your-domain.example/anime'
# Set PIPELINES_NTFY_ANIME_TOKEN securely to a publishing user's access token.
go run ./cmd/pipelines-server
The URL includes one topic, without credentials, query parameters, or a fragment.
Other destinations use the same pattern: destination=reports reads
PIPELINES_NTFY_REPORTS_URL and PIPELINES_NTFY_REPORTS_TOKEN (or _TOKEN_FILE
pointing to a secret file). Set only one token source. Destination names
use lowercase letters, digits, and underscores. A token is optional only when
the configured server permits anonymous publishing; private deployments need it.
Never put tokens in a prompt, committed file, or chat. Environment credentials
are inherited by subprocesses: do not grant untrusted stages shell/code-execution
access. Prefer a dedicated publishing user with write-only access to this topic.
Local server
The root compose.yaml runs both the pipeline server and ntfy with persistent
volumes, internal service networking, and a private topic. See the
Docker + Android setup for bootstrap, credentials, and timezone
detection. The previous ntfy-only Compose file has been replaced. Isolated real
Docker health and publishing checks have passed; phone reception and the user's
remote Tailscale connectivity remain not tested locally.
Use a TLS reverse proxy or a private VPN (e.g. Tailscale). A phone cannot reach
your computer's 127.0.0.1; that address is only for local publishing/proxying.
To bind the container to a particular LAN/VPN interface, explicitly set
NTFY_BIND_ADDRESS to that interface IP. Do not expose an unauthenticated server,
or send access tokens over public plain HTTP. Set NTFY_BASE_URL to the same
address your phone uses so attachment URLs resolve correctly. If the pipeline
server is another container, localhost is that container, not the ntfy host.
Phone
Tailscale address times out while LAN works
Use http://<server-Tailscale-IP>:8090, not port 80; enable Tailscale on both the
server and phone. The default Compose mapping binds ntfy to 0.0.0.0:8090.
Binding to all interfaces does not bypass tailnet grants/ACLs, host firewalls,
or Docker forwarding rules. A timeout alone cannot identify which is blocking.
Do not disable firewalls or publicly forward this port as a workaround.
On the server, these are read-only diagnostics (the remote checks are not tested from this development machine):
tailscale status
docker compose port ntfy 80
curl --connect-timeout 5 http://127.0.0.1:8090/v1/health
curl --connect-timeout 5 "http://$(tailscale ip -4):8090/v1/health"
If the host health checks succeed but the phone times out, check that the phone
is in the intended tailnet and that tailnet access rules/firewalls allow this
phone to reach server TCP 8090. Once reachable, log in as phone-reader for the
Tailscale server entry, separately from the LAN entry. Set NTFY_BASE_URL to a
phone-reachable address if attachment URLs currently point to a LAN-only address;
that setting is not a substitute for fixing a TCP timeout.
Install the ntfy app, add your own server, authenticate with the reader account,
and subscribe to anime. Ensure notifications and required background operation
are allowed. Outside your home network, both topic subscriptions and attachment
downloads need access to your server through VPN or public HTTPS.
For iOS instant notifications, ntfy's current documentation requires
NTFY_UPSTREAM_BASE_URL=https://ntfy.sh (or an APNS-connected upstream with a
custom app). The upstream sends wake-up requests; message content is fetched
from your instance. This is not completely independent of third-party push
infrastructure. Without upstream forwarding, delivery can be substantially
delayed. Phone delivery/background behavior has not been tested here.
Execution and failure behavior
- Publishing is bounded to 20 seconds and does not follow redirects.
- No automatic publish retry: timeouts or malformed acknowledgments may mean the notification was delivered but its acknowledgment was lost. Inspect ntfy before retrying an ambiguous failure.
- For the optional native
type=ntfystage, a confirmed response addsdeliverymetadata (destination name, message ID, attachment URL, filename) to the existing output. Failures take the error route and are recorded in normal run/step audits, without remote response bodies or credentials in diagnostics. - Repeating the same run request key does not publish again. A new run or a graph loop visiting delivery again can send another notification; content-level "only new items" deduplication is not yet implemented. For the initial digest, keep notification last with no feedback edge.
- Markdown reports remain available in pipeline run history even after ntfy expires its attachment. Configure ntfy retention for your needs; its attachment directory must be dedicated to ntfy, not shared with other files.
File-attachment bytes are stored by ntfy, not permanently archived in SQLite; run metadata stores the delivered filename/URL, and workspace files may later change. Download attachments before your ntfy retention expires.
Bundled starters do not require notification or schedule setup. Add a notify
block to the stages of your own workflow using the example above; configure the
system phone connection first. Adding a schedule activates it on publication,
so review it explicitly rather than copying a scheduled niche example.
References: publishing, server configuration, iOS self-hosting.