1<p align="center"><img src="docs/img/wordmark.svg" alt="bind.ws" width="320"></p>2<p align="center">Relay on demand. Sign once, and it's yours.</p>34Every name under bind.ws is a nostr relay. Claim one with your nostr key, point any client at `wss://<name>.bind.ws` and it's yours. A relay within its fuel allowances owes nothing. Use beyond them is paid with zaps; retained storage and scheduled work still count when nobody is connected.56Not ready to pick a name? Ask for one:78```9curl -X POST https://bind.ws/lease10```1112That answers with a relay at a memorable name, open to anyone for 14 days. Claim it before then and it stays, events and all.1314<p align="center"><img src="docs/img/relay.png" alt="A relay's page: banner, people, fuel" width="720"></p>1516## What a name gives you1718- **A relay.** The standard protocol plus search, counts, sync, expiry, deletion, proof of work, a discovery record for relay directories and an HTTP door for scripts. Works with every client. Everything past the core, search, sync, counts, the discovery record, names, files, pages and signer traffic, switches off per relay.19- **A community.** Members, invite links, an invite tree, moderators with a log of what they did, a signed roster and one NIP-29 group per relay, so group-aware clients show it as a place.20- **A site.** Notes and articles as pages with link previews, an Atom feed, and a card with a QR of the group address. NIP-5A also serves root, named and snapshot websites from signed manifests on isolated hostnames, with verified files, optional mirroring and sign-in that follows the relay's read rule.21- **Encrypted group transport.** Opt-in Marmot KeyPackages and opaque MLS group messages, with account admission and storage caps for ephemeral authors. Clients manage encryption and group membership.22- **A Git host.** Opt-in GRASP-01 Smart HTTP, backed by [ntig](https://github.com/FelineStateMachine/ntig). Signed NIP-34 state authorizes branch and tag changes; events wait for their Git objects before publication. Hosting has [explicit storage limits](docs/22-grasp-01-git-hosting.md#git-http), and the owner can request a bounded read-only inventory without authorizing deletion.23- **A file host.** Blossom and NIP-96 on the same bucket, with mirroring, pre-flight checks and file reports.24- **A console.** Ten tabs on the relay's own page, signed by a browser extension or a remote signer app on a phone. Presets set up an outbox, an inbox, a private relay, a chat, a search replica, a media host, a quiet relay with every costly feature off or a home with sites, files and Git on, in one click, with the app shortcuts to match. The template collection also includes static sites, public or member-published Marmot transport and Git repositories. The Connect fold shows those shortcuts to anyone who opens the page: the right app, the relay already attached, a QR for a phone.25- **A file.** Everything the console sets, the app shortcuts included, as one document with a schema: check it offline, see what applying would change, apply it, pull it back. Keep your relay in your repository. The presets are the same files, in `relay-templates/`, and the shortcuts they name are files in `connection-templates/`.26- **Jobs.** Pull another relay in, keep a standing mirror, fetch your own history from your relay list, rebroadcast to other relays, and dump everything to a file on a schedule.27- **Your own domain.** `wss://relay.example.com` onto your relay with one CNAME, or a custom hostname targeting one of your static sites.28- **Succession.** Name an heir. If your key goes silent, the relay warns you for a month and then hands itself over.2930<p align="center"><img src="docs/img/console.png" alt="The console's People tab" width="720"></p>3132It runs on Cloudflare Workers with one Durable Object per name, SQLite inside it and R2 beside it. The same code runs without Cloudflare, on [celld](https://celld.dev) with an S3 bucket of your own; that path is checked on demand and [documented](docs/16-hosting-without-cloudflare.md).3334Site hosting and mirroring are on by default; Marmot and GRASP are off until enabled. Their storage shares the existing fuel allowances: manifests, messages and SQLite-backed Git repositories count as events, while mirrored site files count as files. The Health tab and public `/fuel` endpoint show aggregate usage, prices and balance. Traffic is visible but uncharged; provider operations are not itemized there. See [Understanding fuel](docs/02-understanding-fuel.md) and [Costs and margins](docs/15-costs-and-margins.md).3536## Docs3738**For users**3940- [Getting started](docs/00-getting-started.md): try one, claim a name, connect, invite.41- [Relay configuration](docs/01-relay-configuration.md): the console, tab by tab.42- [Understanding fuel](docs/02-understanding-fuel.md): what is measured, what is free, what a zap buys.43- [People and groups](docs/03-people-and-groups.md): members, invites, moderators, groups, handing over.44- [Data and names](docs/04-data-and-names.md): list recovery, delivery, imports, backups, presets and forks.45- [Your relay on the web](docs/05-your-relay-on-the-web.md): pages, static sites, Git hosting, feed, card, custom domains and media.4647**For scripts and agents**4849- [Scripts and agents](docs/13-scripts-and-agents.md): a relay end to end with a key and curl, every management method including Git storage inventory, the relay as a configuration file, and a finite production network exercise.50- [HTTP reference](docs/14-http-reference.md): every path, method, auth and answer.5152**For developers**5354- [Architecture](docs/10-architecture.md): routing, the object, storage, alarm, jobs, identity, groups.55- [Hosting bind.ws](docs/11-hosting-bindws.md): run your own on your own domain, and watch it through logs, traces and metrics.56- [Hosting without Cloudflare](docs/16-hosting-without-cloudflare.md): the same Worker on celld, with your own bucket and proxy, and what "supported" promises.57- [Develop and extend](docs/12-develop-extend.md): layout, tests, adding methods and NIPs, the console, the templates.58- [Connection templates](docs/17-connection-templates.md): the app shortcuts on the Connect fold, the template file, its placeholders, the owner's list, `/connect.json`, and how to add one.59- [Costs and margins](docs/15-costs-and-margins.md): application budgets, retained storage, inventory interpretation and deployment margins.6061### Draft NIPs6263- [NIP-5A static websites](docs/20-nip-5a-static-websites.md): publish and serve static sites from signed Nostr manifests.64- [NIP-AD web addresses](docs/23-nip-ad-web-addresses.md): resolve relay, article and site URLs to their Nostr counterparts.65- [GRASP-01 Git hosting](docs/22-grasp-01-git-hosting.md): host bounded NIP-34 repositories through Git Smart HTTP.66- [NIP-86 membership claims](docs/24-nip86-claims.md): create, list and revoke invitation codes through the standard management methods.67- [NIP-9a relay push](docs/25-nip-9a-relay-push.md): opt-in callback delivery, privacy, bounds and operator setup.68- [NIP-11 identifier compatibility](docs/26-nip11-compatibility.md): lettered capabilities and concrete client parser behavior.6970### Protocol guides7172- [Marmot transport](docs/21-marmot-transport.md): carry KeyPackages and opaque MLS group messages through a relay.7374## Quick start7576```77npm install78npm run dev # http://<name>.localhost:878779npm test80npm run typecheck # types, generated files, the configs, every template81npm run deploy82```8384## Protocol surface8586NIP-01, 05, 09, 11, 13, 17, 29, 40, 42, 43, 45, 46 transport, 50, 56, 57, 59, 62, 66, 67, 70, 77, 86, 94, 96, 98, Marmot transport and Blossom BUD-01, 02, 04, 06, 08, 09. A relay's information document lists what its owner left on.8788NIP-5A site discovery uses the `nsites` field. GRASP advertises only locally89validated, enabled profiles. GRASP-01 and validated GRASP-06 are currently90advertised; GRASP-02/03/05 are bounded opt-in previews pending interoperability91and conformance review. `grasp02` and `grasp06` require `grasp`, while92`grasp03` and `grasp05` require `grasp02`. Private repositories and any93profile without its dependencies remain outside the advertised capabilities.9495## License9697MIT