Skip to content

refactor: rename "API Keys" settings page to "Models" #1313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lfnovo merged 4 commits into from
Sep 5, 2026
+212 −173
Merged

refactor: rename "API Keys" settings page to "Models" #1313

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1242d91
refactor: rename "API Keys" settings page to "Models" (#1199)
AugustoSandim Sep 4, 2026
a3fe9e3
docs(quick-start): update model settings navigation to Manage → Models
AugustoSandim Sep 4, 2026
2b06254
fix(frontend): highlight only the active sidebar item on nested routes
AugustoSandim Sep 5, 2026
dead86b
Merge remote-tracking branch 'origin/main' into refactor/standardize-…
lfnovo Sep 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/0-START-HERE/quick-start-cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ You should see the Open Notebook interface!

## Step 4: Configure Your AI Provider (1 min)

1. Go to **Settings** → **API Keys**
1. Go to **Settings** → **Models**
2. Click **Add Credential**
3. Select your provider (e.g., Anthropic, Google, Groq, OpenRouter)
4. Give it a name, paste your API key
Expand Down Expand Up @@ -167,7 +167,7 @@ Your provider's models are now available!

### "Model not found" Error

1. Go to **Settings** → **API Keys**
1. Go to **Settings** → **Models**
2. Click **Test Connection** on your credential
3. If valid, click **Discover Models** → **Register Models**
4. Check you have credits/access for the model
Expand Down
2 changes: 1 addition & 1 deletion docs/0-START-HERE/quick-start-external-ollama.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Wait 10-15 seconds for services to start.

## Step 5: Configure Ollama Provider (1 min)

1. Go to **Settings** → **API Keys**
1. Go to **Settings** → **Models**
2. Click **Add Credential**
3. Select provider: **Ollama**
4. Give it a name (e.g., "Local Ollama")
Expand Down
2 changes: 1 addition & 1 deletion docs/0-START-HERE/quick-start-local.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ docker exec open-notebook-local-ollama-1 ollama pull neural-chat
1. Download LM Studio: https://lmstudio.ai
2. Open the app, download a model from the library
3. Go to "Local Server" tab, start server (port 1234)
4. In Open Notebook, go to **Settings** → **API Keys**
4. In Open Notebook, go to **Settings** → **Models**
Comment thread
AugustoSandim marked this conversation as resolved.
Outdated
5. Click **Add Credential** → Select **OpenAI-Compatible**
6. Enter base URL: `http://host.docker.internal:1234/v1`
7. Enter API key: `lm-studio` (placeholder)
Expand Down
4 changes: 2 additions & 2 deletions docs/0-START-HERE/quick-start-openai.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ You should see the Open Notebook interface!

## Step 4: Configure Your OpenAI Provider (1 min)

1. Go to **Settings** → **API Keys**
1. Go to **Settings** → **Models**
2. Click **Add Credential**
3. Select provider: **OpenAI**
4. Give it a name (e.g., "My OpenAI Key")
Expand Down Expand Up @@ -160,7 +160,7 @@ Then access at `http://localhost:8503`

### "API key not working"

1. Go to **Settings** → **API Keys**
1. Go to **Settings** → **Models**
2. Click **Test Connection** on your OpenAI credential
3. If it fails, verify your key at https://platform.openai.com
4. Delete the credential and create a new one with the correct key
Expand Down
6 changes: 3 additions & 3 deletions docs/1-INSTALLATION/docker-compose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ You should see the Open Notebook interface!

## Step 4: Configure AI Provider (2 min)

1. Go to **Settings** → **API Keys**
1. Go to **Settings** → **Models**
2. Click **Add Credential**
3. Select your provider (e.g., OpenAI, Anthropic, Google)
4. Give it a name, paste your API key
Expand Down Expand Up @@ -193,7 +193,7 @@ docker exec open-notebook-local-ollama-1 ollama pull mistral
```

Configure Ollama in the Settings UI:
1. Go to **Settings** → **API Keys**
1. Go to **Settings** → **Models**
2. Click **Add Credential** → Select **Ollama**
3. Enter base URL: `http://ollama:11434`
4. Click **Save**, then **Test Connection**
Expand Down Expand Up @@ -292,7 +292,7 @@ Then access at `http://localhost:8503`

### Credential Issues

1. Go to **Settings** → **API Keys**
1. Go to **Settings** → **Models**
2. Click **Test Connection** on the credential
3. If it fails, verify key at provider's website
4. Check you have credits in your account
Expand Down
12 changes: 6 additions & 6 deletions docs/1-INSTALLATION/single-container.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ docker compose up -d
Access: `http://localhost:8502`

Then configure your AI provider:
1. Go to **Settings** → **API Keys**
1. Go to **Settings** → **Models**
2. Click **Add Credential** → Select your provider → Paste API key
3. Click **Save**, then **Test Connection**
4. Click **Discover Models** → **Register Models**
Expand All @@ -59,14 +59,14 @@ Then configure your AI provider:
2. Search "Open Notebook"
3. Set environment variables (at minimum: `OPEN_NOTEBOOK_ENCRYPTION_KEY`)
4. Click "Deploy"
5. Open the app → Go to **Settings → API Keys** to configure your AI provider
5. Open the app → Go to **Settings → Models** to configure your AI provider

**Railway:**
1. Create new project
2. Add `lfnovo/open_notebook:v1-latest-single`
3. Set environment variables (at minimum: `OPEN_NOTEBOOK_ENCRYPTION_KEY`)
4. Deploy
5. Open the app → Go to **Settings → API Keys** to configure your AI provider
5. Open the app → Go to **Settings → Models** to configure your AI provider

**Render:**
1. Create new Web Service
Expand Down Expand Up @@ -104,7 +104,7 @@ Open Notebook ships an EasyPanel template at [`examples/easypanel/`](https://git
- **One-click (recommended):** once the template is published to the official [EasyPanel template gallery](https://github.com/easypanel-io/templates), create a new service from "Open Notebook", set an app password (or leave it blank to auto-generate one), and deploy.
- **Manual:** copy `examples/easypanel/` into `templates/open-notebook` in a checkout of [`easypanel-io/templates`](https://github.com/easypanel-io/templates), run the templates playground (`npm run dev`), and create the template from the generated JSON in your EasyPanel instance.

After deployment, open the EasyPanel domain and configure your AI provider in **Settings → API Keys**. See [`examples/easypanel/README.md`](https://github.com/lfnovo/open-notebook/blob/main/examples/easypanel/README.md) for details.
After deployment, open the EasyPanel domain and configure your AI provider in **Settings → Models**. See [`examples/easypanel/README.md`](https://github.com/lfnovo/open-notebook/blob/main/examples/easypanel/README.md) for details.

---

Expand All @@ -120,7 +120,7 @@ After deployment, open the EasyPanel domain and configure your AI provider in **
| `SURREAL_DATABASE` | DB name | `open_notebook` |
| `API_URL` | External URL (for remote access) | `https://myapp.example.com` |

AI provider API keys are configured via the **Settings → API Keys** UI after deployment.
AI provider API keys are configured via the **Settings → Models** UI after deployment.

---

Expand All @@ -140,7 +140,7 @@ AI provider API keys are configured via the **Settings → API Keys** UI after d

Same as Docker Compose setup - just access via `http://localhost:8502` (local) or your platform's URL (cloud).

1. Go to **Settings → API Keys** to add your AI provider credential
1. Go to **Settings → Models** to add your AI provider credential
2. **Test Connection** and **Discover Models**

See [Docker Compose](docker-compose.md) for full post-install guide.
12 changes: 6 additions & 6 deletions docs/3-USER-GUIDE/api-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,11 @@ API keys stored in the database are encrypted using Fernet (AES-128-CBC + HMAC-S
## Accessing Credential Configuration

1. Click **Settings** in the navigation bar
2. Select **API Keys** tab
2. Select **Models** tab
3. You'll see existing credentials and an **Add Credential** button

```
Navigation: Settings → API Keys
Navigation: Settings → Models
```

---
Expand Down Expand Up @@ -118,7 +118,7 @@ Navigation: Settings → API Keys

### Step 1: Add Credential

1. Go to **Settings** → **API Keys**
1. Go to **Settings** → **Models**
2. Click **Add Credential**
3. Select your provider
4. Give it a descriptive name (e.g., "My OpenAI Key", "Work Anthropic")
Expand Down Expand Up @@ -257,7 +257,7 @@ Google Cloud's enterprise AI platform:

If you have existing API keys in environment variables (from a previous version):

1. Open **Settings → API Keys**
1. Open **Settings → Models**
2. A banner appears: "Environment variables detected"
3. Click **Migrate to Database**
4. Keys are copied to the database (encrypted)
Expand Down Expand Up @@ -292,7 +292,7 @@ If you're upgrading from an older version that used the ProviderConfig system:

- The migration happens automatically on first startup
- Your existing configurations are converted to credentials
- Check **Settings → API Keys** to verify the migration succeeded
- Check **Settings → Models** to verify the migration succeeded
- If you see issues, check the API logs for migration messages

---
Expand Down Expand Up @@ -356,7 +356,7 @@ API keys stored in the database are encrypted using Fernet (AES-128-CBC + HMAC-S

### Provider Shows "Not Configured"

1. Check if a credential exists for this provider (Settings → API Keys)
1. Check if a credential exists for this provider (Settings → Models)
2. Test the credential connection
3. Verify key format matches provider requirements
4. Re-discover and register models if needed
Expand Down
2 changes: 1 addition & 1 deletion docs/3-USER-GUIDE/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ Task: "I'm exploring a concept without knowing exact words"
→ Use: Search / Vector Search (semantic similarity)

Task: "I need to add or change my AI provider API keys"
→ Use: Settings / API Keys (configure providers without editing files)
→ Use: Settings / Models (configure providers without editing files)
```

---
Expand Down
2 changes: 1 addition & 1 deletion docs/4-AI-PROVIDERS/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ Any use: Free (electricity only)

1. **You've chosen a provider** (from this comparison guide)
2. **Follow the setup guide**: [AI Providers Configuration](../5-CONFIGURATION/ai-providers.md)
3. **Add your credential** in Settings → API Keys
3. **Add your credential** in Settings → Models
4. **Test your connection** and discover models
5. **Start using Open Notebook!**

Expand Down
8 changes: 4 additions & 4 deletions docs/5-CONFIGURATION/advanced.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ ESPERANTO_SSL_VERIFY=false

### Use Different Providers for Different Tasks

Configure multiple AI providers via **Settings → API Keys**. Each provider gets its own credential:
Configure multiple AI providers via **Settings → Models**. Each provider gets its own credential:

1. Add a credential for your main language model provider (e.g., OpenAI, Anthropic)
2. Add a credential for embeddings (e.g., Voyage AI, or use the same provider)
Expand All @@ -208,7 +208,7 @@ Configure multiple AI providers via **Settings → API Keys**. Each provider get

When using OpenAI-Compatible providers, you can configure per-service URLs in a single credential:

1. Go to **Settings** → **API Keys**
1. Go to **Settings** → **Models**
2. Click **Add Credential** → Select **OpenAI-Compatible**
3. Configure separate URLs for LLM, Embedding, TTS, and STT
4. Click **Save**, then **Test Connection**
Expand Down Expand Up @@ -300,7 +300,7 @@ See [Content Processing Engines → Optional engines](../3-USER-GUIDE/content-pr
OPEN_NOTEBOOK_ENCRYPTION_KEY # Required for storing credentials
```

AI provider API keys are configured via **Settings → API Keys** (not environment variables).
AI provider API keys are configured via **Settings → Models** (not environment variables).

### Database
```env
Expand Down Expand Up @@ -334,7 +334,7 @@ ESPERANTO_LLM_TIMEOUT
TTS_BATCH_SIZE
```

> **Note:** `ELEVENLABS_API_KEY` is deprecated. Configure ElevenLabs via **Settings → API Keys**.
> **Note:** `ELEVENLABS_API_KEY` is deprecated. Configure ElevenLabs via **Settings → Models**.

### Debugging
```env
Expand Down
Loading
Loading