mirror of
https://github.com/lfnovo/open-notebook.git
synced 2026-05-02 13:20:30 +00:00
* feat: replace provider config with credential-based system (#477) Introduce a new credential management system replacing the old ProviderConfig singleton and standalone Models page. Each credential stores encrypted API keys and provider-specific configuration with full CRUD support via a unified settings UI. Backend: - Add Credential domain model with encrypted API key storage - Add credentials API router (CRUD, discovery, registration, testing) - Add encryption utilities for secure key storage - Add key_provider for DB-first env-var fallback provisioning - Add connection tester and model discovery services - Integrate ModelManager with credential-based config - Add provider name normalization for Esperanto compatibility - Add database migrations 11-12 for credential schema Frontend: - Rewrite settings/api-keys page with credential management UI - Add model discovery dialog with search and custom model support - Add compact default model assignments (primary/advanced layout) - Add inline model testing and credential connection testing - Add env-var migration banner - Update navigation to unified settings page - Remove standalone models page and old settings components i18n: - Update all 7 locale files with credential and model management keys Closes #477 Co-Authored-By: JFMD <git@jfmd.us> Co-Authored-By: OraCatQAQ <570768706@qq.com> * fix: address PR #540 review comments - Fix docs referencing removed Models page - Fix error-handler returning raw messages instead of i18n keys - Fix auth.py misleading docstring and missing no-password guard - Fix connection_tester using wrong env var for openai_compatible - Add provision_provider_keys before model discovery/sync - Update CLAUDE.md to reflect credential-based system - Fix missing closing brace in api-keys page useEffect * fix: add logging to credential migration and surface errors in UI - Add comprehensive logging to migrate-from-env and migrate-from-provider-config endpoints (start, per-provider progress, success/failure with stack traces, final summary) - Fix frontend migration hooks ignoring errors array from response - Show error toast when migration fails instead of "nothing to migrate" - Invalidate status/envStatus queries after migration so banner updates * docs: update CLAUDE.md files for credential system Replace stale ProviderConfig and /api-keys/ references across 8 CLAUDE.md files to reflect the new Credential-based system from PR #540. * docs: update user documentation for credential-based system Replace env var API key instructions with Settings UI credential workflow across all user-facing documentation. The new flow is: set OPEN_NOTEBOOK_ENCRYPTION_KEY → start services → add credential in Settings UI → test → discover models → register. - Rewrite ai-providers.md, api-configuration.md, environment-reference.md - Update all quick-start guides and installation docs - Update ollama.md, openai-compatible.md, local-tts/stt networking sections - Update reverse-proxy.md, development-setup.md, security.md - Fix broken links to non-existent docs/deployment/ paths - Add credentials endpoints to api-reference.md - Move all API key env vars to deprecated/legacy sections * chore: bump version to 1.7.0-rc1 Release candidate for credential-based provider management system. * fix: initialize provider before try block in test_credential Prevents UnboundLocalError when Credential.get() throws (e.g., invalid credential_id) before provider is assigned. * fix: reorder down migration to drop index before table Removes duplicate REMOVE FIELD statement and reorders so the index is dropped before the table, preventing rollback failures. * refactor: simplify encryption key to always derive via SHA-256 Remove the dual code path in _ensure_fernet_key() that detected native Fernet keys. Since the credential system is new, always deriving via SHA-256 removes unnecessary complexity. Also removes the generate_key() function and Fernet.generate_key() references from docs. * fix: correct mock patch targets in embedding tests and URL validation Fix embedding tests patching wrong module path for model_manager (was targeting open_notebook.utils.embedding.model_manager but it's imported locally from open_notebook.ai.models). Also fix URL validation to allow unresolvable hostnames since they may be valid in the deployment environment (e.g., Azure endpoints, internal DNS). * feat: add global setup banner for encryption and migration status Show a persistent banner in AppShell when encryption key is missing (red) or env var API keys can be migrated (amber), so users see these prompts on every page instead of only on Settings > API Keys. Includes a docs link for the encryption banner and i18n support across all 7 locales. * docs: several improvements to docker-compose e env examples * Update README.md Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com> * docs: fix env var format in README and update model setup instructions Align the encryption key snippet in README Step 2 with the list format used in the compose file. Replace deprecated "Settings → Models" instructions with credential-based Discover Models flow. * fix: address credential system review issues - Fix SSRF bypass via IPv4-mapped IPv6 addresses (::ffff:169.254.x.x) - Fix TTS connection test missing config parameter - Add Azure-specific model discovery using api-key auth header - Add Vertex static model list for credential-based discovery - Fix PROVIDER_DISCOVERY_FUNCTIONS incorrect azure/vertex mapping - Extract business logic to api/credentials_service.py (service layer) - Move credential Pydantic schemas to api/models.py - Update tests to use new service imports and ValueError assertions * fix: sanitize error responses and migrate key_provider to Credential - Replace raw exception messages in all credential router 500 responses with generic error strings (internal details logged server-side only) - Refactor key_provider.py to use Credential.get_by_provider() instead of deprecated ProviderConfig.get_instance() - Remove unused functions (get_provider_configs, get_default_api_key, get_provider_config) that were dead code --------- Co-authored-by: JFMD <git@jfmd.us> Co-authored-by: OraCatQAQ <570768706@qq.com>
This commit is contained in:
Luis Novo
GitHub
parent
b1d7a18ce8
commit
3f352cfcce
103 changed files with 10681 additions and 2669 deletions
163
examples/README.md
Normal file
163
examples/README.md
Normal file
|
|
@ -0,0 +1,163 @@
|
|||
# Docker Compose Examples
|
||||
|
||||
This folder contains different `docker-compose.yml` configurations for various use cases.
|
||||
|
||||
## 📋 Available Examples
|
||||
|
||||
### `docker-compose-full-local.yml` - 100% Local AI (No Cloud APIs) 🌟
|
||||
**Use this if:** You want complete privacy with zero external API dependencies
|
||||
|
||||
**Features:**
|
||||
- **Ollama**: Local LLM and embeddings (mistral, llama, etc.)
|
||||
- **Speaches**: Local TTS (text-to-speech) and STT (speech-to-text)
|
||||
- Everything runs on your machine - nothing sent to cloud
|
||||
- Perfect for privacy, offline work, or air-gapped environments
|
||||
|
||||
**Setup:**
|
||||
1. Copy to your project folder as `docker-compose.yml`
|
||||
2. Run: `docker compose up -d`
|
||||
3. Download models (see file comments for commands)
|
||||
4. Configure all providers in UI (detailed instructions in file)
|
||||
|
||||
**Requirements:**
|
||||
- Minimum: 8GB RAM, 20GB disk, 4 CPU cores
|
||||
- Recommended: 16GB+ RAM, NVIDIA GPU (8GB+ VRAM), 50GB disk
|
||||
|
||||
**Documentation:**
|
||||
- [Local TTS Guide](../docs/5-CONFIGURATION/local-tts.md)
|
||||
- [Local STT Guide](../docs/5-CONFIGURATION/local-stt.md)
|
||||
|
||||
---
|
||||
|
||||
### `docker-compose-speaches.yml` - Local Speech Processing
|
||||
**Use this if:** You want free TTS/STT but use cloud LLMs
|
||||
|
||||
**Features:**
|
||||
- **Speaches**: Local text-to-speech and speech-to-text
|
||||
- Use with cloud LLM providers (OpenAI, Anthropic, etc.)
|
||||
- Great for podcast generation without TTS API costs
|
||||
- Private audio processing
|
||||
|
||||
**Setup:**
|
||||
1. Copy to your project folder as `docker-compose.yml`
|
||||
2. Run: `docker compose up -d`
|
||||
3. Download speech models (see file for commands)
|
||||
4. Configure cloud LLM + local Speaches in UI
|
||||
|
||||
**Documentation:**
|
||||
- [Local TTS Guide](../docs/5-CONFIGURATION/local-tts.md)
|
||||
- [Local STT Guide](../docs/5-CONFIGURATION/local-stt.md)
|
||||
|
||||
---
|
||||
|
||||
### `docker-compose-ollama.yml` - Free Local AI with Ollama
|
||||
**Use this if:** You want to run AI models locally without API costs
|
||||
|
||||
**Features:**
|
||||
- Includes Ollama service for local AI models
|
||||
- No external API keys needed (for LLM and embeddings)
|
||||
- Full privacy - everything runs on your machine
|
||||
- Great for testing or privacy-focused deployments
|
||||
|
||||
**Setup:**
|
||||
1. Copy to your project folder as `docker-compose.yml`
|
||||
2. Run: `docker compose up -d`
|
||||
3. Pull a model: `docker exec open_notebook-ollama-1 ollama pull mistral`
|
||||
4. Configure in UI: Settings → API Keys → Add Ollama (URL: `http://ollama:11434`)
|
||||
|
||||
**Recommended models:**
|
||||
- **LLM**: `mistral`, `llama3.1`, `qwen2.5`
|
||||
- **Embeddings**: `nomic-embed-text`, `mxbai-embed-large`
|
||||
|
||||
---
|
||||
|
||||
### `docker-compose-single.yml` - Single Container (Deprecated)
|
||||
**Use this if:** You need all services in one container (not recommended)
|
||||
|
||||
**⚠️ Deprecated:** We recommend using the standard multi-container setup (`docker-compose.yml` in root) for better reliability and easier troubleshooting.
|
||||
|
||||
**Features:**
|
||||
- Single container includes SurrealDB, API, and Frontend
|
||||
- Simpler for very constrained environments
|
||||
- Less flexible for debugging and scaling
|
||||
|
||||
---
|
||||
|
||||
### `docker-compose-dev.yml` - Development Setup
|
||||
**Use this if:** You're contributing to Open Notebook or developing custom features
|
||||
|
||||
**Features:**
|
||||
- Hot-reload for code changes
|
||||
- Separate backend and frontend services
|
||||
- Build from source instead of using pre-built images
|
||||
- Includes development tools and debugging
|
||||
|
||||
**Prerequisites:**
|
||||
- Python 3.11+
|
||||
- Node.js 18+
|
||||
- uv (Python package manager)
|
||||
|
||||
**Setup:**
|
||||
See [Development Guide](../docs/7-DEVELOPMENT/index.md)
|
||||
|
||||
---
|
||||
|
||||
## 🔄 How to Use These Examples
|
||||
|
||||
1. **Choose** the example that fits your use case
|
||||
2. **Copy** the file to your project folder:
|
||||
```bash
|
||||
cp examples/docker-compose-ollama.yml docker-compose.yml
|
||||
```
|
||||
3. **Edit** the `OPEN_NOTEBOOK_ENCRYPTION_KEY` value
|
||||
4. **Run** the services:
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 💡 Need a Custom Setup?
|
||||
|
||||
You can combine features from multiple examples. Common customizations:
|
||||
|
||||
### Add Ollama to Standard Setup
|
||||
Add this to the main `docker-compose.yml`:
|
||||
|
||||
```yaml
|
||||
ollama:
|
||||
image: ollama/ollama:latest
|
||||
ports:
|
||||
- "11434:11434"
|
||||
volumes:
|
||||
- ollama_models:/root/.ollama
|
||||
restart: always
|
||||
|
||||
volumes:
|
||||
ollama_models:
|
||||
```
|
||||
|
||||
### Add Reverse Proxy
|
||||
See [Reverse Proxy Guide](../docs/5-CONFIGURATION/reverse-proxy.md)
|
||||
|
||||
### Add Basic Auth
|
||||
Add to `open_notebook` service environment:
|
||||
```yaml
|
||||
- BASIC_AUTH_USERNAME=admin
|
||||
- BASIC_AUTH_PASSWORD=your-secure-password
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
- [Installation Guide](../docs/1-INSTALLATION/index.md)
|
||||
- [Configuration Reference](../docs/5-CONFIGURATION/environment-reference.md)
|
||||
- [Troubleshooting](../docs/6-TROUBLESHOOTING/index.md)
|
||||
|
||||
---
|
||||
|
||||
## 🆘 Need Help?
|
||||
|
||||
- **Discord**: [Join our community](https://discord.gg/37XJPXfz2w)
|
||||
- **Issues**: [GitHub Issues](https://github.com/lfnovo/open-notebook/issues)
|
||||
Loading…
Add table
Add a link
Reference in a new issue