NoteDiscovery
Your Self-Hosted Knowledge Base
What is NoteDiscovery?
NoteDiscovery is a lightweight, self-hosted note-taking application that puts you in complete control of your knowledge base. Write, organize, and discover your notes with a beautiful, modern interface—all running on your own server.
Write · Find · Discover
🎯 Who is it for?
- Privacy-conscious users who want complete control over their data
- Developers who prefer markdown and local file storage
- Knowledge workers building a personal wiki or second brain
- Teams looking for a self-hosted alternative to commercial apps
- Anyone who values simplicity, speed, and ownership
✨ Why NoteDiscovery?
vs. Commercial Apps (Notion, Evernote, Obsidian Sync)
| Feature | NoteDiscovery | Commercial Apps |
|---|---|---|
| Cost | 100% Free | $xxx/month/year |
| Privacy | Your server, your data | Their servers, their terms |
| Speed | Lightning fast | Depends on internet |
| Offline | Always works | Limited or requires sync |
| Customization | Full control | Limited options |
| No Lock-in | Plain markdown files | Proprietary formats |
Key Benefits
- 🔒 Total Privacy - Your notes never leave your server
- 📴 No CDN Required - The app and its shared links serve every browser library locally, so they work on air-gapped networks — see documentation/THIRD_PARTY.md
- 🔐 Optional Authentication - Simple password protection for self-hosted deployments
- 💰 Zero Cost - No subscriptions, no hidden fees
- 🚀 Fast & Lightweight - Instant search and navigation
- 🎨 Beautiful Themes - Multiple themes, easy to customize
- 🔌 Extensible - Plugin system for custom features
- 📱 Responsive - Works on desktop, tablet, and mobile
- 📂 Simple Storage - Plain markdown files in folders
- 🧮 Math Support - LaTeX/MathJax for beautiful equations
- 📄 HTML Export & Print - Export notes as standalone HTML or print
- 🕸️ Graph View - Interactive visualization of connected notes
- ✏️ Drawing editor - In-app sketches as
drawing-*.pngnext to your notes — see documentation/DRAWING.md - ⭐ Favorites - Star your most-used notes for instant access
- 📑 Outline Panel - Navigate headings with click-to-jump TOC
- 🤖 AI Assistant Ready - MCP integration for Claude, Cursor & more
🤖 AI-Powered Note Management
NoteDiscovery includes a built-in Model Context Protocol (MCP) server, letting AI assistants directly interact with your notes:
| What AI Can Do | Example |
|---|---|
| 🔍 Search & Discover | "Find all my notes about Docker deployment" |
| 📝 Create & Edit | "Create a meeting notes template for tomorrow" |
| 📁 Organize | "Move all project notes to the archive folder" |
| 🏷️ Tag & Categorize | "List all notes tagged with #urgent" |
| 📊 Explore Connections | "Show me the knowledge graph of my notes" |
| ✍️ Append Ideas | "Add this thought to my daily journal" |
One-line setup for Cursor, Claude Desktop, and other MCP-compatible tools:
{
"mcpServers": {
"notediscovery": {
"command": "docker",
"args": ["run", "--rm", "-i", "-e", "NOTEDISCOVERY_URL=http://host.docker.internal:8000", "ghcr.io/gamosoft/notediscovery:latest", "python", "-m", "mcp_server"]
}
}
}
💡 See MCP.md for complete setup instructions and all available tools.
🧪 Want a fully local setup with a bundled LLM? OLLAMA-STACK.md spins up NoteDiscovery + Ollama + Open WebUI with one command.
📺 Watch the tour
▶ Small walkthrough — sharing, favorites, search, backlinks, and more
🚀 Quick Start
Quick Setup
Linux/macOS:
mkdir -p notediscovery/data && cd notediscovery
docker run -d --name notediscovery -p 8000:8000 \
-v $(pwd)/data:/app/data \
ghcr.io/gamosoft/notediscovery:latest
Windows (PowerShell):
mkdir notediscovery\data; cd notediscovery
docker run -d --name notediscovery -p 8000:8000 `
-v ${PWD}/data:/app/data `
ghcr.io/gamosoft/notediscovery:latest
Open http://localhost:8000 — done! 🎉
💡 Your notes are saved in
./data/. Themes, plugins, locales and default configuration values are included in the image.
Using Docker Compose
Two docker-compose files are provided:
| File | Use Case |
|---|---|
docker-compose.ghcr.yml |
Recommended - Uses pre-built image from GitHub Container Registry |
docker-compose.yml |
For development - Builds from local source |
docker-compose.ollama-stack.yml |
Bundled local AI stack (NoteDiscovery + Ollama + Open WebUI) — see OLLAMA-STACK.md |
Option 1: Pre-built image (fastest)
Linux/macOS:
mkdir -p notediscovery/data && cd notediscovery
curl -O https://raw.githubusercontent.com/gamosoft/notediscovery/main/docker-compose.ghcr.yml
docker-compose -f docker-compose.ghcr.yml up -d
Windows (PowerShell):
mkdir notediscovery\data; cd notediscovery
Invoke-WebRequest -Uri https://raw.githubusercontent.com/gamosoft/notediscovery/main/docker-compose.ghcr.yml -OutFile docker-compose.ghcr.yml
docker-compose -f docker-compose.ghcr.yml up -d
Option 2: Build from source (for development)
git clone https://github.com/gamosoft/notediscovery.git
cd notediscovery
docker-compose up -d
See Advanced Docker Setup for volume details.
Running Locally (Without Docker)
For development or if you prefer running directly:
# Clone the repository
git clone https://github.com/gamosoft/notediscovery.git
cd notediscovery
# Install dependencies
pip install -r requirements.txt
# Run the application
python run.py
# Access at http://localhost:8000
Requirements:
- Python 3.8 or higher
- pip (Python package manager)
Using Virtual Environments (Recommended for Arch/Fedora/Ubuntu 23.04+)
Modern Linux distributions enforce [PEP 668](https://peps.python.org