Quick start¶
1. Install¶
Includes built-in support for OpenAI, Gemini, xAI, Groq, Mistral, DeepSeek, Together, Perplexity, Kimi, and any OpenAI-compatible server (vLLM, Ray Serve, LM Studio, …).
2. Set API keys¶
Set environment variables for the providers you want to use:
Or copy .env.example to .env and fill it in — the proxy reads .env
automatically.
See Environment variables for the full list.
3. Start the server¶
By default the proxy listens on 0.0.0.0:11434 — Ollama's standard port.
Clients pointed at http://localhost:11434 will think they're talking to a
real Ollama instance.
ollama-proxy --port 11434 --debug # verbose logs
ollama-proxy --config ollama-proxy.yaml # YAML config
See the CLI reference for all flags.
4. Make a request¶
The model string <prefix>/<model-id> selects the upstream provider:
5. Validate setup¶
The doctor subcommand checks your config and pings each provider:
ollama-proxy doctor
==================================================
Environment:
✗ PROXY_DEBUG (unset)
✗ EXTRA_MODELS (unset)
✗ PROXY_CONFIG_FILE (unset)
Native-SDK providers:
✓ anthropic key set
✗ azure AZURE_OPENAI_* not set
✓ bedrock region=us-east-1
OpenAI-compatible providers:
✓ openai reachable (https://api.openai.com/v1/models)
✓ gemini reachable (https://generativelanguage.googleapis.com/v1beta/openai/models)
✗ groq no API key set (skipped connectivity)
...
See the CLI reference for more.
What's next?¶
- Providers — pick your backends
- Adding models — three ways to register models
- Client examples — Copilot, Continue, Open WebUI setups
- Reliability — retry and fallback config