From 6d503bbc8c6def4258f9344e0b24f8e067af6761 Mon Sep 17 00:00:00 2001 From: Frederic Cabassut Date: Thu, 12 Mar 2026 20:00:00 +0100 Subject: [PATCH] docs: add SMTP config to README, document recent features, expose all env vars in docker-compose - Add SMTP configuration example to README install section - Add note version history, sharing, and email notifications to README feature list - Expand FEATURES.md with all 9 email notification types and version history section - Add note sharing, version history, and email alerts feature cards to landing page - Add all OAuth/SSO env vars to docker-compose.yml with empty defaults Co-Authored-By: Claude Opus 4.6 --- README.md | 18 ++++++++++++++++++ docker-compose.yml | 10 ++++++++++ docs/DEPLOYMENT.md | 2 +- docs/FEATURES.md | 17 ++++++++++++++++- website/index.html | 27 +++++++++++++++++++++++++++ 5 files changed, 72 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fe7f361..4404f31 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,21 @@ volumes: Google and GitHub OAuth are also supported. See [docs/AUTH.md](docs/AUTH.md) for all providers and setup guides. +#### With Email Notifications (optional) + +Add SMTP settings to enable email notifications (share alerts, welcome emails, security alerts): + +```yaml +environment: + - SMTP_HOST=smtp.example.com + - SMTP_PORT=587 + - SMTP_USER=your-username + - SMTP_PASS=your-password + - SMTP_FROM=Crumbs +``` + +Auto-enabled when `SMTP_HOST` is set. Users can opt out in Settings > Preferences. See [docs/DEPLOYMENT.md](docs/DEPLOYMENT.md#email-notifications-optional) for details. + ### Manual (Node.js) ```bash @@ -75,6 +90,9 @@ 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) diff --git a/docker-compose.yml b/docker-compose.yml index 1cfd089..eb4ec05 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -11,6 +11,16 @@ services: - DATA_DIR=/data - DATABASE_URL=/data/crumbs.db - ORIGIN=${ORIGIN:-http://localhost:3000} + # OAuth / SSO (optional — providers auto-enable when configured) + - AUTH_GOOGLE_CLIENT_ID=${AUTH_GOOGLE_CLIENT_ID:-} + - AUTH_GOOGLE_CLIENT_SECRET=${AUTH_GOOGLE_CLIENT_SECRET:-} + - AUTH_GITHUB_CLIENT_ID=${AUTH_GITHUB_CLIENT_ID:-} + - AUTH_GITHUB_CLIENT_SECRET=${AUTH_GITHUB_CLIENT_SECRET:-} + - AUTH_OIDC_ISSUER=${AUTH_OIDC_ISSUER:-} + - AUTH_OIDC_CLIENT_ID=${AUTH_OIDC_CLIENT_ID:-} + - AUTH_OIDC_CLIENT_SECRET=${AUTH_OIDC_CLIENT_SECRET:-} + - AUTH_OIDC_DISPLAY_NAME=${AUTH_OIDC_DISPLAY_NAME:-} + # Email notifications (optional — auto-enabled when SMTP_HOST is set) - SMTP_HOST=${SMTP_HOST:-} - SMTP_PORT=${SMTP_PORT:-587} - SMTP_USER=${SMTP_USER:-} diff --git a/docs/DEPLOYMENT.md b/docs/DEPLOYMENT.md index 9ef98ef..83b973d 100644 --- a/docs/DEPLOYMENT.md +++ b/docs/DEPLOYMENT.md @@ -116,7 +116,7 @@ Google, GitHub, and generic OIDC (Authentik, Keycloak, Okta, etc.) are supported ### Email Notifications (optional) -Email notifications are sent when a note is shared with a user. Auto-enabled when `SMTP_HOST` is set. +Email notifications are auto-enabled when `SMTP_HOST` is set. See [FEATURES.md](FEATURES.md#note-sharing--collaboration) for the full list of notification types. | Variable | Default | Description | |----------|---------|-------------| diff --git a/docs/FEATURES.md b/docs/FEATURES.md index 4d92b3e..ac4466f 100644 --- a/docs/FEATURES.md +++ b/docs/FEATURES.md @@ -91,7 +91,22 @@ - Share dialog accessible from editor toolbar - Collaborators can leave shared notes - Shared notes appear mixed in main list alongside owned notes -- Email notifications when a note is shared with you (requires SMTP config, opt-out in preferences) +- Email notifications (requires SMTP config, opt-out in preferences): + - Share notifications when a note is shared with you + - Welcome email when admin creates your account + - Password reset notification + - Account deletion confirmation + - Email address change notification + - Role change notification (admin/user) + - Removed from shared note notification + - Shared note permanently deleted notification + - Account locked alert (after failed login attempts) + +### Note Version History +- Browse previous versions of any note +- Versions are automatically saved when content changes +- Restore any previous version with one click +- Version snapshots are only created when content actually changes (not on metadata-only updates) ### Full-Text Search - Search across note titles, content, and tags diff --git a/website/index.html b/website/index.html index f822b64..d3f5346 100644 --- a/website/index.html +++ b/website/index.html @@ -166,6 +166,33 @@

OAuth & SSO

Sign in with Google, GitHub, or any OIDC provider. Or just use a password — your choice.

+ + +
+
+ +
+

Note Sharing

+

Share notes with other users on your instance. Full collaboration with per-user pins and archives.

+
+ + +
+
+ +
+

Version History

+

Browse and restore previous versions of any note. Never lose important edits again.

+
+ + +
+
+ +
+

Email Alerts

+

Optional SMTP notifications for shares, security alerts, and account events. Opt out per user.

+