zeroclaw/docs
Kieran 11edda3ed6 feat(channel): add Nostr channel with NIP-04 and NIP-17 support
Adds a full NostrChannel implementation enabling ZeroClaw to send and
receive private messages over the Nostr protocol via user-configured
relay WebSocket connections.

Key design decisions:
- Implements the Channel trait in src/channels/nostr.rs; registered via
  the existing factory in channels/mod.rs
- Supports both NIP-04 (legacy encrypted DMs) and NIP-17 (gift-wrapped
  private messages); replies automatically mirror the sender's protocol
- Deny-by-default allowlist (allowed_pubkeys = [] denies all)
- Private key encrypted at rest via SecretStore (ChaCha20-Poly1305 AEAD)
  when secrets.encrypt = true (the default)
- nostr-sdk added with default-features = false and only nip04 + nip59
  features to minimise binary size impact
- health_check() returns true if any relay reports is_connected()

Wiring:
- New NostrConfig struct and optional field in ChannelsConfig
- has_supervised_channels() in daemon updated to include nostr
- Onboarding wizard extended with a dedicated Nostr step (key
  validation, relay selection, allowlist configuration)

Docs compliance:
- channels-reference.md: channel matrix, delivery modes table, allowlist
  field names, numbered config section (4.12), log keyword table (7.2),
  and log filter command all updated
- config-reference.md: [channels_config.nostr] sub-section with key
  table and security notes added
- network-deployment.md and README.md updated
- .github/pull_request_template.md: resolved stale conflict markers from
  chore/labeler-spacing-trusted-tier
