docs(guides): add multiple Ollama setup guide#211
Conversation
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughAdded documentation pages and updated documentation navigation: registered Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~4 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/guides/multiple-ollama.mdx`:
- Around line 31-36: Replace the unpinned Docker image reference used in the
docker run command (enterpilot/gomodel:latest) with a stable, pinned tag or
digest (e.g., enterpilot/gomodel:<version> or
enterpilot/gomodel@sha256:<digest>) so the example in the docker run invocation
remains reproducible; update the command sample where enterpilot/gomodel:latest
appears and add a brief note recommending pinning to a version or digest for
stability.
- Around line 33-34: Replace the literal weak value "change-me" used in the
docker run examples with a reference to an environment variable
(GOMODEL_MASTER_KEY) and show a short example command to generate/export a
strong key (e.g., using openssl rand -hex 32) so the docs require a secure
secret; update all occurrences where -e GOMODEL_MASTER_KEY="change-me" appears
(including the server and client examples around the docker run snippets and the
related lines noted) to use -e GOMODEL_MASTER_KEY="$GOMODEL_MASTER_KEY" and add
the single-line export example before the docker commands.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: f3169da8-20bd-4fe4-ad76-df3014cd43c6
📒 Files selected for processing (2)
docs/docs.jsondocs/guides/multiple-ollama.mdx
| docker run --rm --name gomodel \ | ||
| -p 8080:8080 \ | ||
| -e GOMODEL_MASTER_KEY="change-me" \ | ||
| -v "$PWD/config.yml:/app/config/config.yaml:ro" \ | ||
| enterpilot/gomodel:latest | ||
| ``` |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial
Pin the Docker image to a stable version (or digest).
Using enterpilot/gomodel:latest makes the guide non-reproducible and can silently break over time.
📌 Suggested doc update
-docker run --rm --name gomodel \
+docker run --rm --name gomodel \
-p 8080:8080 \
-e GOMODEL_MASTER_KEY="change-me" \
-v "$PWD/config.yml:/app/config/config.yaml:ro" \
- enterpilot/gomodel:latest
+ enterpilot/gomodel:<pinned-version>-- `enterpilot/gomodel:latest`
+- `enterpilot/gomodel:<pinned-version>`Also applies to: 81-81
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/guides/multiple-ollama.mdx` around lines 31 - 36, Replace the unpinned
Docker image reference used in the docker run command
(enterpilot/gomodel:latest) with a stable, pinned tag or digest (e.g.,
enterpilot/gomodel:<version> or enterpilot/gomodel@sha256:<digest>) so the
example in the docker run invocation remains reproducible; update the command
sample where enterpilot/gomodel:latest appears and add a brief note recommending
pinning to a version or digest for stability.
| -e GOMODEL_MASTER_KEY="change-me" \ | ||
| -v "$PWD/config.yml:/app/config/config.yaml:ro" \ |
There was a problem hiding this comment.
Avoid normalizing weak default auth values in copy-paste commands.
The guide currently uses change-me directly in both server and client examples. Please explicitly require a strong random key and show command examples that reference an env var instead of a literal weak value.
🔐 Suggested doc hardening
+Generate a strong key before running:
+
+```bash
+export GOMODEL_MASTER_KEY="$(openssl rand -hex 32)"
+```
+
```bash
docker run --rm --name gomodel \
-p 8080:8080 \
- -e GOMODEL_MASTER_KEY="change-me" \
+ -e GOMODEL_MASTER_KEY="$GOMODEL_MASTER_KEY" \
-v "$PWD/config.yml:/app/config/config.yaml:ro" \
enterpilot/gomodel:latest
```diff
curl -s http://localhost:8080/v1/models \
- -H "Authorization: Bearer change-me"
+ -H "Authorization: Bearer $GOMODEL_MASTER_KEY"
curl -s http://localhost:8080/v1/chat/completions \
- -H "Authorization: Bearer change-me" \
+ -H "Authorization: Bearer $GOMODEL_MASTER_KEY" \
-H "Content-Type: application/json" \Also applies to: 53-55, 65-67
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/guides/multiple-ollama.mdx` around lines 33 - 34, Replace the literal
weak value "change-me" used in the docker run examples with a reference to an
environment variable (GOMODEL_MASTER_KEY) and show a short example command to
generate/export a strong key (e.g., using openssl rand -hex 32) so the docs
require a secure secret; update all occurrences where -e
GOMODEL_MASTER_KEY="change-me" appears (including the server and client examples
around the docker run snippets and the related lines noted) to use -e
GOMODEL_MASTER_KEY="$GOMODEL_MASTER_KEY" and add the single-line export example
before the docker commands.
Summary
config.ymlto/app/config/config.yamlValidation
jq empty docs/docs.jsonenterpilot/gomodel:latestagainst two Ollama-compatible upstream endpointsSummary by CodeRabbit