mirror of
https://github.com/lfnovo/open-notebook.git
synced 2026-05-01 04:50:01 +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>
447 lines
7.8 KiB
Markdown
447 lines
7.8 KiB
Markdown
# Connection Issues - Network & API Problems
|
|
|
|
Frontend can't reach API or services won't communicate.
|
|
|
|
---
|
|
|
|
## "Cannot connect to server" (Most Common)
|
|
|
|
**What it looks like:**
|
|
- Browser shows error page
|
|
- "Unable to reach API"
|
|
- "Cannot connect to server"
|
|
- UI loads but can't create notebooks
|
|
|
|
**Diagnosis:**
|
|
|
|
```bash
|
|
# Check if API is running
|
|
docker ps | grep api
|
|
# Should see "api" service running
|
|
|
|
# Check if API is responding
|
|
curl http://localhost:5055/health
|
|
# Should show: {"status":"ok"}
|
|
|
|
# Check if frontend is running
|
|
docker ps | grep frontend
|
|
# Should see "frontend" or React service running
|
|
```
|
|
|
|
**Solutions:**
|
|
|
|
### Solution 1: API Not Running
|
|
```bash
|
|
# Start API
|
|
docker compose up api -d
|
|
|
|
# Wait 5 seconds
|
|
sleep 5
|
|
|
|
# Verify it's running
|
|
docker compose logs api | tail -20
|
|
```
|
|
|
|
### Solution 2: Port Not Exposed
|
|
```bash
|
|
# Check docker-compose.yml has port mapping:
|
|
# api:
|
|
# ports:
|
|
# - "5055:5055"
|
|
|
|
# If missing, add it and restart:
|
|
docker compose down
|
|
docker compose up -d
|
|
```
|
|
|
|
### Solution 3: API_URL Mismatch
|
|
```bash
|
|
# In .env, check API_URL:
|
|
cat .env | grep API_URL
|
|
|
|
# Should match your frontend URL:
|
|
# Frontend: http://localhost:8502
|
|
# API_URL: http://localhost:5055
|
|
|
|
# If wrong, fix it:
|
|
# API_URL=http://localhost:5055
|
|
# Then restart:
|
|
docker compose restart frontend
|
|
```
|
|
|
|
### Solution 4: Firewall Blocking
|
|
```bash
|
|
# Verify port 5055 is accessible
|
|
netstat -tlnp | grep 5055
|
|
# Should show port listening
|
|
|
|
# If on different machine, try:
|
|
# Instead of localhost, use your IP:
|
|
API_URL=http://192.168.1.100:5055
|
|
```
|
|
|
|
### Solution 5: Services Not Started
|
|
```bash
|
|
# Restart everything
|
|
docker compose restart
|
|
|
|
# Wait 10 seconds
|
|
sleep 10
|
|
|
|
# Check all services
|
|
docker compose ps
|
|
# All should show "Up"
|
|
```
|
|
|
|
---
|
|
|
|
## Connection Refused
|
|
|
|
**What it looks like:**
|
|
```
|
|
Connection refused
|
|
ECONNREFUSED
|
|
Error: socket hang up
|
|
```
|
|
|
|
**Diagnosis:**
|
|
- API port (5055) not open
|
|
- API crashed
|
|
- Wrong IP/hostname
|
|
|
|
**Solution:**
|
|
|
|
```bash
|
|
# Step 1: Check if API is running
|
|
docker ps | grep api
|
|
|
|
# Step 2: Check if port is listening
|
|
lsof -i :5055
|
|
# or
|
|
netstat -tlnp | grep 5055
|
|
|
|
# Step 3: Check API logs
|
|
docker compose logs api | tail -30
|
|
# Look for errors
|
|
|
|
# Step 4: Restart API
|
|
docker compose restart api
|
|
docker compose logs api | grep -i "error"
|
|
```
|
|
|
|
---
|
|
|
|
## Timeout / Slow Connection
|
|
|
|
**What it looks like:**
|
|
- Page loads slowly
|
|
- Request times out
|
|
- "Gateway timeout" error
|
|
|
|
**Causes:**
|
|
- API is overloaded
|
|
- Network is slow
|
|
- Reverse proxy issue
|
|
|
|
**Solutions:**
|
|
|
|
### Check API Performance
|
|
```bash
|
|
# See CPU/memory usage
|
|
docker stats
|
|
|
|
# Check logs for slow operations
|
|
docker compose logs api | grep "slow\|timeout"
|
|
```
|
|
|
|
### Reduce Load
|
|
```bash
|
|
# In .env:
|
|
SURREAL_COMMANDS_MAX_TASKS=2
|
|
API_CLIENT_TIMEOUT=600
|
|
|
|
# Restart
|
|
docker compose restart
|
|
```
|
|
|
|
### Check Network
|
|
```bash
|
|
# Test latency
|
|
ping localhost
|
|
|
|
# Test API directly
|
|
time curl http://localhost:5055/health
|
|
|
|
# Should be < 100ms
|
|
```
|
|
|
|
---
|
|
|
|
## 502 Bad Gateway (Reverse Proxy)
|
|
|
|
**What it looks like:**
|
|
```
|
|
502 Bad Gateway
|
|
The server is temporarily unable to service the request
|
|
```
|
|
|
|
**Cause:** Reverse proxy can't reach API
|
|
|
|
**Solutions:**
|
|
|
|
### Check Backend is Running
|
|
```bash
|
|
# From the reverse proxy server
|
|
curl http://localhost:5055/health
|
|
|
|
# Should work
|
|
```
|
|
|
|
### Check Reverse Proxy Config
|
|
```nginx
|
|
# Nginx example (correct):
|
|
location /api {
|
|
proxy_pass http://localhost:5055/api;
|
|
proxy_http_version 1.1;
|
|
}
|
|
|
|
# Common mistake (wrong):
|
|
location /api {
|
|
proxy_pass http://localhost:5055; # Missing /api
|
|
}
|
|
```
|
|
|
|
### Set API_URL for HTTPS
|
|
```bash
|
|
# In .env:
|
|
API_URL=https://yourdomain.com
|
|
|
|
# Restart
|
|
docker compose restart
|
|
```
|
|
|
|
---
|
|
|
|
## Intermittent Disconnects
|
|
|
|
**What it looks like:**
|
|
- Works sometimes, fails other times
|
|
- Sporadic "cannot connect" errors
|
|
- Works then stops working
|
|
|
|
**Cause:** Transient network issue or database conflicts
|
|
|
|
**Solutions:**
|
|
|
|
### Enable Retry Logic
|
|
```bash
|
|
# In .env:
|
|
SURREAL_COMMANDS_RETRY_ENABLED=true
|
|
SURREAL_COMMANDS_RETRY_MAX_ATTEMPTS=5
|
|
SURREAL_COMMANDS_RETRY_WAIT_STRATEGY=exponential_jitter
|
|
|
|
# Restart
|
|
docker compose restart
|
|
```
|
|
|
|
### Reduce Concurrency
|
|
```bash
|
|
# In .env:
|
|
SURREAL_COMMANDS_MAX_TASKS=2
|
|
|
|
# Restart
|
|
docker compose restart
|
|
```
|
|
|
|
### Check Network Stability
|
|
```bash
|
|
# Monitor connection
|
|
ping google.com
|
|
|
|
# Long-running test
|
|
ping -c 100 google.com | grep "packet loss"
|
|
# Should be 0% loss
|
|
```
|
|
|
|
---
|
|
|
|
## Different Machine / Remote Access
|
|
|
|
**You want to access Open Notebook from another computer**
|
|
|
|
**Solution:**
|
|
|
|
### Step 1: Get Your Machine IP
|
|
```bash
|
|
# On the server running Open Notebook:
|
|
ifconfig | grep "inet "
|
|
# or
|
|
hostname -I
|
|
# Note the IP (e.g., 192.168.1.100)
|
|
```
|
|
|
|
### Step 2: Update API_URL
|
|
```bash
|
|
# In .env:
|
|
API_URL=http://192.168.1.100:5055
|
|
|
|
# Restart
|
|
docker compose restart
|
|
```
|
|
|
|
### Step 3: Access from Other Machine
|
|
```bash
|
|
# In browser on other machine:
|
|
http://192.168.1.100:8502
|
|
# (or your server IP)
|
|
```
|
|
|
|
### Step 4: Verify Port is Exposed
|
|
```bash
|
|
# On server:
|
|
docker compose ps
|
|
|
|
# Should show port mapping:
|
|
# 0.0.0.0:8502->8502/tcp
|
|
# 0.0.0.0:5055->5055/tcp
|
|
```
|
|
|
|
### If Still Doesn't Work
|
|
```bash
|
|
# Check firewall on server
|
|
sudo ufw status
|
|
# May need to open ports:
|
|
sudo ufw allow 8502
|
|
sudo ufw allow 5055
|
|
|
|
# Check on different machine:
|
|
telnet 192.168.1.100 5055
|
|
# Should connect
|
|
```
|
|
|
|
---
|
|
|
|
## CORS Error (Browser Console)
|
|
|
|
**What it looks like:**
|
|
```
|
|
Cross-Origin Request Blocked
|
|
Access-Control-Allow-Origin
|
|
```
|
|
|
|
**In browser console (F12):**
|
|
```
|
|
CORS policy: Response to preflight request doesn't pass access control check
|
|
```
|
|
|
|
**Cause:** Frontend and API URLs don't match
|
|
|
|
**Solution:**
|
|
|
|
```bash
|
|
# Check browser console error for what URLs are being used
|
|
# The error shows:
|
|
# - Requesting from: http://localhost:8502
|
|
# - Trying to reach: http://localhost:5055
|
|
|
|
# Make sure API_URL matches:
|
|
API_URL=http://localhost:5055
|
|
|
|
# And protocol matches (http/https)
|
|
# Restart
|
|
docker compose restart frontend
|
|
```
|
|
|
|
---
|
|
|
|
## Testing Connection
|
|
|
|
**Full diagnostic:**
|
|
|
|
```bash
|
|
# 1. Services running?
|
|
docker compose ps
|
|
# All should show "Up"
|
|
|
|
# 2. Ports listening?
|
|
netstat -tlnp | grep -E "8502|5055|8000"
|
|
|
|
# 3. API responding?
|
|
curl http://localhost:5055/health
|
|
|
|
# 4. Frontend accessible?
|
|
curl http://localhost:8502 | head
|
|
|
|
# 5. Network OK?
|
|
ping google.com
|
|
|
|
# 6. No firewall?
|
|
sudo ufw status | grep -E "5055|8502|8000"
|
|
```
|
|
|
|
---
|
|
|
|
## Checklist for Remote Access
|
|
|
|
- [ ] Server IP noted (e.g., 192.168.1.100)
|
|
- [ ] Ports 8502, 5055, 8000 exposed in docker-compose
|
|
- [ ] API_URL set to server IP
|
|
- [ ] Firewall allows ports 8502, 5055, 8000
|
|
- [ ] Can reach server from client machine (ping IP)
|
|
- [ ] All services running (docker compose ps)
|
|
- [ ] Can curl API from client (curl http://IP:5055/health)
|
|
|
|
---
|
|
|
|
## SSL Certificate Errors
|
|
|
|
**What it looks like:**
|
|
```
|
|
[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed
|
|
Connection error when using HTTPS endpoints
|
|
Works with HTTP but fails with HTTPS
|
|
```
|
|
|
|
**Cause:** Self-signed certificates not trusted by Python's SSL verification
|
|
|
|
**Solutions:**
|
|
|
|
### Solution 1: Use Custom CA Bundle (Recommended)
|
|
```bash
|
|
# In .env:
|
|
ESPERANTO_SSL_CA_BUNDLE=/path/to/your/ca-bundle.pem
|
|
|
|
# For Docker, mount the certificate:
|
|
# In docker-compose.yml:
|
|
volumes:
|
|
- /path/to/your/ca-bundle.pem:/certs/ca-bundle.pem:ro
|
|
environment:
|
|
- ESPERANTO_SSL_CA_BUNDLE=/certs/ca-bundle.pem
|
|
```
|
|
|
|
### Solution 2: Disable SSL Verification (Development Only)
|
|
```bash
|
|
# WARNING: Only use in trusted development environments
|
|
# In .env:
|
|
ESPERANTO_SSL_VERIFY=false
|
|
```
|
|
|
|
### Solution 3: Use HTTP Instead
|
|
If services are on a trusted local network, HTTP is acceptable:
|
|
```
|
|
Change the base URL in your credential (Settings → API Keys) from https:// to http://
|
|
Example: http://localhost:1234/v1
|
|
```
|
|
|
|
> **Security Note:** Disabling SSL verification exposes you to man-in-the-middle attacks. Always prefer custom CA bundle or HTTP on trusted networks.
|
|
|
|
---
|
|
|
|
## Still Having Issues?
|
|
|
|
- Check [Quick Fixes](quick-fixes.md)
|
|
- Check [FAQ](faq.md)
|
|
- Check logs: `docker compose logs`
|
|
- Try restart: `docker compose restart`
|
|
- Check firewall: `sudo ufw status`
|
|
- Ask for help on [Discord](https://discord.gg/37XJPXfz2w)
|