2026-02-21 13:16:20 +08:00
..
contributing docs: overhaul docs IA and multilingual navigation 2026-02-18 18:06:13 +08:00
datasheets Ehu shubham shaw contribution --> Hardware support (#306) 2026-02-16 11:40:10 -05:00
getting-started docs(i18n): add Vietnamese translations for docs hub and key references 2026-02-21 02:30:37 +08:00
hardware docs: enhance getting-started, hardware, and project collection indexes 2026-02-19 13:04:11 -08:00
i18n docs(i18n): introduce canonical docs/i18n/vi tree with compatibility shims 2026-02-21 12:12:26 +08:00
operations fix(ci): sync release publishing with GHCR and add runbook (#1087) 2026-02-20 07:10:09 -05:00
project docs: enhance getting-started, hardware, and project collection indexes 2026-02-19 13:04:11 -08:00
reference feat(channel): add native nextcloud talk webhook integration 2026-02-20 23:28:18 +08:00
security docs: overhaul docs IA and multilingual navigation 2026-02-18 18:06:13 +08:00
vi style(docs/vi): polish Vietnamese translations for natural readability 2026-02-21 02:16:53 +08:00
actions-source-policy.md ci(cache): migrate rust cache actions to useblacksmith (#706) 2026-02-17 18:05:31 -05:00
adding-boards-and-tools.md docs(config): align inline comments and sync model defaults 2026-02-18 18:06:13 +08:00
agnostic-security.md docs: overhaul docs IA and multilingual navigation 2026-02-18 18:06:13 +08:00
architecture.svg refactor: simplify CLI commands and update architecture docs 2026-02-14 05:17:16 -05:00
arduino-uno-q-setup.md feat: reduce release binary size with opt-in heavy features 2026-02-21 02:23:59 +08:00
audit-logging.md docs: overhaul docs IA and multilingual navigation 2026-02-18 18:06:13 +08:00
channels-reference.md feat(channel): add Nostr channel with NIP-04 and NIP-17 support 2026-02-21 13:16:20 +08:00
ci-map.md fix(ci): sync release publishing with GHCR and add runbook (#1087) 2026-02-20 07:10:09 -05:00
commands-reference.md feat(provider): add first-class vLLM provider flow 2026-02-21 12:33:00 +08:00
commands-reference.vi.md docs(i18n): introduce canonical docs/i18n/vi tree with compatibility shims 2026-02-21 12:12:26 +08:00
config-reference.md feat(channel): add Nostr channel with NIP-04 and NIP-17 support 2026-02-21 13:16:20 +08:00
config-reference.vi.md docs(i18n): introduce canonical docs/i18n/vi tree with compatibility shims 2026-02-21 12:12:26 +08:00
custom-providers.md feat(provider): add first-class vLLM provider flow 2026-02-21 12:33:00 +08:00
doc-template.md feat(proxy): add scoped proxy configuration and docs runbooks 2026-02-18 22:10:42 +08:00
docs-inventory.md docs(i18n): add Vietnamese links to all locale READMEs and docs navigation 2026-02-21 02:23:51 +08:00
frictionless-security.md chore: Remove more blocking io calls 2026-02-19 18:04:55 +08:00
Hardware_architecture.jpg Ehu shubham shaw contribution --> Hardware support (#306) 2026-02-16 11:40:10 -05:00
hardware-peripherals-design.md Ehu shubham shaw contribution --> Hardware support (#306) 2026-02-16 11:40:10 -05:00
i18n-coverage.md docs(i18n): introduce canonical docs/i18n/vi tree with compatibility shims 2026-02-21 12:12:26 +08:00
langgraph-integration.md docs(docs): align navigation inventory and model examples for #774 2026-02-18 22:53:21 +08:00
matrix-e2ee-guide.md fix(matrix): send markdown replies and improve e2ee diagnostics 2026-02-19 10:23:10 +08:00
mattermost-setup.md docs(mattermost): document mention_only behavior 2026-02-18 21:25:28 +08:00
network-deployment.md feat(channel): add Nostr channel with NIP-04 and NIP-17 support 2026-02-21 13:16:20 +08:00
nextcloud-talk-setup.md feat(channel): add native nextcloud talk webhook integration 2026-02-20 23:28:18 +08:00
nucleo-setup.md docs: overhaul docs IA and multilingual navigation 2026-02-18 18:06:13 +08:00
one-click-bootstrap.md feat: add SELinux relabel and correct user namespace mapping for podman 2026-02-21 02:23:53 +08:00
one-click-bootstrap.vi.md docs(i18n): introduce canonical docs/i18n/vi tree with compatibility shims 2026-02-21 12:12:26 +08:00
operations-runbook.md docs: overhaul docs IA and multilingual navigation 2026-02-18 18:06:13 +08:00
pr-workflow.md feat(proxy): add scoped proxy configuration and docs runbooks 2026-02-18 22:10:42 +08:00
project-triage-snapshot-2026-02-18.md docs: overhaul docs IA and multilingual navigation 2026-02-18 18:06:13 +08:00
providers-reference.md feat(provider): add first-class vLLM provider flow 2026-02-21 12:33:00 +08:00
proxy-agent-playbook.md feat(proxy): add scoped proxy configuration and docs runbooks 2026-02-18 22:10:42 +08:00
README.fr.md docs(i18n): introduce canonical docs/i18n/vi tree with compatibility shims 2026-02-21 12:12:26 +08:00
README.ja.md docs(i18n): introduce canonical docs/i18n/vi tree with compatibility shims 2026-02-21 12:12:26 +08:00
README.md docs(i18n): introduce canonical docs/i18n/vi tree with compatibility shims 2026-02-21 12:12:26 +08:00
README.ru.md docs(i18n): introduce canonical docs/i18n/vi tree with compatibility shims 2026-02-21 12:12:26 +08:00
README.vi.md docs(i18n): introduce canonical docs/i18n/vi tree with compatibility shims 2026-02-21 12:12:26 +08:00
README.zh-CN.md docs(i18n): introduce canonical docs/i18n/vi tree with compatibility shims 2026-02-21 12:12:26 +08:00
release-process.md fix(ci): sync release publishing with GHCR and add runbook (#1087) 2026-02-20 07:10:09 -05:00
resource-limits.md docs: overhaul docs IA and multilingual navigation 2026-02-18 18:06:13 +08:00
reviewer-playbook.md feat(proxy): add scoped proxy configuration and docs runbooks 2026-02-18 22:10:42 +08:00
sandboxing.md docs: overhaul docs IA and multilingual navigation 2026-02-18 18:06:13 +08:00
security-roadmap.md docs: overhaul docs IA and multilingual navigation 2026-02-18 18:06:13 +08:00
SUMMARY.md docs(i18n): introduce canonical docs/i18n/vi tree with compatibility shims 2026-02-21 12:12:26 +08:00
troubleshooting.md feat: reduce release binary size with opt-in heavy features 2026-02-21 02:23:59 +08:00
troubleshooting.vi.md docs(i18n): introduce canonical docs/i18n/vi tree with compatibility shims 2026-02-21 12:12:26 +08:00
zai-glm-setup.md fix(providers): harden tool fallback and refresh model catalogs 2026-02-18 22:50:02 +08:00

ZeroClaw Documentation Hub

This page is the primary entry point for the documentation system.

Last refreshed: February 21, 2026.

Localized hubs: 简体中文 · 日本語 · Русский · Français · Tiếng Việt.

Start Here

I want to… Read this
Install and run ZeroClaw quickly README.md (Quick Start)
Bootstrap in one command one-click-bootstrap.md
Find commands by task commands-reference.md
Check config defaults and keys quickly config-reference.md
Configure custom providers/endpoints custom-providers.md
Configure Z.AI / GLM provider zai-glm-setup.md
Use LangGraph integration patterns langgraph-integration.md
Operate runtime (day-2 runbook) operations-runbook.md
Troubleshoot install/runtime/channel issues troubleshooting.md
Run Matrix encrypted-room setup and diagnostics matrix-e2ee-guide.md
Browse docs by category SUMMARY.md
See project PR/issue docs snapshot project-triage-snapshot-2026-02-18.md

Quick Decision Tree (10 seconds)

By Audience

Users / Operators

Contributors / Maintainers

Security / Reliability

Note: this area includes proposal/roadmap docs. For current behavior, start with config-reference.md, operations-runbook.md, and troubleshooting.md.

System Navigation & Governance