From 49155aa969a9a0cb5f3d469023d7f67026170e11 Mon Sep 17 00:00:00 2001 From: Remi <73385395+itsrubberduck@users.noreply.github.com> Date: Sat, 18 Oct 2025 13:40:58 +0200 Subject: [PATCH] Document OPENAI_BASE_URL usage --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 6da304f..be0b75b 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,8 @@ Goal: a community-driven alternative to other costly AI-ATC solutions while bein | OpenAI API Key | For TTS and LLM calls (`OPENAI_API_KEY`). | | Optional: Piper TTS | For local speech (`pip install "piper-tts[http]"`). | +You can connect to any OpenAI-compatible (self-hosted or third-party) API by setting `OPENAI_BASE_URL` to the service's base URL. + ## Setup 1. Clone the repository: @@ -54,6 +56,7 @@ Goal: a community-driven alternative to other costly AI-ATC solutions while bein * `MONGODB_URI`: MongoDB connection string (default `mongodb://127.0.0.1:27017/opensquawk`). * `JWT_SECRET` & `JWT_REFRESH_SECRET`: Random strings for tokens. + * `OPENAI_BASE_URL`: Optional override for any OpenAI API–compatible service; defaults to the OpenAI platform when unset. * `OPENAI_API_KEY`, optional `OPENAI_PROJECT`, `LLM_MODEL`, `TTS_MODEL`, `VOICE_ID`. * `ATC_OUT_DIR`: Directory for generated audio files. * `USE_PIPER`, `PIPER_PORT`: Enable local Piper TTS instance.