Go to file
LUIS NOVO 66caf34dc6 fix build 2025-10-18 12:42:09 -03:00
.claude final adjustments 2025-10-11 15:25:19 -03:00
.github/workflows fix build 2025-10-18 12:42:09 -03:00
.streamlit Api podcast migration (#93) 2025-07-17 08:36:11 -03:00
api docs improvements 2025-10-18 00:23:09 -03:00
commands linting 2025-10-12 15:02:53 -03:00
docs docker compose files and README 2025-10-18 12:26:49 -03:00
frontend Allow one step save of sources 2025-10-18 00:16:32 -03:00
migrations docs improvements 2025-10-18 00:23:09 -03:00
open_notebook linting 2025-10-12 15:02:53 -03:00
pages docs improvements 2025-10-18 00:23:09 -03:00
prompts feat: source chat 2025-08-23 11:31:05 -03:00
setup_guide migration details 2025-10-18 00:53:35 -03:00
specs feat: many fixes 2025-10-11 11:26:25 -03:00
tests linting 2025-10-12 15:02:53 -03:00
.dockerignore final adjustments 2025-10-11 15:25:19 -03:00
.env.example many fixes and version upgrade 2025-10-17 23:01:10 -03:00
.gitignore remove specs wrap up layout 2025-10-11 11:48:19 -03:00
.python-version forcing 3.12 as maximum python version to fix pydub issue 2025-04-26 06:23:31 -03:00
CONFIGURATION.md many fixes and version upgrade 2025-10-17 23:01:10 -03:00
CONTRIBUTING.md Initial commit with all features 2024-10-21 14:56:10 -03:00
Dockerfile many fixes and version upgrade 2025-10-17 23:01:10 -03:00
Dockerfile.single many fixes and version upgrade 2025-10-17 23:01:10 -03:00
LICENSE Initial commit with all features 2024-10-21 14:56:10 -03:00
MIGRATION.md migration details 2025-10-18 00:53:35 -03:00
Makefile docker compose files and README 2025-10-18 12:26:49 -03:00
README.md docker compose files and README 2025-10-18 12:26:49 -03:00
app_home.py final adjustments 2025-10-11 15:25:19 -03:00
batch_fix_services.py linting 2025-10-12 15:02:53 -03:00
docker-compose.dev.yml docker compose files and README 2025-10-18 12:26:49 -03:00
docker-compose.single.yml docker compose files and README 2025-10-18 12:26:49 -03:00
docker-compose.yml docker compose files and README 2025-10-18 12:26:49 -03:00
logo.png fix discord link 2025-04-24 10:14:59 -03:00
mypy.ini linting 2025-10-12 15:02:53 -03:00
pyproject.toml docker compose files and README 2025-10-18 12:26:49 -03:00
run_api.py Api podcast migration (#93) 2025-07-17 08:36:11 -03:00
supervisord.conf many fixes and version upgrade 2025-10-17 23:01:10 -03:00
supervisord.single.conf many fixes and version upgrade 2025-10-17 23:01:10 -03:00
uv.lock docker compose files and README 2025-10-18 12:26:49 -03:00

README.md

Forks Stargazers Issues MIT License


Logo

Open Notebook

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 »

📚 Get Started · 📖 User Guide · Features · 🚀 Deploy

New Notebook

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:

  • 🔒 Control your data - Keep your research private and secure
  • 🤖 Choose your AI models - Support for 16+ providers including OpenAI, Anthropic, Ollama, LM Studio, and more
  • 📚 Organize multi-modal content - PDFs, videos, audio, web pages, and more
  • 🎙️ Generate professional podcasts - Advanced multi-speaker podcast generation
  • 🔍 Search intelligently - Full-text and vector search across all your content
  • 💬 Chat with context - AI conversations powered by your research

Learn more about our project at https://www.open-notebook.ai


⚠️ IMPORTANT: v1.0 Breaking Changes

If you're upgrading from a previous version, please note:

  • 🏷️ Docker tags have changed: The latest tag is now frozen at the last Streamlit version
  • 🆕 Use v1-latest tag for the new React/Next.js version (recommended)
  • 🔌 Port 5055 required: You must expose port 5055 for the API to work
  • 📖 Read the migration guide: See MIGRATION.md for detailed upgrade instructions

New users: You can ignore this notice and proceed with the Quick Start below using the v1-latest-single tag.


🆚 Open Notebook vs Google Notebook LM

Feature Open Notebook Google Notebook LM Advantage
Privacy & Control Self-hosted, your data Google cloud only Complete data sovereignty
AI Provider Choice 16+ providers (OpenAI, Anthropic, Ollama, LM Studio, etc.) Google models only Flexibility and cost optimization
Podcast Speakers 1-4 speakers with custom profiles 2 speakers only Extreme flexibility
Context Control 3 granular levels All-or-nothing Privacy and performance tuning
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 Comprehensive with sources Basic references Research integrity
Customization Open source, fully customizable Closed system Unlimited extensibility
Cost Pay only for AI usage Monthly subscription + usage Transparent and controllable

Why Choose Open Notebook?

  • 🔒 Privacy First: Your sensitive research stays completely private
  • 💰 Cost Control: Choose cheaper AI providers or run locally with Ollama
  • 🎙️ Better Podcasts: Full script control and multi-speaker flexibility vs limited 2-speaker deep-dive format
  • 🔧 Unlimited Customization: Modify, extend, and integrate as needed
  • 🌐 No Vendor Lock-in: Switch providers, deploy anywhere, own your data

Built With

Python Next.js React SurrealDB LangChain

🚀 Quick Start

Ready to try Open Notebook? Choose your preferred method:

# Create a new directory for your Open Notebook installation
mkdir open-notebook
cd open-notebook

# Using Docker - Get started in 2 minutes
docker run -d \
  --name open-notebook \
  -p 8502:8502 -p 5055:5055 \
  -v ./notebook_data:/app/data \
  -v ./surreal_data:/mydata \
  -e OPENAI_API_KEY=your_key \
  lfnovo/open_notebook:v1-latest-single

What gets created:

open-notebook/
├── notebook_data/     # Your notebooks and research content
└── surreal_data/      # Database files

Access your installation:

⚠️ Important:

  1. Run from a dedicated folder: Create and run this from inside a new open-notebook folder so your data volumes are properly organized
  2. Volume persistence: The volumes (-v ./notebook_data:/app/data and -v ./surreal_data:/mydata) are essential to persist your data between container restarts. Without them, you'll lose all your notebooks and research when the container stops.

🛠️ Full Installation

For development or customization:

git clone https://github.com/lfnovo/open-notebook
cd open-notebook
make start-all

📖 Need Help?

Provider Support Matrix

Thanks to the Esperanto library, we support this providers out of the box!

Provider LLM Support Embedding Support Speech-to-Text Text-to-Speech
OpenAI
Anthropic
Groq
Google (GenAI)
Vertex AI
Ollama
Perplexity
ElevenLabs
Azure OpenAI
Mistral
DeepSeek
Voyage
xAI
OpenRouter
OpenAI Compatible*

*Supports LM Studio and any OpenAI-compatible endpoint

Key Features

Core Capabilities

  • 🔒 Privacy-First: Your data stays under your control - no cloud dependencies
  • 🎯 Multi-Notebook Organization: Manage multiple research projects seamlessly
  • 📚 Universal Content Support: PDFs, videos, audio, web pages, Office docs, and more
  • 🤖 Multi-Model AI Support: 16+ providers including OpenAI, Anthropic, Ollama, Google, LM Studio, and more
  • 🎙️ Professional Podcast Generation: Advanced multi-speaker podcasts with Episode Profiles
  • 🔍 Intelligent Search: Full-text and vector search across all your content
  • 💬 Context-Aware Chat: AI conversations powered by your research materials
  • 📝 AI-Assisted Notes: Generate insights or write notes manually

Advanced Features

  • Reasoning Model Support: Full support for thinking models like DeepSeek-R1 and Qwen3
  • 🔧 Content Transformations: Powerful customizable actions to summarize and extract insights
  • 🌐 Comprehensive REST API: Full programmatic access for custom integrations API Docs
  • 🔐 Optional Password Protection: Secure public deployments with authentication
  • 📊 Fine-Grained Context Control: Choose exactly what to share with AI models
  • 📎 Citations: Get answers with proper source citations

Three-Column Interface

  1. Sources: Manage all your research materials
  2. Notes: Create manual or AI-generated notes
  3. Chat: Converse with AI using your content as context

Check out our podcast sample

📚 Documentation

Getting Started

User Guide

Advanced Topics

(back to top)

🗺️ Roadmap

Upcoming Features

  • Live Front-End Updates: Real-time UI updates for smoother experience
  • Async Processing: Faster UI through asynchronous content processing
  • Cross-Notebook Sources: Reuse research materials across projects
  • Bookmark Integration: Connect with your favorite bookmarking apps

Recently Completed

  • Next.js Frontend: Modern React-based frontend with improved performance
  • Comprehensive REST API: Full programmatic access to all functionality
  • Multi-Model Support: 16+ AI providers including OpenAI, Anthropic, Ollama, LM Studio
  • Advanced Podcast Generator: Professional multi-speaker podcasts with Episode Profiles
  • Content Transformations: Powerful customizable actions for content processing
  • Enhanced Citations: Improved layout and finer control for source citations
  • Multiple Chat Sessions: Manage different conversations within notebooks

See the open issues for a full list of proposed features and known issues.

(back to top)

🤝 Community & Contributing

Join the Community

  • 💬 Discord Server - Get help, share ideas, and connect with other users
  • 🐛 GitHub Issues - Report bugs and request features
  • Star this repo - Show your support and help others discover Open Notebook

Contributing

We welcome contributions! We're especially looking for help with:

  • Frontend Development: Help improve our modern Next.js/React UI
  • Testing & Bug Fixes: Make Open Notebook more robust
  • Feature Development: Build the coolest research tool together
  • Documentation: Improve guides and tutorials

Current Tech Stack: Python, FastAPI, Next.js, React, SurrealDB Future Roadmap: Real-time updates, enhanced async processing

See our Contributing Guide for detailed information on how to get started.

(back to top)

📄 License

Open Notebook is MIT licensed. See the LICENSE file for details.

📞 Contact

Luis Novo - @lfnovo

Community Support:

🙏 Acknowledgments

Open Notebook is built on the shoulders of amazing open-source projects:

(back to top)