mirror of https://github.com/lfnovo/open-notebook.git synced 2026-10-16 12:40:07 +00:00

docs: one canonical install path, first-run flow that ends in a working chat (#1459 )

* docs: one canonical install path, first-run flow that ends in a working chat

- Install guides download the shipped docker-compose.yml instead of pasting
  divergent copies; variants (Ollama in Docker, Ollama on the host, LM Studio)
  are shown as docker-compose.override.yml diffs.
- New canonical "Connect a provider" section in 4-AI-PROVIDERS with the real UI
  labels (Add Configuration, Test, Models/Discover Models, Add, Auto-assign
  Defaults) and a final test chat; every install path links to it.
- Docker settings go in the open_notebook environment block and are applied
  with `docker compose up -d`; .env only fills ${...} placeholders.
- Fix single-container /mydata volume and root:root requirement, external
  Ollama on Linux (extra_hosts + OLLAMA_HOST=0.0.0.0), from-source SURREAL_URL,
  prerequisites (Python 3.11-3.12, Node 20.9+, ffmpeg), wrong service names,
  down -v, backups and updates.
- Provider table regenerated from provider_registry.py (24 providers, with
  modalities); retired models and prices removed.
- Merge the OpenAI quick start into the cloud one (pointer left behind).
- README: license badge, provider matrix, languages, roadmap -> VISION.md.
- docs/index.md reduced to one navigation table, version stamp removed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs: address review (network exposure, key generation, Ollama reachability, migration)

- Warn before the first `docker compose up -d` that 8502/5055 are published on
  all interfaces with no password; offer 127.0.0.1 binding or
  OPEN_NOTEBOOK_PASSWORD. Narrow the local quick start's privacy claim.
- No literal encryption keys: placeholders plus generate commands
  (openssl, PowerShell, `uv run python -c secrets`).
- Host Ollama: Docker Desktop usually works as is, with an OLLAMA_HOST
  fallback for macOS/Windows; stronger exposure caveat for 0.0.0.0.
- Single container: copy /mydata out of the container before removing it.
- Vertex AI form fields; local providers need no key; Add Source menu wording.
- from-source: SURREAL_URL=127.0.0.1, INTERNAL_API_URL when the API port
  changes, mention `make start-all` (fixed on main).
- Windows: quote rocksdb paths. README: Italian, key optional for local.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs: launchctl setenv is not persistent; restart Ollama after setting OLLAMA_HOST

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>

2026-10-04 23:07:08 -03:00

2.4 KiB

Raw Permalink Blame History

Open Notebook - Start Here

Open Notebook is a self-hosted, privacy-focused AI research assistant. Add documents, web pages, audio and video, chat with an AI about them with citations, take notes, and turn your research into podcasts, using the AI providers you choose.

Choose your path

Each quick start installs Open Notebook with Docker Compose and ends with a working chat.

I have an API key for a cloud AI provider

OpenAI, Anthropic, Google, Mistral, Groq, OpenRouter and more.

→ Cloud Providers Quick Start (about 5 minutes)

I want to run everything locally

Ollama in Docker next to Open Notebook. No API keys; nothing leaves your machine.

→ Local Quick Start (about 10 minutes, plus model downloads)

Already have Ollama installed on your computer? → External Ollama Quick Start

Something else

Running from source, Windows without Docker, or a hosting platform → Installation Guide

What you can do

Add content: PDFs, Office and OpenDocument files, web pages, YouTube, audio, video, plain text
Chat: ask questions about the sources in a notebook, with citations, and choose what each source shares with the AI
Ask and search: full-text and semantic search across everything
Transform: run summaries and extraction prompts on sources to produce insights
Take notes: write your own or save AI answers as notes
Create podcasts: 1 to 4 speakers with configurable profiles

Open Notebook and Google Notebook LM

	Open Notebook	Google Notebook LM
Where it runs	Your machine or server	Google's cloud
AI models	20+ providers, cloud or local	Google's models
Podcast speakers	1–4, configurable profiles	Google's formats
Cost	Free software; you pay your AI provider (nothing with local models)	Free tier and subscriptions
Offline	Yes, with local models	No

Prerequisites

Docker for the quick starts. From source and Windows native installs don't need Docker for the app itself.
An AI provider: a cloud API key, or a local model server such as Ollama.

Need help? Join our Discord community or see the full documentation.

2.4 KiB Raw Permalink Blame History Unescape Escape