Skip to content

docs(guides): add multiple Ollama setup guide#211

Merged
SantiagoDePolonia merged 2 commits intomainfrom
docs/multiple-ollama
Apr 6, 2026
Merged

docs(guides): add multiple Ollama setup guide#211
SantiagoDePolonia merged 2 commits intomainfrom
docs/multiple-ollama

Conversation

@SantiagoDePolonia
Copy link
Copy Markdown
Contributor

@SantiagoDePolonia SantiagoDePolonia commented Apr 6, 2026

Summary

  • add a short Mintlify guide for running GoModel with multiple Ollama backends
  • document mounting a host config.yml to /app/config/config.yaml
  • add the new page to the Guides navigation

Validation

  • jq empty docs/docs.json
  • verified the documented Docker pattern with enterpilot/gomodel:latest against two Ollama-compatible upstream endpoints

Summary by CodeRabbit

  • Documentation
    • New guide on running with multiple Ollama backends, including configuration examples, verification via API, and routing requests to specific backends.
    • New advanced "config.yaml" page explaining precedence vs. environment variables, when to use YAML, examples, and Docker mount behavior.
    • Updated documentation navigation to include the new Guides and Advanced pages.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 6, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 0c8082b7-978c-4352-aff9-eda7f3a6420b

📥 Commits

Reviewing files that changed from the base of the PR and between 5dc7351 and abec2a0.

📒 Files selected for processing (4)
  • docs/advanced/config-yaml.mdx
  • docs/advanced/configuration.mdx
  • docs/docs.json
  • docs/guides/multiple-ollama.mdx

📝 Walkthrough

Walkthrough

Added documentation pages and updated documentation navigation: registered docs/guides/multiple-ollama.mdx and docs/advanced/config-yaml.mdx, and inserted advanced/config-yaml into the "Advanced" group in docs/docs.json. Also added a cross-reference note in docs/advanced/configuration.mdx.

Changes

Cohort / File(s) Summary
Documentation Navigation
docs/docs.json
Inserted guides/multiple-ollama into the "Guides" pages list and added advanced/config-yaml to the "Advanced" group's pages.
New Guide: Multiple Ollama
docs/guides/multiple-ollama.mdx
New guide describing how to configure multiple Ollama providers via providers: YAML, example config.yml, Docker mount/run guidance, host-network tips, verifying GET /v1/models, provider-qualified model IDs, and routing chat requests by qualified model name.
New Doc: config.yaml (Advanced)
docs/advanced/config-yaml.mdx
New advanced page detailing precedence between environment variables and YAML (config/config.yaml or config.yaml), when to use YAML, examples for multi-provider setups and provider-qualified model IDs, and Docker/Docker Compose mount behavior.
Configuration cross-reference
docs/advanced/configuration.mdx
Added a short note directing readers to /advanced/config-yaml if unsure whether YAML is needed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Possibly related PRs

Poem

🐰 I hopped through docs with a tiny scroll,
Two new guides tucked in a YAML hole.
Ollamas paired, each with their name,
Configs mounted, the registry came.
Cheers from a rabbit — ready to tame! 🥕✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding a documentation guide for multiple Ollama setup. It is specific, directly related to the changeset, and follows conventional commit format.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/multiple-ollama

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between dc2a5f4 and 5dc7351.

📒 Files selected for processing (2)
  • docs/docs.json
  • docs/guides/multiple-ollama.mdx

Comment on lines +31 to +36
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
```
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.

🧹 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.

Comment on lines +33 to +34
-e GOMODEL_MASTER_KEY="change-me" \
-v "$PWD/config.yml:/app/config/config.yaml:ro" \
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.

⚠️ Potential issue | 🟠 Major

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.

@SantiagoDePolonia SantiagoDePolonia merged commit 7e6936f into main Apr 6, 2026
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant