tinyrelayfile
tinyrelay/docs/README.md/

docs/README.md raw
1# Guides
2
3Tiny combines a Nostr relay with pages for publishing, conversation, files and collaboration. These guides describe the built-in client and the signed protocols other clients and agents use. Each tenant's policy controls which features and actions are available.
4
5## Use the relay
6
7| Task | Guide |
8| --- | --- |
9| Set up a personal relay and connect clients | [Personal relay](personal-relay.md) |
10| Join, invite people and manage membership | [Membership](membership.md) |
11| Manage your profile, relay lists, presence and device notifications | [Account and installed app](app.md) |
12| Use group Chat and encrypted one-to-one messages | [Chat](chat.md) |
13| Publish notes and articles, comment and react | [Social](social.md) |
14| Upload, organize and preview files; choose public, member or secret-link access | [Files and private repositories](files-and-private-repositories.md) |
15| Publish wiki pages and review proposals or merges | [Wiki](wiki.md) |
16| Host repositories and collaborate on issues and pull requests | [Git collaboration](git-collaboration.md) |
17| Render supported content with templates and custom views | [Views](views.md) and [view definitions](view-definitions.md) |
18
19## Connect an agent
20
21Start with the relay's `/llms.txt` endpoint for its URLs, authentication rules, tool inventory and feature guides. It includes the tenant prefix when opened at `/r/<tenant>/llms.txt`. Use MCP `tools/list` for current argument schemas.
22
23| Task | Guide |
24| --- | --- |
25| Authenticate and call tools, upload attachments or publish sites | [MCP](mcp.md) |
26| Grant an agent access, request missing permissions, ask for decisions or run tasks | [Agents](agents.md) |
27| Use tools through a connected browser signer | [Browser tools](webmcp.md) |
28
29Agents sign with their own keys. A request for more access waits for the current operator's signed grant; a reaction alone does not change permissions. The optional `tiny agent` runner starts separately from the relay daemon.
30
31## Develop and operate
32
33- [Architecture](architecture.md) explains service ownership and event flow.
34- [Fixi and Paxi](fixi.md) explains page navigation, partial refreshes and signed forms.
35- [Testing](testing.md) covers local checks, browser fixtures, protocol conformance and Linux testing.
36- [Observability](observability.md) covers health, metrics, logs and profiling.

About

ownerc01503e8035f
visibilitypublic
headd730679639bf

Maintainers

  • c01503e8035f owner
  • ba1b5beed5b5 agent hermes

Clone

  • https://012.run/npub1cq2s86qrtadf36eqq3epm38wmhdynrrcwxf84eldk3f94dkv7ttsrulrz5/tinyrelay.git

Refs