Skip to content

docs(quickstart): add live demo tab #562

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
SantiagoDePolonia merged 4 commits into from
Jul 20, 2026
Merged

docs(quickstart): add live demo tab #562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
56e6b02
docs(navigation): add live demo link
SantiagoDePolonia Jul 20, 2026
b97d44a
docs(quickstart): move live demo link into tabs
SantiagoDePolonia Jul 20, 2026
1e21dd5
docs(quickstart): simplify live demo link
SantiagoDePolonia Jul 20, 2026
4436988
docs(quickstart): scope credential note to install tabs
SantiagoDePolonia Jul 20, 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
21 changes: 11 additions & 10 deletions docs/getting-started/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: "GoModel AI gateway quick start: run an OpenAI-compatible LLM gatew
icon: "rocket"
---

import ProviderCredentialsNote from "/snippets/provider-credentials-note.mdx";

## Run GoModel in 30 Seconds

GoModel is an OpenAI-compatible AI gateway. You can connect one endpoint and
Expand All @@ -19,12 +21,16 @@ admin visibility in one place.
curl -fsSL https://gomodel.enterpilot.io/install.sh | sh
GOMODEL_MASTER_KEY="change-me" OPENAI_API_KEY="sk-..." gomodel
```

<ProviderCredentialsNote />
</Tab>
<Tab title="Windows">
```powershell
irm https://gomodel.enterpilot.io/install.ps1 | iex
$env:GOMODEL_MASTER_KEY = "change-me"; $env:OPENAI_API_KEY = "sk-..."; gomodel
```

<ProviderCredentialsNote />
</Tab>
<Tab title="Docker">
```bash
Expand All @@ -34,19 +40,14 @@ admin visibility in one place.
-e OPENAI_API_KEY="sk-..." \
enterpilot/gomodel
```

<ProviderCredentialsNote />
</Tab>
<Tab title="Live Demo" icon="monitor-play">
[https://demo.enterpilot.io/admin/dashboard](https://demo.enterpilot.io/admin/dashboard)
</Tab>
Comment on lines +46 to 48

@coderabbitai coderabbitai Bot Jul 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔒 Security & Privacy | 🟠 Major | ⚡ Quick win

Add a warning against entering sensitive or personal data.

Because this Live Demo links directly to a public dashboard, please explicitly warn users against entering sensitive or personal data to prevent the accidental exposure of PII or actual API keys.

🔒 Proposed fix 
   <Tab title="Live Demo" icon="monitor-play">
     [https://demo.enterpilot.io/admin/dashboard](https://demo.enterpilot.io/admin/dashboard)
+
+    <Warning>Do not enter sensitive or personal data.</Warning>
   </Tab>
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/getting-started/quickstart.mdx` around lines 46 - 48, Update the “Live
Demo” tab in the quickstart documentation to add a clear warning not to enter
sensitive, personal, or real API-key data, because the linked dashboard is
public.

</Tabs>

<Note>
Set at least one provider credential or base URL
(`OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, `GEMINI_API_KEY`,
`DEEPSEEK_API_KEY`, `XAI_API_KEY`, `GROQ_API_KEY`, `OPENROUTER_API_KEY`, `KILO_API_KEY`,
`ZAI_API_KEY`, `AZURE_API_KEY` + `AZURE_BASE_URL`,
`ORACLE_API_KEY` + `ORACLE_BASE_URL`,
`OLLAMA_BASE_URL`) or GoModel will have no models to route. GoModel also
works well with additional OpenAI-compatible providers out of the box.
</Note>

### 2. Send your first request

Use `curl` or the OpenAI SDKs for Python and JavaScript against the same
Expand Down
9 changes: 9 additions & 0 deletions docs/snippets/provider-credentials-note.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<Note>
Set at least one provider credential or base URL
(`OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, `GEMINI_API_KEY`,
`DEEPSEEK_API_KEY`, `XAI_API_KEY`, `GROQ_API_KEY`, `OPENROUTER_API_KEY`, `KILO_API_KEY`,
`ZAI_API_KEY`, `AZURE_API_KEY` + `AZURE_BASE_URL`,
`ORACLE_API_KEY` + `ORACLE_BASE_URL`,
`OLLAMA_BASE_URL`) or GoModel will have no models to route. GoModel also
works well with additional OpenAI-compatible providers out of the box.
</Note>