Skip to content

Get Started โ€‹

Open Notebook is a self-hosted AI-powered knowledge management system that helps you organize, analyze, and gain insights from your information.

Installation Options โ€‹

Open Notebook offers flexible installation methods to match your technical needs:

  • Docker Setup - Quick deployment with Docker Compose (recommended)
  • Source Installation - For developers who want to customize or contribute
  • Manual Setup - Full control over the installation process

๐Ÿ“š Official Documentation โ€‹

For the most up-to-date and comprehensive installation instructions, please visit our official documentation:

Getting Started Guide โ†’

The documentation includes:

  • Introduction - Learn what Open Notebook is and what it can do
  • Quick Start - Get running in 5 minutes with Docker
  • Installation Guide - Comprehensive setup instructions for all methods
  • Your First Notebook - Step-by-step tutorial to get you started

System Requirements โ€‹

  • Docker Engine running on your machine
  • 4GB RAM minimum
  • 2GB free disk space (the more the better)
  • An API Key for OpenAI, Anthropic, Gemini, Vertex or OpenRouter

Model Configuration โ€‹

After installation, you'll need to configure your AI model providers. Open Notebook supports:

  • OpenAI (GPT)
  • Anthropic (Claude)
  • Google (Gemini)
  • Vertex AI
  • OpenRouter
  • Local models via Ollama

Head to the Models page for more information on configuring model providers.

๐Ÿ’ฌ Join Our Community โ€‹

For additional help, to share workflow ideas, or to suggest new features, join our Discord server. Connect with other users and be part of the Open Notebook community!

Need Help? โ€‹

Released under the MIT License.