Documentation

Everything you need to use, integrate or self-host this Nostr server.

Endpoints

Wire protocols exposed by this server. Click a row to copy the URL.

NIP-96 https://blossom.terlaos.com/.well-known/nostr/nip96.json
GET Service info JSON: api_url, download_url, supported MIMEs, plans, content type policy.
Blossom https://blossom.terlaos.com
HTTPS Blob root. GET /<sha256>, HEAD /<sha256>, PUT /upload, PUT /mirror, DELETE /<sha256>. Auth via BUD-11 (Nostr-signed event header).
NIP-05 https://blossom.terlaos.com/.well-known/nostr.json
GET ?name=<local-part> → JSON with names map and optional relays, nip96 fields.

Active modules

REST API surface. Each module links to its wiki chapter.

ModulePathMethodsDescription
nostraddress /nostraddress GET This module returns the pubkey for a nostraddress name for each domain.
media /media GET POST PUT DELETE This module handles file uploads, downloads, delete, mirror, file tags, etc.
lightning /lightningaddress GET PUT DELETE This module handles ightning redirections for a nostraddress.
verify /verify POST This module can verify a nostr note integrity and timestamp.
register /register POST This module handles usernames creation from trusted pubkeys.
domains /domains GET PUT This module handle lists of registered domains and usernames.
admin /admin GET POST Admin API, reboot, update remove and modify fields, server status, etc.
frontend / GET POST This module handles the frontend, login page, register, dashboard, etc.
security / Library This module handles security, ip logs, automatic ban, etc.
logger / Library This module manages the server logs engine.

More on the wiki: Configuration · Multi-tenancy · Plugins

Supported BUDs (Blossom)

Blossom Upgrade Documents implemented by this server.

Self-host this server

This server runs nostrcheck-server, an open-source project (MIT). You can run your own instance — same software, your rules.

View on GitHub