README.md

---
title: Open Notebook
emoji: 📚
colorFrom: blue
colorTo: purple
sdk: docker
app_file: Dockerfile.spaces
pinned: false
---

# Open Notebook - AI Research Assistant

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

## Features

- 🔒 **Privacy-First**: Your data stays under your control
- 🤖 **Multi-Model AI**: Support for 16+ providers (OpenAI, Anthropic, Ollama, etc.)
- 📚 **Multi-Modal Content**: PDFs, videos, audio, web pages
- 🎙️ **Podcast Generation**: Professional multi-speaker podcasts
- 🔍 **Smart Search**: Full-text and vector search
- 💬 **AI Chat**: Context-aware conversations
- 📱 **PWA Support**: Install as mobile app

## Quick Start

1. **Configure AI Provider**: Set your API key in Settings
2. **Create Notebook**: Click "New Notebook" to get started
3. **Add Sources**: Upload PDFs, paste URLs, or add text
4. **Chat & Search**: Ask questions about your content
5. **Generate Notes**: Create AI-powered summaries

## Environment Variables

You can configure the following in HuggingFace Spaces settings:

- `OPENAI_API_KEY`: Your OpenAI API key (recommended)
- `ANTHROPIC_API_KEY`: Your Anthropic API key (optional)
- `APP_PASSWORD`: Optional password protection (optional)

## Limitations (HuggingFace Spaces)

⚠️ **Important**: This is a testing deployment with limitations:

- **Persistent Storage**: Limited - data may be lost on container restarts
- **Performance**: Slower than self-hosted due to resource constraints
- **Concurrent Users**: Best for single user or light testing
- **Large Files**: Limited upload sizes due to space constraints

## For Production Use

For a full-featured deployment, we recommend self-hosting:

```bash
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_here \
  lfnovo/open_notebook:v1-latest-single
```

## Links

- 🌐 [Website](https://www.open-notebook.ai)
- 📖 [Documentation](https://github.com/lfnovo/open-notebook)
- 💬 [Discord Community](https://discord.gg/37XJPXfz2w)
- 🐛 [GitHub Issues](https://github.com/lfnovo/open-notebook/issues)

## License

MIT License - See [LICENSE](https://github.com/lfnovo/open-notebook/blob/main/LICENSE)