docs(faq): note OPENAI_BASE_URL env var for pointing clients at LocalAI - #11310
docs(faq): note OPENAI_BASE_URL env var for pointing clients at LocalAI#11310seven7763 wants to merge 1 commit into
Conversation
localai-org-maint-bot
left a comment
There was a problem hiding this comment.
Thanks for the contribution, but this does not fit the LocalAI FAQ as submitted. The added paragraph promotes an unrelated hosted gateway (including campaign-tracking parameters) in a section whose purpose is explaining how clients connect to LocalAI; please remove that promotion.
The commit also fails the repository DCO check and uses an AI Co-Authored-By trailer, which LocalAI .agents/ai-coding-assistants.md explicitly disallows. If you revise the contribution, please replace AI co-authorship with the documented Assisted-by attribution and have the human contributor add their own DCO sign-off.
The "Can I use it with a Discord bot, or XXX?" answer says a client can be pointed at the LocalAI endpoint, but not how. Most OpenAI clients pick the endpoint up from OPENAI_BASE_URL, and clients that insist on a non-empty API key accept any placeholder value while api_keys is unset. Assisted-by: Claude:claude-opus-5 Signed-off-by: seven7763 <seven7763@users.noreply.github.com>
85c12a2 to
7f6688f
Compare
|
Thanks for the review — both points were fair, and I've rewritten the PR rather than argue them. Promotion removed. The hosted-gateway mention and its campaign-tracking parameters are gone entirely; the diff now contains no third-party name or link. Rather than leave an empty PR, I kept a tip that stays on the section's actual topic — how to point an existing client at LocalAI — and names no product:
Attribution and DCO fixed. Dropped the AI I also reverted a stray blank line the first version had introduced under "Can this leverage GPUs?", so the diff is now a single added line. If you'd rather the FAQ not carry this tip at all, just say so and I'll drop it — no attachment to the remaining wording. |
localai-org-maint-bot
left a comment
There was a problem hiding this comment.
@mudler This now looks good from my side. The promotional reference is gone, the remaining FAQ tip is scoped to connecting existing clients to LocalAI, and the commit attribution and DCO sign-off follow the repository policy. I also checked the current one-file diff with git diff --check; it passes.
Clarify how an existing OpenAI client is pointed at LocalAI, in the FAQ answer to "Can I use it with a Discord bot, or XXX?".
That answer already says a client can be pointed at the LocalAI endpoint, but not how. The tip documents the
OPENAI_BASE_URL/OPENAI_API_BASEenvironment variables that most clients read, and notes that clients insisting on a non-empty API key accept any placeholder value whileapi_keysis unset.Docs only (FAQ).
Revised after review. The first version of this PR promoted a third-party hosted gateway and carried campaign-tracking parameters in the link. Both are gone — the diff now names and links no product at all, and the remaining tip stays on the section's own topic. AI attribution was moved from a
Co-Authored-Bytrailer toAssisted-by, per.agents/ai-coding-assistants.md, and the commit now carries a humanSigned-off-byfor DCO.