f79a9040ae
* chore: improve podcast transcripts * fix: remove date from insight - fixes #241 * fix: improve scrolling on source and insights - fixes #237 * chore: update esperanto to fix: #234 * chore: update esperanto to fix #226 * fix: process vectorization as subcommands to handle larger documents more gracefully - fix: #229 * feat: enable background job retry capabilities * feat: reenable content types that were disabled during alpha version * fix: remove unnecessary model caching causing many issues. * feat: support multiple azure endpoints and keys just like openai compatible. Fixes #215 * docs: update azure variables * chore: bump and update dependencies
143 lines
6 KiB
Markdown
143 lines
6 KiB
Markdown
# Open Notebook Documentation
|
|
|
|
Welcome to the complete documentation for Open Notebook - your privacy-focused, AI-powered research companion.
|
|
|
|
## 🚀 Getting Started
|
|
|
|
New to Open Notebook? Start here to get up and running quickly.
|
|
|
|
### 📚 **[Getting Started](getting-started/index.md)**
|
|
Everything you need to know to begin your Open Notebook journey.
|
|
- **[Introduction](getting-started/introduction.md)** - What is Open Notebook and why use it?
|
|
- **[Quick Start](getting-started/quick-start.md)** - Get running in 5 minutes
|
|
- **[Installation](getting-started/installation.md)** - Comprehensive setup guide
|
|
- **[Your First Notebook](getting-started/first-notebook.md)** - Step-by-step tutorial
|
|
|
|
---
|
|
|
|
## 📖 User Guide
|
|
|
|
Master Open Notebook's interface and core functionality.
|
|
|
|
### 🎯 **[User Guide](user-guide/index.md)**
|
|
Complete reference for using Open Notebook effectively.
|
|
- **[Interface Overview](user-guide/interface-overview.md)** - Understanding the layout
|
|
- **[Notebooks](user-guide/notebooks.md)** - Organizing your research
|
|
- **[Sources](user-guide/sources.md)** - Adding and managing content
|
|
- **[Notes](user-guide/notes.md)** - Creating and organizing notes
|
|
- **[Chat](user-guide/chat.md)** - Conversing with AI
|
|
- **[Search](user-guide/search.md)** - Finding information quickly
|
|
|
|
---
|
|
|
|
## ⚡ Features
|
|
|
|
Explore Open Notebook's advanced capabilities and unique features.
|
|
|
|
### 🔧 **[Features](features/index.md)**
|
|
Deep dives into what makes Open Notebook special.
|
|
- **[AI Models](features/ai-models.md)** - Multi-provider AI support
|
|
- **[Context Management](features/context-management.md)** - Granular privacy control
|
|
- **[Transformations](features/transformations.md)** - Custom content processing
|
|
- **[Podcasts](features/podcasts.md)** - Multi-speaker podcast generation
|
|
- **[Citations](features/citations.md)** - Research integrity support
|
|
- **[Local TTS](features/local_tts.md)** - 🆕 Free, private local text-to-speech
|
|
- **[OpenAI-Compatible](features/openai-compatible.md)** - Use LM Studio and compatible endpoints
|
|
- **[Ollama](features/ollama.md)** - Local AI models setup
|
|
- **[REST API](development/api-reference.md)** - [](http://localhost:5055/docs) Complete programmatic access
|
|
|
|
---
|
|
|
|
## 🚀 Deployment
|
|
|
|
Set up Open Notebook for different environments and use cases.
|
|
|
|
### 🐳 **[Deployment](deployment/index.md)**
|
|
Complete deployment guides for all scenarios.
|
|
- **[Docker](deployment/docker.md)** - Multi-container setup
|
|
- **[Single Container](deployment/single-container.md)** - Simplified deployment
|
|
- **[Development](deployment/development.md)** - Source code setup
|
|
- **[Security](deployment/security.md)** - Production security
|
|
- **[Retry Configuration](deployment/retry-configuration.md)** - Background job reliability
|
|
|
|
---
|
|
|
|
## 🔧 Development
|
|
|
|
Technical documentation for developers and contributors.
|
|
|
|
### 👩💻 **[Development](development/index.md)**
|
|
Resources for extending and contributing to Open Notebook.
|
|
- **[Architecture](development/architecture.md)** - System design overview
|
|
- **[API Reference](development/api-reference.md)** - REST API documentation
|
|
- **[Contributing](development/contributing.md)** - How to contribute
|
|
|
|
---
|
|
|
|
## 🩺 Support
|
|
|
|
Get help when you need it.
|
|
|
|
### 🛠️ **[Troubleshooting](troubleshooting/index.md)**
|
|
Solutions for common issues and problems.
|
|
- **[Common Issues](troubleshooting/common-issues.md)** - Frequent problems and fixes
|
|
- **[FAQ](troubleshooting/faq.md)** - Frequently asked questions
|
|
- **[Debugging](troubleshooting/debugging.md)** - Advanced troubleshooting
|
|
|
|
---
|
|
|
|
## 🔄 Popular Workflows
|
|
|
|
Common ways to use Open Notebook effectively:
|
|
|
|
### 🔬 **Academic Research**
|
|
Sources → Transformations → Context Management → Citations → Notes
|
|
|
|
### 📝 **Content Creation**
|
|
Sources → AI Models → Transformations → Podcasts → Export
|
|
|
|
### 🧠 **Learning & Study**
|
|
Sources → Search → Notes → Chat → Transformations
|
|
|
|
### 👥 **Team Research**
|
|
Context Management → Citations → Transformations → Sharing
|
|
|
|
---
|
|
|
|
## 🌟 What Makes Open Notebook Special
|
|
|
|
| Feature | Open Notebook | Google Notebook LM | Advantage |
|
|
|---------|---------------|--------------------|-----------|
|
|
| **Privacy & Control** | Self-hosted, your data | Google cloud only | Complete data sovereignty |
|
|
| **AI Provider Choice** | 16+ providers (OpenAI, Anthropic, Ollama, LM Studio, etc.) | Google models only | Flexibility and cost optimization |
|
|
| **Podcast Speakers** | 1-4 speakers with custom profiles | 2 speakers only | Extreme flexibility |
|
|
| **Context Control** | 3 granular levels | All-or-nothing | Privacy and performance tuning |
|
|
| **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** | Comprehensive with sources | Basic references | Research integrity |
|
|
| **Customization** | Open source, fully customizable | Closed system | Unlimited extensibility |
|
|
| **Cost** | Pay only for AI usage | Monthly subscription + usage | Transparent and controllable |
|
|
|
|
---
|
|
|
|
## 🆘 Need Help?
|
|
|
|
- 💬 **[Discord Community](https://discord.gg/37XJPXfz2w)** - Get help and share ideas
|
|
- 🐛 **[GitHub Issues](https://github.com/lfnovo/open-notebook/issues)** - Report bugs and request features
|
|
- 📧 **[Contact](mailto:luis@lfnovo.com)** - Direct support
|
|
- 🌐 **[Website](https://www.open-notebook.ai)** - Project homepage
|
|
|
|
---
|
|
|
|
## 🤝 Contributing
|
|
|
|
Open Notebook is open source and welcomes contributions:
|
|
|
|
- **[Contributing Guide](development/contributing.md)** - How to get involved
|
|
- **[GitHub Repository](https://github.com/lfnovo/open-notebook)** - Source code
|
|
- **[License](https://github.com/lfnovo/open-notebook/blob/main/LICENSE)** - MIT License
|
|
|
|
---
|
|
|
|
*This documentation is constantly evolving. Found an issue or have a suggestion? Please [open an issue](https://github.com/lfnovo/open-notebook/issues) or contribute directly!*
|