Skip to content

vivian254338489/openwebui-tokenflow-starter

Repository files navigation

Open WebUI TokenFlow Starter

Connect Open WebUI to one unified OpenAI-compatible model gateway, then manage models behind a single base URL instead of wiring every provider into the UI. This starter uses the disclosed TokenFlow endpoint https://www.tken.shop/v1 and shows the Open WebUI settings that matter for searches like Open WebUI OpenAI compatible, Open WebUI custom provider, Open WebUI base url, Open WebUI LiteLLM alternative, and Open WebUI model gateway.

Open TokenFlow

What This Gives You

  • A Docker Compose file for Open WebUI with OPENAI_API_BASE_URL=https://www.tken.shop/v1.
  • A sanitized .env.example that never includes real keys.
  • An offline config generator that creates local notes and .env files without contacting any API.
  • A smoke-test checklist for model discovery, chat completions, streaming, and rollback.
  • A local check suite with README validation and secret scanning.

Open WebUI supports OpenAI-compatible APIs through the OpenAI Chat Completions protocol. You can configure the base URL in Admin Settings > Connections, or set OPENAI_API_BASE_URL before first launch. See the Open WebUI docs for OpenAI-compatible providers and environment variables.

Quick Start

cp .env.example .env
# Edit OPENAI_API_KEY in .env. Keep OPENAI_API_BASE_URL=https://www.tken.shop/v1
docker compose up -d

Open http://localhost:3000, create your admin account, then check:

  • Admin Settings > Connections > OpenAI is enabled.
  • API Base URL is https://www.tken.shop/v1.
  • API Key is the key you intended to use.
  • The model picker lists models from your gateway.

Generate Sanitized Config

No API key is required for generation:

npm run generate -- --out .generated --base-url https://www.tken.shop/v1 --model gpt-4o-mini

The command writes a sanitized .env and setup notes under .generated/.

Check Before Publishing

npm install
npm run check

npm run check verifies required files, confirms the TokenFlow endpoint and UTM CTA are present, validates package scripts, and scans the repository for common secret patterns.

Files

  • docker-compose.yml - Open WebUI service with a persistent volume.
  • .env.example - safe defaults for local setup.
  • docs/setup.md - UI and environment setup paths.
  • docs/smoke-test.md - production-minded verification checklist.
  • scripts/generate-config.js - offline sanitized config generator.
  • scripts/check.js - repository quality and secret checks.

Security Notes

Do not commit real API keys. Open WebUI stores some connection settings persistently after first launch, so if you change environment variables later, verify the Admin Settings connection as well as the container configuration.

License

MIT

About

Open WebUI starter for connecting to a unified OpenAI-compatible model gateway.

Topics

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Packages

 
 
 

Contributors