Spaces:
Build error
Build error
Upload HF_SPACES_README.md
Browse files- HF_SPACES_README.md +73 -0
HF_SPACES_README.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: Open Notebook
|
| 3 |
+
emoji: 📚
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: purple
|
| 6 |
+
sdk: docker
|
| 7 |
+
app_file: Dockerfile.spaces
|
| 8 |
+
pinned: false
|
| 9 |
+
---
|
| 10 |
+
|
| 11 |
+
# Open Notebook - AI Research Assistant
|
| 12 |
+
|
| 13 |
+
An open source, privacy-focused alternative to Google's Notebook LM!
|
| 14 |
+
|
| 15 |
+
## Features
|
| 16 |
+
|
| 17 |
+
- 🔒 **Privacy-First**: Your data stays under your control
|
| 18 |
+
- 🤖 **Multi-Model AI**: Support for 16+ providers (OpenAI, Anthropic, Ollama, etc.)
|
| 19 |
+
- 📚 **Multi-Modal Content**: PDFs, videos, audio, web pages
|
| 20 |
+
- 🎙️ **Podcast Generation**: Professional multi-speaker podcasts
|
| 21 |
+
- 🔍 **Smart Search**: Full-text and vector search
|
| 22 |
+
- 💬 **AI Chat**: Context-aware conversations
|
| 23 |
+
- 📱 **PWA Support**: Install as mobile app
|
| 24 |
+
|
| 25 |
+
## Quick Start
|
| 26 |
+
|
| 27 |
+
1. **Configure AI Provider**: Set your API key in Settings
|
| 28 |
+
2. **Create Notebook**: Click "New Notebook" to get started
|
| 29 |
+
3. **Add Sources**: Upload PDFs, paste URLs, or add text
|
| 30 |
+
4. **Chat & Search**: Ask questions about your content
|
| 31 |
+
5. **Generate Notes**: Create AI-powered summaries
|
| 32 |
+
|
| 33 |
+
## Environment Variables
|
| 34 |
+
|
| 35 |
+
You can configure the following in HuggingFace Spaces settings:
|
| 36 |
+
|
| 37 |
+
- `OPENAI_API_KEY`: Your OpenAI API key (recommended)
|
| 38 |
+
- `ANTHROPIC_API_KEY`: Your Anthropic API key (optional)
|
| 39 |
+
- `APP_PASSWORD`: Optional password protection (optional)
|
| 40 |
+
|
| 41 |
+
## Limitations (HuggingFace Spaces)
|
| 42 |
+
|
| 43 |
+
⚠️ **Important**: This is a testing deployment with limitations:
|
| 44 |
+
|
| 45 |
+
- **Persistent Storage**: Limited - data may be lost on container restarts
|
| 46 |
+
- **Performance**: Slower than self-hosted due to resource constraints
|
| 47 |
+
- **Concurrent Users**: Best for single user or light testing
|
| 48 |
+
- **Large Files**: Limited upload sizes due to space constraints
|
| 49 |
+
|
| 50 |
+
## For Production Use
|
| 51 |
+
|
| 52 |
+
For a full-featured deployment, we recommend self-hosting:
|
| 53 |
+
|
| 54 |
+
```bash
|
| 55 |
+
docker run -d \
|
| 56 |
+
--name open-notebook \
|
| 57 |
+
-p 8502:8502 -p 5055:5055 \
|
| 58 |
+
-v ./notebook_data:/app/data \
|
| 59 |
+
-v ./surreal_data:/mydata \
|
| 60 |
+
-e OPENAI_API_KEY=your_key_here \
|
| 61 |
+
lfnovo/open_notebook:v1-latest-single
|
| 62 |
+
```
|
| 63 |
+
|
| 64 |
+
## Links
|
| 65 |
+
|
| 66 |
+
- 🌐 [Website](https://www.open-notebook.ai)
|
| 67 |
+
- 📖 [Documentation](https://github.com/lfnovo/open-notebook)
|
| 68 |
+
- 💬 [Discord Community](https://discord.gg/37XJPXfz2w)
|
| 69 |
+
- 🐛 [GitHub Issues](https://github.com/lfnovo/open-notebook/issues)
|
| 70 |
+
|
| 71 |
+
## License
|
| 72 |
+
|
| 73 |
+
MIT License - See [LICENSE](https://github.com/lfnovo/open-notebook/blob/main/LICENSE)
|