{"repo":"gamosoft/NoteDiscovery","free":true,"listed":false,"github":"https://github.com/gamosoft/NoteDiscovery","clone":"git clone https://github.com/gamosoft/NoteDiscovery.git","description":"Your Self-Hosted Knowledge Base","language":"JavaScript","stars":2747,"topics":["alternative","docker","evernote","fastapi","free","hosted","knowledge-base","markdown","note","note-taking","notion","obsidian","onenote","open-source","privacy","python","second-brain","self-hosted","zettelkasten"],"license":"MIT","category":"knowledge_base","readme_excerpt":"<p align=\"center\">\n  <img alt=\"GitHub Stars\" src=\"https://img.shields.io/github/stars/gamosoft/notediscovery?style=flat\">\n  <img alt=\"Build\" src=\"https://img.shields.io/github/actions/workflow/status/gamosoft/notediscovery/docker-publish.yml\">\n  <img alt=\"Latest Version\" src=\"https://img.shields.io/github/v/tag/gamosoft/notediscovery\">\n  <a href=\"https://github.com/gamosoft/NoteDiscovery/pkgs/container/notediscovery\"><img alt=\"GHCR Pulls\" src=\"https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgamosoft%2FNoteDiscovery%2Fstats%2Fghcr.json&style=flat\"></a>\n  <img alt=\"License\" src=\"https://img.shields.io/github/license/gamosoft/notediscovery\">\n</p>\n\n<p align=\"center\">\n  <img src=\"docs/logo.svg\" alt=\"NoteDiscovery\" width=\"120\">\n</p>\n\n<h1 align=\"center\">NoteDiscovery</h1>\n\n<p align=\"center\"><i>Your Self-Hosted Knowledge Base</i></p>\n\n## What is NoteDiscovery?\n\nNoteDiscovery 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.\n\n<p align=\"center\">\n  <img src=\"docs/carousel-1.jpg\" alt=\"Editor and sidebar\" width=\"32%\">\n  <img src=\"docs/carousel-2.jpg\" alt=\"Full-text search\" width=\"32%\">\n  <img src=\"docs/carousel-6.jpg\" alt=\"Graph view of linked notes\" width=\"32%\">\n</p>\n<p align=\"center\"><sub><i>Write · Find · Discover</i></sub></p>\n\n## 🎯 Who is it for?\n\n- **Privacy-conscious users** who want complete control over their data\n- **Developers** who prefer markdown and local file storage\n- **Knowledge workers** building a personal wiki or second brain\n- **Teams** looking for a self-hosted alternative to commercial apps\n- **Anyone** who values simplicity, speed, and ownership\n\n---\n\n<p align=\"center\">\n  <a href=\"https://www.notediscovery.com\"><img src=\"docs/website-button.svg\" alt=\"Official Website\"></a>\n  &nbsp;&nbsp;\n  <a href=\"https://gamosoft-notediscovery-demo.hf.space\"><img src=\"docs/demo-button.svg\" alt=\"Try Live Demo\"></a>\n</p>\n<p align=\"center\">\n  <a href=\"https://www.pikapods.com/pods?run=notediscovery\"><img src=\"https://www.pikapods.com/static/run-button.svg\" alt=\"Run on PikaPods\"></a>\n  &nbsp;&nbsp;\n  <a href=\"https://ko-fi.com/gamosoft\"><img src=\"https://ko-fi.com/img/githubbutton_sm.svg\" alt=\"Buy Me a Coffee at ko-fi.com\"></a>\n</p>\n\n---\n\n## ✨ Why NoteDiscovery?\n\n### vs. Commercial Apps (Notion, Evernote, Obsidian Sync)\n\n| Feature | NoteDiscovery | Commercial Apps |\n|---------|---------------|-----------------|\n| **Cost** | 100% Free | $xxx/month/year |\n| **Privacy** | Your server, your data | Their servers, their terms |\n| **Speed** | Lightning fast | Depends on internet |\n| **Offline** | Always works | Limited or requires sync |\n| **Customization** | Full control | Limited options |\n| **No Lock-in** | Plain markdown files | Proprietary formats |\n\n### Key Benefits\n\n- 🔒 **Total Privacy** - Your notes never leave your server\n- 📴 **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](documentation/THIRD_PARTY.md)\n- 🔐 **Optional Authentication** - Simple password protection for self-hosted deployments\n- 💰 **Zero Cost** - No subscriptions, no hidden fees\n- 🚀 **Fast & Lightweight** - Instant search and navigation\n- 🎨 **Beautiful Themes** - Multiple themes, easy to customize\n- 🔌 **Extensible** - Plugin system for custom features\n- 📱 **Responsive** - Works on desktop, tablet, and mobile\n- 📂 **Simple Storage** - Plain markdown files in folders\n- 🧮 **Math Support** - LaTeX/MathJax for beautiful equations\n- 📄 **HTML Export & Print** - Export notes as standalone HTML or print\n- 🕸️ **Graph View** - Interactive visualization of connected notes\n- ✏️ **Drawing editor** - In-app sketches as `drawing-*.png` next to your notes — see [documentation/DRAWING.md](documentation/DRAWING.md)\n- ⭐ **Favorites** - Star your most-used notes for instant access\n- 📑 **Outline Panel** - Navigate headings with click-to-jump TOC\n- 🤖 **AI Assistant Ready** - MCP integration for Claude, Cursor & more\n\n## 🤖 AI-Powered Note Management\n\n<p align=\"center\">\n  <img src=\"https://img.shields.io/badge/MCP-Compatible-blueviolet?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9IndoaXRlIiBzdHJva2Utd2lkdGg9IjIiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCI+PHBhdGggZD0iTTEyIDJhMTAgMTAgMCAxIDAgMTAgMTBIMTJWMnoiLz48cGF0aCBkPSJNMjEuMTggOC44MmMtLjI4LS40LS43Mi0uODItMS4xOC0uODJoLTNjLS40NiAwLS45LjQyLTEuMTguODItLjI4LjQtLjMyLjk4LS4xMiAxLjQybDEuNSAzYy4yLjQ0LjY2LjcgMS4xMi43aDEuMzZjLjQ2IDAgLjkyLS4yNiAxLjEyLS43bDEuNS0zYy4yLS40NC4xNi0xLjAyLS4xMi0xLjQyeiIvPjwvc3ZnPg==\" alt=\"MCP Compatible\">\n  <img src=\"https://img.shields.io/badge/Works%20with-Claude-orange?style=for-the-badge\" alt=\"Works with Claude\">\n  <img src=\"https://img.shields.io/badge/Works%20with-Cursor-blue?style=for-the-badge\" alt=\"Works with Cursor\">\n</p>\n\nNoteDiscovery includes a built-in **Model Context Protocol (MCP)** server, letting AI assistants directly interact with your notes:\n\n| What AI Can Do | Example |\n|----------------|---------|\n| 🔍 **Search & Discover** | *\"Find all my notes about Docker deployment\"* |\n| 📝 **Create & Edit** | *\"Create a meeting notes template for tomorrow\"* |\n| 📁 **Organize** | *\"Move all project notes to the archive folder\"* |\n| 🏷️ **Tag & Categorize** | *\"List all notes tagged with #urgent\"* |\n| 📊 **Explore Connections** | *\"Show me the knowledge graph of my notes\"* |\n| ✍️ **Append Ideas** | *\"Add this thought to my daily journal\"* |\n\n**One-line setup** for Cursor, Claude Desktop, and other MCP-compatible tools:\n\n```json\n{\n  \"mcpServers\": {\n    \"notediscovery\": {\n      \"command\": \"docker\",\n      \"args\": [\"run\", \"--rm\", \"-i\", \"-e\", \"NOTEDISCOVERY_URL=http://host.docker.internal:8000\", \"ghcr.io/gamosoft/notediscovery:latest\", \"python\", \"-m\", \"mcp_server\"]\n    }\n  }\n}\n```\n\n> 💡 **See [MCP.md](documentation/MCP.md)** for complete setup instructions and all available tools.\n>\n> 🧪 **Want a fully local setup with a bundled LLM?** [OLLAMA-STACK.md](OLLAMA-STACK.md) spins up NoteDiscovery + Ollama + Open WebUI with one command.\n\n## 📺 Watch the tour\n\n<p align=\"center\">\n  <a href=\"https://www.youtube.com/watch?v=qur5uemWeJA\">\n    <img src=\"https://img.youtube.com/vi/qur5uemWeJA/maxresdefault.jpg\" alt=\"Watch a short tour\" width=\"720\">\n  </a>\n</p>\n<p align=\"center\"><i>▶ Small walkthrough — sharing, favorites, search, backlinks, and more</i></p>\n\n## 🚀 Quick Start\n\n### Quick Setup\n\n**Linux/macOS:**\n```bash\nmkdir -p notediscovery/data && cd notediscovery\ndocker run -d --name notediscovery -p 8000:8000 \\\n  -v $(pwd)/data:/app/data \\\n  ghcr.io/gamosoft/notediscovery:latest\n```\n\n**Windows (PowerShell):**\n```powershell\nmkdir notediscovery\\data; cd notediscovery\ndocker run -d --name notediscovery -p 8000:8000 `\n  -v ${PWD}/data:/app/data `\n  ghcr.io/gamosoft/notediscovery:latest\n```\n\nOpen **http://localhost:8000** — done! 🎉  \n\n\n> 💡 Your notes are saved in `./data/`. Themes, plugins, locales and default configuration values are included in the image.\n\n### Using Docker Compose\n\nTwo docker-compose files are provided:\n\n| File | Use Case |\n|------|----------|\n| `docker-compose.ghcr.yml` | **Recommended** - Uses pre-built image from GitHub Container Registry |\n| `docker-compose.yml` | For development - Builds from local source |\n| `docker-compose.ollama-stack.yml` | Bundled local AI stack (NoteDiscovery + Ollama + Open WebUI) — see [OLLAMA-STACK.md](OLLAMA-STACK.md) |\n\n**Option 1: Pre-built image (fastest)**\n\nLinux/macOS:\n```bash\nmkdir -p notediscovery/data && cd notediscovery\ncurl -O https://raw.githubusercontent.com/gamosoft/notediscovery/main/docker-compose.ghcr.yml\ndocker-compose -f docker-compose.ghcr.yml up -d\n```\n\nWindows (PowerShell):\n```powershell\nmkdir notediscovery\\data; cd notediscovery\nInvoke-WebRequest -Uri https://raw.githubusercontent.com/gamosoft/notediscovery/main/docker-compose.ghcr.yml -OutFile docker-compose.ghcr.yml\ndocker-compose -f docker-compose.ghcr.yml up -d\n```\n\n**Option 2: Build from source (for development)**\n```bash\ngit clone https://github.com/gamosoft/notediscovery.git\ncd notediscovery\ndocker-compose up -d\n```\n\nSee [Advanced Docker Setup](#advanced-docker-setup) for volume details.\n\n\n### Running Locally (Without Docker)\n\nFor development or if you prefer running directly:\n\n```bash\n# Clone the repository\ngit clone https://github.com/gamosoft/notediscovery.git\ncd notediscovery\n\n# Install dependencies\npip install -r requirements.txt\n\n# Run the application\npython run.py\n\n# Access at http://localhost:8000\n```\n\n**Requirements:**\n- Python 3.8 or higher\n- pip (Python package manager)\n\n#### Using Virtual Environments (Recommended for Arch/Fedora/Ubuntu 23.04+)\n\nModern Linux distributions enforce [PEP 668](https://peps.python.org/pep-0668/), which prevents system-wide pip installs. Use a virtual environment instead:\n\n```bash\n# Clone the repository\ngit clone https://github.com/gamosoft/notediscovery.git\ncd notediscovery\n\n# Create a virtual environment\npython -m venv venv\n\n# Activate it (choose your shell):\nsource venv/bin/activate        # Bash/Zsh (most Linux distros)\nsource venv/bin/activate.fish   # Fish (CachyOS, etc.)\nsource venv/bin/activate.csh    # Csh/Tcsh\n.\\venv\\Scripts\\activate         # Windows PowerShell\n\n# Install dependencies and run\npip install -r requirements.txt\npython run.py\n```\n\n> ⚠️ **Warning**\n>\n> *You'll need to activate the virtual environment (source venv/bin/activate) each time you open a new terminal before running the app*\n\n### Advanced Docker Setup\n\nThe image includes bundled config, themes, plugins, and locales. To customize, you must:\n1. **Map the volume** in your docker-compose or docker run command\n2. **Provide content** - the file/folder must exist with valid content (empty = app might break!)\n\n| Volume ","default_branch":"main","files":116,"tree":[".dockerignore",".github/FUNDING.yml",".github/workflows/docker-publish.yml",".github/workflows/ghcr-stats.yml",".github/workflows/hf-space-restart.yml",".gitignore","CONTRIBUTING.md","Dockerfile","LICENSE","OLLAMA-STACK.md","README.md","VERSION","backend/__init__.py","backend/export.py","backend/main.py","backend/note_index.py","backend/plugins.py","backend/share.py","backend/themes.py","backend/utils.py","config.yaml","docker-compose.ghcr.yml","docker-compose.ollama-stack.yml","docker-compose.yml","docs/CNAME","docs/carousel-1.jpg","docs/carousel-1.webp","docs/carousel-2.jpg","docs/carousel-2.webp","docs/carousel-3.jpg","docs/carousel-3.webp","docs/carousel-4.jpg","docs/carousel-4.webp","docs/carousel-5.jpg","docs/carousel-5.webp","docs/carousel-6.jpg","docs/carousel-6.webp","docs/carousel-7.png","docs/carousel-7.webp","docs/demo-button.svg","docs/favicon.svg","docs/index.html","docs/logo-512.svg","docs/logo-cropped.svg","docs/logo.png","docs/logo.svg","docs/og-image.png","docs/robots.txt","docs/sitemap.xml","docs/website-button.svg","documentation/API.md","documentation/AUTHENTICATION.md","documentation/DRAWING.md","documentation/ENVIRONMENT_VARIABLES.md","documentation/FEATURES.md","documentation/MATHJAX.md","documentation/MCP.md","documentation/MERMAID.md","documentation/PLUGINS.md","documentation/PLUGIN_NOTE_STATISTICS.md","documentation/SHARING.md","documentation/TAGS.md","documentation/TEMPLATES.md","documentation/THEMES.md","documentation/THIRD_PARTY.md","documentation/templates/daily-journal.md","documentation/templates/meeting-notes.md","documentation/templates/project-plan.md","frontend/app.js","frontend/editor-markdown-continue.js","frontend/favicon.svg","frontend/index.html","frontend/login.html","frontend/logo.svg","frontend/manifest.json","frontend/pikapods-run-button.svg","frontend/sw.js","locales/de-DE.json","locales/en-GB.json","locales/en-US.json","locales/es-ES.json","locales/fr-FR.json","locales/hu-HU.json","locales/it-IT.json","locales/ja-JP.json","locales/ru-RU.json","locales/sl-SI.json","locales/zh-CN.json","mcp_server/__init__.py","mcp_server/__main__.py","mcp_server/client.py","mcp_server/config.py","mcp_server/server.py","mcp_server/tools.py","plugins/contrib/README.md","plugins/contrib/search_open_tasks.py","plugins/note_stats.py","pyproject.toml","release.ps1","render.yaml","requirements.txt","run.py","scripts/vendor_assets.py","scripts/vendor_lock.json","themes/cobalt2.css","themes/dark.css","themes/dracula.css","themes/gruvbox-dark.css","themes/hacker.css","themes/light.css","themes/matcha-light.css","themes/monokai.css","themes/nord.css","themes/ubuntu.css","themes/vs-blue.css","themes/vue-high-contrast.css"],"storefront":"/r/gamosoft","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/gamosoft/NoteDiscovery/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}