Skip to content

ZeroNote is an open-source, offline-first unified app that replaces your password manager, bookmark manager, notes app, and 2FA authenticator with a single encrypted note-taking system powered by smart tags, where everything is stored locally on your device with zero-knowledge encryption and optional peer-to-peer or S3 sync.

Notifications You must be signed in to change notification settings

besoeasy/ZeroNote

Repository files navigation

ZeroNote: One Notes App for Everything

ZeroNote is an open-source, offline-first unified app that replaces your password manager, bookmark manager, notes app, and 2FA authenticator with a single encrypted note-taking system powered by smart tags, where everything is stored locally on your device with zero-knowledge encryption and optional peer-to-peer or S3 sync.

Stop juggling multiple apps. One password manager. One bookmark manager. One notes app. One cloud service. One subscription. One privacy concern after another.

ZeroNote simplifies your digital life with a single, intelligent note system that becomes whatever you needβ€”password vault, bookmark organizer, document storage, or personal knowledge base. Everything is just a note with smart tags.

Why ZeroNote?

Your Data, Your Control

In a world where companies control your passwords, notes, and bookmarksβ€”ZeroNote puts you back in charge.

  • Offline-First: Works completely without internet. Your data lives on your device, not someone's cloud.
  • P2P Sync: Share between your devices directly using peer-to-peerβ€”no servers, no middlemen.
  • S3 Backup: Want cloud backup? Use your own S3 storage. Not theirs.
  • Zero-Knowledge Encryption: Even if someone gets your backup, they can't read it without your master password.

The only person who should hold your data is you.

One App, Infinite Possibilities

Stop switching between apps. Everything you need in one place:

  • πŸ” Password Manager with 2FA/TOTP support
  • πŸ”– Bookmark Manager with rich previews
  • πŸ“ Note-Taking with markdown
  • πŸ’³ Crypto Wallet Tracker with address detection
  • πŸ“Ž Document Storage with attachments
  • 🌐 URL Manager with media embeds

All powered by smart tags. Just type #@password=, #@bookmark=, or #@cryptoaddress= and ZeroNote does the rest.

ZeroNote Interface

✨ Key Features

Core Features

  • πŸ“ Unified Notes: Everything is just a note with smart tags
  • πŸ” Client-Side Encryption: All notes encrypted with your master password using AES
  • πŸ“± Offline-First: Works completely offline, all data stored locally in IndexedDB
  • 🏷️ Smart Tags: Use #@password=, #@bookmark=, etc. to auto-organize
  • πŸ” Powerful Search: Instant search across all notes, titles, and content
  • πŸ”„ Secure P2P: Direct device-to-device sync using WebRTCβ€”no cloud needed

Rich Content

  • πŸ“„ Markdown Support: Full markdown rendering with syntax highlighting for code blocks
  • πŸ“Ž File Attachments: Attach images, PDFs, documents to any note with drag-and-drop
  • πŸ”— Media References: Auto-extract and display YouTube, Instagram, Twitter, Reddit links
  • 🎨 Beautiful Reading Mode: Distraction-free reading view with edit button
  • ✏️ Split-Screen Editor: Real-time preview while editing with markdown syntax

Security & Passwords

  • πŸ”‘ Password Manager: Store credentials securely with structured fields
  • πŸ”„ Real-time 2FA: Generate TOTP codes from #@totp= tags with countdown timer
  • 🌐 Domain Support: Track associated domains for each password
  • πŸ‘οΈ Clean Display: Monospace fonts for passwords and codes

Organization

  • 🎯 Type Detection: Auto-detect note types (password, bookmark, note)
  • πŸ“Š Statistics: View insights about your notes, tags, and vault
  • πŸ”– Bookmark Manager: Save URLs with one-click "Open in new tab"
  • πŸ“ Smart Filtering: Filter notes by type and tags

