blossom/README.md

🌸 Blossom - Blobs stored simply on mediaservers

Blossom uses nostr public / private keys for users identities.

What is it?

Blossom is a specification for a set of HTTP endpoints that allow users to store blobs of data on publicly accessible servers

What are blobs

Blobs are packs of binary data addressed by their sha256 hash

Protocol specification (BUDs)

BUDs or Blossom Upgrade Documents are short documents that outline an additional feature that a blossom server may implement.

BUDs

• BUD-00: Blossom Upgrade Documents
• BUD-01: Server requirements and blob retrieval
• BUD-02: Blob upload and management
• BUD-03: User Server List
• BUD-04: Mirroring blobs
• BUD-05: Media optimization
• BUD-06: Upload requirements
• BUD-07: Payment required
• BUD-08: Nostr File Metadata Tags
• BUD-09: Blob Report
• BUD-10: Blossom URI Schema
• BUD-11: Nostr Authorization

Endpoints

Blossom Servers expose a few endpoints for managing blobs

• GET /<sha256> (optional file .ext) BUD-01
• HEAD /<sha256> (optional file .ext) BUD-01
• PUT /upload BUD-02
  • Authentication: Signed nostr event (see BUD-02)
  • Return a blob descriptor
• HEAD /upload BUD-06
• GET /list/<pubkey> BUD-02 (optional, unrecommended)
  • Returns an array of blob descriptors
  • Authentication (optional): Signed nostr event (see BUD-02)
• DELETE /<sha256> BUD-02
  • Authentication: Signed nostr event (see BUD-02)
• PUT /mirror BUD-04
  • Authentication: Signed nostr event (see BUD-02)
• HEAD /media BUD-05
• PUT /media BUD-05
  • Authentication: Signed nostr event (see BUD-05)
• PUT /report BUD-09

Event kinds

kind	description	BUD
24242	Authorization token	11
10063	User Server List	03

License

Public domain.