A self-hostable, offline-first note-taking app that respects your privacy. Part of the Bretzel app universe.

docker compose up -d

Open http://localhost:3000 and create your admin account on first visit.

# docker-compose.yml
services:
  crumbs:
    image: ghcr.io/bretzel-app/crumbs:latest
    ports:
      - "3000:3000"
    volumes:
      - crumbs-data:/data
    environment:
      - ORIGIN=https://notes.example.com
      - AUTH_OIDC_ISSUER=https://authentik.example.com/application/o/crumbs/
      - AUTH_OIDC_CLIENT_ID=your-client-id
      - AUTH_OIDC_CLIENT_SECRET=your-client-secret
      - AUTH_OIDC_DISPLAY_NAME=Authentik
    restart: unless-stopped

volumes:
  crumbs-data:

Google and GitHub OAuth are also supported. See docs/AUTH.md for all providers and setup guides.

Add SMTP settings to enable email notifications (share alerts, welcome emails, security alerts):

environment:
  - SMTP_HOST=smtp.example.com
  - SMTP_PORT=587
  - SMTP_USER=your-username
  - SMTP_PASS=your-password
  - SMTP_FROM=Crumbs <[email protected]>

Auto-enabled when SMTP_HOST is set. Users can opt out in Settings > Preferences. See docs/DEPLOYMENT.md for details.

git clone <repo-url> crumbs && cd crumbs
pnpm install
pnpm build
DATABASE_URL=./data/crumbs.db ORIGIN=http://localhost:3000 node build

pnpm install
pnpm dev

Run make help to see all available commands, or use pnpm directly:

pnpm test          # Unit + E2E tests
pnpm check         # Type checking
pnpm build         # Production build

• Rich notes with Markdown, checklists, image attachments, and 12 color themes
• Organize with #tags, pinning, archive, and trash
• Full-text search across titles, content, and tags
• Note version history — browse and restore previous versions
• Share notes with other users on the same instance
• Email notifications for shares, security alerts, and account events (optional SMTP)
• PWA — installable, works offline via IndexedDB + LWW CRDT sync
• MCP server — let AI assistants (Claude Code, etc.) manage your notes
• Multi-user auth (Argon2) with optional OAuth/SSO (Google, GitHub, OIDC)
• Docker deployment with a single command

See docs/FEATURES.md for detailed feature documentation.

• CI — lint, type check, unit tests, E2E tests, Docker build on every push/PR
• Release — builds and pushes Docker image on v* tags

Configure registry via GitHub Secrets: REGISTRY_URL, REGISTRY_USER, REGISTRY_TOKEN.

MIT