Data Management

  • πŸ’Ύ Backup & Restore: Export/import encrypted JSON backups with attachments
  • πŸ”„ Device Sync: Peer-to-peer sync between devices using WebRTC (no cloud!)
  • ☁️ S3/MinIO Sync: Securely sync your notes to any S3-compatible storage (AWS S3, MinIO, etc.)
  • πŸ“₯ Download Attachments: Download any attached file with a click
  • πŸ—‘οΈ Soft Delete & Auto-Purge: Notes can be recovered before permanent deletion. Deleted notes are automatically purged from your device after 7 days for privacy and storage efficiency.

πŸš€ Getting Started

1. Deploy Your Instance (Recommended)

Fork this repository and deploy to Vercel/Netlify for free. This gives you control over updates.

Deploy with Vercel Deploy to Netlify

Or run with Docker:

docker run -d --name ZeroNote -p 8000:8000 ghcr.io/besoeasy/zeronote:main

2. Set Up Your Vault

  1. Create Master Password: Choose a strong password on first launch
  2. Create Your First Note: Click the + button
  3. Add Smart Tags: Type #@title=My First Note to start

3. Start Organizing

Everything is a note. Just add tags to make it special:

Store a password:

#@title=Gmail
#@email=user@example.com
#@password=SecurePass123
#@totp=JBSWY3DPEHPK3PXP

Save a bookmark:

#@title=Great Article
#@bookmark=https://example.com

My notes about this article...

Track crypto wallet:

#@title=Bitcoin Wallet
#@cryptoaddress=1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa

Main BTC wallet for savings

πŸ‘‰ See TAGS.md for all available tags

πŸ” How It Works

Privacy by Design

  1. You create a master password (never sent anywhere)
  2. Your device encrypts all notes with AES encryption
  3. Everything stays local in IndexedDB on your device
  4. Optional P2P sync connects devices directly (WebRTC)
  5. Optional S3 backup uses your own storage (not ours)

Result: Your data never touches our servers. We can't read it. We can't lose it. We can't sell it.

Smart Tags System

Tags automatically transform your notes:

Tag What It Does Example
#@title= Sets note title #@title=My Bank Account
#@email= Creates email field #@email=user@example.com
#@username= Creates username field #@username=john_doe
#@password= Password with show/hide #@password=SecurePass123
#@totp= 2FA code generator #@totp=JBSWY3DPEHPK3PXP
#@bookmark= Saved link #@bookmark=https://example.com
#@cryptoaddress= Crypto wallet lookup #@cryptoaddress=1A1zP1e...
#@apikey= API key storage #@apikey=sk_live_abc123
#@secret= Hidden text field #@secret=TopSecretInfo

See all 19+ tags β†’

Sync Options

Option 1: P2P Sync (No Server)

  • Create a room with code like "happydog123"
  • Other devices join with same code
  • Direct device-to-device sync via WebRTC
  • Works across different WiFi networks

Option 2: S3 Backup (Your Cloud)

  • Configure your S3 endpoint (AWS, MinIO, etc.)
  • One-click upload/download
  • Full encryption before upload
  • You control the storage

Option 3: Offline Only

  • Don't sync at all
  • Use export/import for backups
  • Maximum privacy

Option 4: Nostr Sync (Relays)

  • Requires a NIP-07 browser extension (e.g., Alby, nos2x)
  • One-button Sync: pulls remote, resolves conflicts, and pushes newer notes
  • Uses kind:30078 App Data events (won’t appear as articles)
  • Per-note events with optional attachment chunking for large files

πŸ’‘ Use Cases

Replace 4+ Apps with One:

  • βœ… Password Manager (Bitwarden, 1Password)
  • βœ… Bookmark Manager (Raindrop, Pocket)
  • βœ… Note-Taking (Notion, Evernote)
  • βœ… 2FA App (Authy, Google Authenticator)
  • βœ… Crypto Wallet Tracker
  • βœ… Document Storage

