open-notebook README

The project's README from github.com/lfnovo/open-notebook. As one markdown file: 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 »
Follow @lfnovo on X for updates

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

lfnovo%2Fopen-notebook | Trendshift

Deutsch | Español | français | 日本語 | 한국어 | Português | Русский | 中文

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:

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

🆚 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 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?

Built With

Python Next.js React SurrealDB LangChain

🚀 Quick Start

Prerequisites

Step 1: Download docker-compose.yml

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).

Step 2: Set your encryption key

Edit docker-compose.yml and change this line:

- OPEN_NOTEBOOK_ENCRYPTION_KEY=change-me-to-a-secret-string

to a long random secret you generate yourself (for example with openssl rand -hex 32; other options). It encrypts the API keys you store; keep it.

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 add - OPEN_NOTEBOOK_PASSWORD=your-password to the environment: block, before starting.

Step 3: Start services

docker compose up -d

Wait about 30 seconds, then open: http://localhost:8502

Step 4: Connect an AI provider

  1. In the sidebar, open Models (under Manage).
  2. Find your provider (OpenAI, Anthropic, Google, etc.) and click Add Configuration.
  3. Enter a name and your API key (local providers such as Ollama need a Base URL instead), then click Add Configuration.
  4. Click Test on the new configuration to check the connection.
  5. Click Models, choose a Model Type, tick the models to add and click Add. Add at least one Language model and one Embedding model.
  6. Under Default Model Assignments, click Auto-assign Defaults (or pick the models yourself).

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).

📚 More Installation Options

📖 Need Help?

Star History

Star History Chart

Provider Support Matrix

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.

✨ Key Features

Core Capabilities

Advanced Features

Podcast Feature

Check out our podcast sample

📚 Documentation

Getting Started

User Guide

Advanced Topics

(back to top)

🗺️ Where We're Going

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.

(back to top)

📖 Need Help?

🤝 Community & Contributing

Join the Community

Contributing

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.

(back to top)

📄 License

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

Community Support:

(back to top)

open-notebook (lfnovo/open-notebook)

Searching Database…

40.3K ·GitHub
Open-notebook
Что это такое?Open Notebook — это открытая альтернатива Notebook LM от Google, которую можно развернуть самостоятельно. Она позволяет упорядочивать исследования, общаться с вашими документами и создавать подкасты с помощью AI-провайдеров, которых вы выбираете.
Это веб-сервис, который работает на чужом сервере, или приложение, которое я запускаю сам?Это приложение, которое вы разворачиваете самостоятельно через Docker. Оно состоит из интерфейса на Next.js/React и серверной части на Python/FastAPI, а также включает REST API.
Как всё запустить?Установите Docker Desktop, скачайте docker-compose.yml, задайте ключ шифрования, выполните docker compose up, а затем настройте AI-провайдера в интерфейсе. На всё уходит около 2 минут.
Нужен ли мне API-ключ до начала работы?Нет. Для запуска нужен только Docker. API-ключи OpenAI, Anthropic, Google и других добавляются потом в настройках раздела Models в интерфейсе. Можно и вовсе обойтись без ключей, использовав Ollama для бесплатного локального AI.
На какие подводные камни при установке стоит обратить внимание?Перед запуском сервисов нужно отредактировать docker-compose.yml и заменить ключ шифрования по умолчанию. Иначе настройка безопасности и шифрования останется небезопасной.
Может ли оно работать полностью офлайн, локально?Да, его можно связать с Ollama или LM Studio для полностью локального AI. Так не будет затрат на API, а все данные останутся на вашем компьютере.
Остаются ли мои исследовательские данные приватными?Да, оно создано для самостоятельного размещения с полным контролем над данными. Ничего не уходит в облако Google, а при полностью локальной работе через Ollama/LM Studio не происходит никаких внешних обращений.
Сколько AI-провайдеров поддерживается?Более 18 провайдеров, включая OpenAI, Anthropic, Google, Ollama, LM Studio, Groq, Mistral, DeepSeek и другие, через библиотеку Esperanto.
Чем его функция подкастов отличается от Notebook LM от Google?Open Notebook поддерживает от 1 до 4 пользовательских профилей спикеров с полным контролем над сценарием. В Notebook LM формат фиксированный, рассчитан на двух спикеров.
Можно ли использовать его с другими AI-инструментами, например Claude Desktop?Да, есть интеграция MCP, так что его можно подключить к Claude Desktop, VS Code и другим MCP-клиентам. Также есть полноценный REST API для собственной автоматизации.
Какой контент можно добавить в блокнот?PDF, видео, аудио, веб-страницы, офисные документы и многое другое. Затем по этому контенту можно вести полнотекстовый и векторный поиск или общаться с ним через AI.
What are similar projects?ruflo, OpenExecutive, sim, blinko, Trilium, dify, localGPT, NextChat
Which topics is it in?self-learning, notes-app, notebook, podcast, assistant, vector-database, note-taking, ollama, nextjs, chatbot, anthropic, rest-api
Creator
lfnovo
Size
13.9 MB
Stars
40.3K
Updated
CommitOct 05Releasev1.15.0Oct 04
Age
1y
Commits · 90 Days