matt/mailship
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request 'Fix broken NIP-9a link in README and document Node/single-instance requirements' (#21) from mailship-jh5-readme-nip-9a-link-is-empty-broken-897 into main
All checks were successful
CI / checks (push) Successful in 36s
Details

Browse source 
Reviewed-on: #21
Reviewed-by: matt <matt@lorentz.is>
This commit is contained in:
matt 2026-09-18 17:11:24 +00:00
commit 7b75b2f4aa
1 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -1,6 +1,6 @@
# Mailship # Mailship
A Nostr email notification server. Receives events pushed from relays via [NIP-9a](), stores them, and sends daily or weekly digest emails. A Nostr email notification server. Receives events pushed from relays via [NIP-9a](https://github.com/nostr-protocol/nips/pull/2194), stores them, and sends daily or weekly digest emails.
This repo is a fork of [anchor](https://github.com/coracle-social/anchor). It has been built primarily to support email notifications in [Flotilla](https://flotilla.social), but supports alternate branding and could be set up to work with any Nostr relay supporting NIP-9a. This repo is a fork of [anchor](https://github.com/coracle-social/anchor). It has been built primarily to support email notifications in [Flotilla](https://flotilla.social), but supports alternate branding and could be set up to work with any Nostr relay supporting NIP-9a.
@ -79,7 +79,7 @@ Response: { ok: true }
``` ```
### POST /notify/:id ### POST /notify/:id
NIP-9a relay push callback. Called by relays or NPB when matching events are found. [NIP-9a](https://github.com/nostr-protocol/nips/pull/2194) relay push callback. Called by relays or NPB when matching events are found.
``` ```
Body: { id, relay, event? } Body: { id, relay, event? }
@ -112,6 +112,11 @@ Unsubscribe via link from digest email.
## Development ## Development
**Requirements:** Node >= 22
> **Single instance:** Mailship uses in-process cron jobs for digest scheduling.
> Running more than one instance concurrently may cause duplicate or missed emails.
```sh ```sh
pnpm install pnpm install
pnpm run build pnpm run build