Perfect For:

  • πŸ” Storing passwords with 2FA codes
  • πŸ”– Organizing bookmarks with notes
  • πŸ“ Technical documentation with code blocks
  • πŸ”‘ API keys and secrets
  • πŸ“„ Personal knowledge base
  • 🌐 URL collections with metadata

πŸ™‹ FAQ

Q: Is my data safe?
A: Yes. Everything is encrypted on your device before storage. Your master password never leaves your device. Even if someone steals your device or backup, they can't decrypt it without your password.

Q: What if I forget my master password?
A: There's no recovery. This is by design for zero-knowledge security. Your password is the encryption keyβ€”without it, data cannot be decrypted.

Q: Can I use this on mobile?
A: Yes! It's a web app that works on any device with a browser. Install it as a PWA for app-like experience.

Q: Do I need internet?
A: No. ZeroNote works 100% offline. Internet is only needed for optional P2P sync or S3 backup.

Q: Where is my data stored?
A: In your browser's IndexedDB. It never leaves your device unless you explicitly sync via P2P or S3.

Q: Is it really free?
A: Yes. Open source (MIT license). Deploy your own instance for free on Vercel/Netlify.

🀝 Contributing

We welcome contributions!

πŸ“Š Comparison with Other Apps

Below is a detailed comparison of ZeroNote with other popular note-taking and password management apps:

Feature / App ZeroNote Bitwarden Joplin Notion Obsidian
Client-Side Encryption βœ… βœ… βœ… ❌ βœ…
Zero-Knowledge βœ… βœ… βœ… ❌ βœ…
Offline-First βœ… βœ… βœ… ❌ βœ…
Smart Tag System βœ… ❌ βœ… βœ… βœ…
Markdown Support βœ… ❌ βœ… βœ… βœ…
File Attachments βœ… βœ… βœ… βœ… βœ…
Media Embeds βœ… ❌ βœ… βœ… βœ…
Password Manager βœ… βœ… ❌ ❌ ❌
2FA/TOTP Support βœ… βœ… ❌ ❌ ❌
Bookmark Manager βœ… ❌ βœ… βœ… βœ…
P2P Device Sync βœ… ❌ ❌ ❌ ❌
S3/MinIO Sync βœ… ❌ ❌ ❌ ❌
Cloud Sync βœ… βœ… βœ… βœ… βœ…
Mobile Support βœ… βœ… βœ… βœ… βœ…
Open Source βœ… βœ… βœ… ❌ βœ…
No Tracking/Analytics βœ… βœ… βœ… ❌ βœ…
Free to Self-Host βœ… βœ… βœ… ❌ βœ…
Rich Statistics βœ… ❌ ❌ ❌ ❌
Split-Screen Editor βœ… ❌ βœ… βœ… βœ…
Distraction-Free Mode βœ… ❌ βœ… βœ… βœ…
Works Without Server βœ… ❌ βœ… ❌ βœ…
Works on Web βœ… βœ… βœ… βœ… ❌
Self-Hosted βœ… βœ… βœ… ❌ βœ…
Unlimited Usage βœ… βœ…* βœ… ❌* βœ…

Legend:

  • βœ… = Supported / Available
  • ❌ = Not Supported / Not Available
  • βœ…* = Unlimited for self-hosted/community version
  • ❌* = Usage limits on free plan

ZeroNote stands out for its unified approach (notes, passwords, bookmarks, and more in one place), strong privacy, offline-first design, and unique peer-to-peer sync with optional S3/MinIO cloud backup. For a full breakdown of tag-based features, see TAGS.md.

About

ZeroNote is an open-source, offline-first unified app that replaces your password manager, bookmark manager, notes app, and 2FA authenticator with a single encrypted note-taking system powered by smart tags, where everything is stored locally on your device with zero-knowledge encryption and optional peer-to-peer or S3 sync.

Topics

Resources

Stars

Watchers

Forks

Packages