docs(smoke): add the PDF fixture and a fresh-database setup to the smoke journey (#1578)
docs: restructure documentation around AGENTS.md, VISION.md and decision records (#1032)
docs: refresh stale provider-registry, cubic.yaml and Ollama example rules (#1474) (#1544)
feat(worker): expose OPEN_NOTEBOOK_WORKER_MAX_TASKS to control worker concurrency (#1141)
docs: stop teaching 0.0.0.0 SurrealDB port exposure in setup snippets (#1060)
feat(worker): expose OPEN_NOTEBOOK_WORKER_MAX_TASKS to control worker concurrency (#1141)
An open source, privacy-focused alternative to Google's Notebook LM!
Join our Discord server for help, to share workflow ideas, and suggest features!
Checkout our website »
Follow @lfnovo on X for updates
📚 Get Started
·
📖 User Guide
·
✨ Features
·
🚀 Deploy
In a world dominated by Artificial Intelligence, having the ability to think 🧠 and acquire new knowledge 💡, is a skill that should not be a privilege for a few, nor restricted to a single provider.
Open Notebook empowers you to:
Learn more about our project at https://www.open-notebook.ai
| Feature | Open Notebook | Google Notebook LM | Advantage |
|---|---|---|---|
| Privacy & Control | Self-hosted, your data | Google cloud only | Complete data sovereignty |
| AI Provider Choice | 20+ providers, cloud or local (OpenAI, Anthropic, Google, Ollama, LM Studio, etc.) | Google models only | Flexibility and cost optimization |
| Podcast Speakers | 1-4 speakers with custom profiles | 2 speakers only | Extreme flexibility |
| Content Transformations | Custom and built-in | Limited options | Unlimited processing power |
| API Access | Full REST API | No API | Complete automation |
| Deployment | Docker, cloud, or local | Google hosted only | Deploy anywhere |
| Citations | Answers cite the sources, notes and insights they used | Comprehensive with sources | Research integrity |
| Customization | Open source, fully customizable | Closed system | Unlimited extensibility |
| Cost | Pay only for AI usage | Free tier + Monthly subscription | Transparent and controllable |
Why Choose Open Notebook?
mkdir open-notebook && cd open-notebook
curl -o docker-compose.yml https://raw.githubusercontent.com/lfnovo/open-notebook/main/docker-compose.yml
This is the official docker-compose.yml from this repository. It runs two services: surrealdb (the database) and open_notebook (UI, API and background worker).
Create a .env file next to docker-compose.yml and set OPEN_NOTEBOOK_ENCRYPTION_KEY to a long random secret you generate yourself (for example with openssl rand -hex 32; other options). The shipped compose file reads it from .env. Editing that line in docker-compose.yml is a valid alternative. It encrypts the API keys you store; keep it. When neither is set, the file falls back to change-me-to-a-secret-string only for installs that used that placeholder. If an existing install has a custom key in its old compose file, copy that exact key into .env before replacing the file; do not generate a new one. That fallback is public. Replace it before you save provider keys.
Shared network or server? The UI (
8502) and API (5055) are published on all network interfaces and there is no password by default. If other devices can reach this machine, change those two port lines to"127.0.0.1:8502:8502"and"127.0.0.1:5055:5055", or setOPEN_NOTEBOOK_PASSWORDin the same.envfile, before starting.
docker compose up -d
Wait about 30 seconds, then open: http://localhost:8502
Done! Create a notebook, add a source and start chatting. Full walkthrough: Connect a provider.
Need an API key? Get one from: OpenAI · Anthropic · Google · Groq
Anthropic and Groq have no embedding models; pair them with a provider that does (see the matrix).
Want free local AI? See the Local Quick Start (Ollama in Docker).
Thanks to the Esperanto library, we support these providers out of the box. The columns show the model types each provider offers; what you can use depends on your account.
| Provider | LLM Support | Embedding Support | Speech-to-Text | Text-to-Speech |
|---|---|---|---|---|
| OpenAI | ✅ | ✅ | ✅ | ✅ |
| Anthropic | ✅ | ❌ | ❌ | ❌ |
| Google (GenAI) | ✅ | ✅ | ✅ | ✅ |
| Groq | ✅ | ❌ | ✅ | ❌ |
| Mistral | ✅ | ✅ | ✅ | ✅ |
| DeepSeek | ✅ | ❌ | ❌ | ❌ |
| xAI | ✅ | ❌ | ❌ | ✅ |
| OpenRouter | ✅ | ✅ | ✅ | ✅ |
| DashScope (Qwen) | ✅ | ❌ | ❌ | ❌ |
| MiniMax | ✅ | ❌ | ❌ | ✅ |
| Novita | ✅ | ❌ | ❌ | ❌ |
| SiliconFlow | ✅ | ❌ | ❌ | ❌ |
| Z.ai | ✅ | ❌ | ❌ | ❌ |
| PayPerQ (PPQ) | ✅ | ✅ | ✅ | ✅ |
| Cohere | ✅ | ✅ | ❌ | ❌ |
| Voyage | ❌ | ✅ | ❌ | ❌ |
| ElevenLabs | ❌ | ❌ | ✅ | ✅ |
| Deepgram | ❌ | ❌ | ✅ | ✅ |
| Ollama | ✅ | ✅ | ❌ | ❌ |
| oMLX | ✅ | ✅ | ❌ | ❌ |
| Azure OpenAI | ✅ | ✅ | ✅ | ✅ |
| Vertex AI | ✅ | ✅ | ❌ | ✅ |
| OpenAI Compatible* | ✅ | ✅ | ✅ | ✅ |
| Anthropic Compatible | ✅ | ❌ | ❌ | ❌ |
*Supports LM Studio and any OpenAI-compatible endpoint. Prefer the native oMLX provider for oMLX (Apple Silicon); see docs/5-CONFIGURATION/omlx.md.
Right now the focus is on making the core experience (sources, chat, search, notes, podcasts) solid across every provider and deployment, before adding new product surfaces. The bigger directions under consideration, such as multi-user support, new output formats and agents operating Open Notebook through MCP, are described in the Horizon section of VISION.md. They are directions, not dated promises.
Explore GitHub Discussions for proposed features and product ideas, and open Issues for known bugs and approved work. Recent changes are in the CHANGELOG.
We welcome contributions! We're especially looking for help with:
Current Tech Stack: Python, FastAPI, Next.js, React, SurrealDB
See our Contributing Guide for detailed information on how to get started, including our guidelines for AI-assisted contributions. To understand what we're building (and what we'll say no to), read VISION.md.
Open Notebook is MIT licensed. See the LICENSE file for details.
Community Support: