open-notebook / README.md
C2MV's picture
Deploy Open Notebook to HuggingFace Spaces
bd0c393
|
Raw
History Blame Contribute Delete
2.16 kB
metadata
title: Open Notebook
emoji: πŸ““
colorFrom: blue
colorTo: purple
sdk: docker
app_port: 7860
startup_duration_timeout: 1h
pinned: false
license: mit
suggested_hardware: cpu-upgrade

πŸ““ Open Notebook

An open source, privacy-focused alternative to Google's Notebook LM!

Features

  • πŸ”’ Privacy First - Self-hosted, your data stays under your control
  • πŸ€– 18+ AI Providers - OpenAI, Anthropic, Google, Ollama, and more
  • πŸ“š Multi-modal Content - PDFs, videos, audio, web pages
  • πŸŽ™οΈ Podcast Generation - Advanced multi-speaker podcasts
  • πŸ” Intelligent Search - Full-text and vector search
  • πŸ’¬ Context-Aware Chat - AI conversations powered by your research
  • 🌐 REST API - Full programmatic access at /docs
  • πŸ”Œ MCP Integration - Connect with Claude Desktop, VS Code, etc.

Quick Start

  1. Configure AI Provider: Go to Settings β†’ API Keys β†’ Add your provider
  2. Create a Notebook: Start organizing your research
  3. Add Sources: Upload PDFs, paste URLs, or add text content
  4. Chat & Generate: Ask questions, generate insights, create podcasts

API Access

  • Swagger Docs: /docs
  • REST API: All endpoints at /api/v1/...

MCP Integration

Connect your local AI assistants to this Space:

{
  "mcpServers": {
    "open-notebook": {
      "command": "uvx",
      "args": ["open-notebook-mcp"],
      "env": {
        "OPEN_NOTEBOOK_URL": "https://YOUR-USERNAME-open-notebook.hf.space"
      }
    }
  }
}

Configuration

Set these in your Space Settings β†’ Secrets:

Secret Required Description
OPEN_NOTEBOOK_ENCRYPTION_KEY βœ… Encrypts API keys in database
BASIC_AUTH_USERNAME Optional Password-protect the UI
BASIC_AUTH_PASSWORD Optional Password-protect the UI

Links

⚠️ Persistent Storage: Enable Persistent Storage in Space Settings to keep your data between restarts.