Contribute to NodeWarden

This path is for people who want to modify NodeWarden or review technical changes. If you only want to deploy an instance, start with Start Here instead.

Documentation (this wiki)

Wiki source is nodewarden-wiki on GitHub — not the main NodeWarden app repository. Typos and outdated pages: edit via Edit this page on GitHub or open an issue there. See FAQ — wiki mistakes.

Architecture path

1. Architecture Overview - see how the Worker, frontend assets, APIs, D1, R2, KV, cron, and Durable Object notifications fit together.
2. Backend Routes and Services - follow requests through routers, handlers, services, storage, rate limits, and backup boundaries.
3. Frontend Architecture - understand the Vite and Preact Web Vault, routing, sessions, React Query, i18n, and mobile UX.
4. Storage Schema - understand D1 migrations, runtime schema initialization, tables, indexes, and backup contracts.

Compatibility path

1. Compatibility Strategy - keep official Bitwarden clients working across upgrades.
2. API Reference - inspect public, authenticated, vault, attachment, Send, device, domain, and administrator APIs.
3. Realtime Notifications - understand WebSocket and SignalR-compatible notification behavior.

Change path

1. Change Map - find the right code area before making a change.
2. Development Conventions - follow validation commands, i18n rules, backup contracts, and cipher field rules.