Skip to content

7.4 billion tokens per month. 34 free LLM providers. 635 free model endpoints. All behind one /v1 endpoint, plus any custom OpenAI-compatible endpoint. Smart routing, automatic failover, encrypted keys. Personal experimentation only.

TypeScript

docs: document missing env vars; fix dev-key and setup steps (#259)

danscMax340f41422f7c
diff --git a/.env.example b/.env.example
index 5659ed7f..f06fa2f6 100644
--- a/.env.example
+++ b/.env.example
@@ -4,6 +4,12 @@ ENCRYPTION_KEY=your-64-char-hex-key-here
# Server port (default: 3001)
PORT=3001
+# Network interface the server listens on. Default '::' (dual-stack IPv4+IPv6);
+# hosts with IPv6 disabled fall back to IPv4 automatically. Set 0.0.0.0 for
+# IPv4-only or 127.0.0.1 to restrict to localhost. (Different from HOST_BIND
+# below, which only affects Docker port publishing.)
+# HOST=::
+
# Docker only: which host interface the container's port is published on.
# Defaults to 127.0.0.1, so the dashboard/API is reachable only from the
# machine running Docker. To open it to other devices on your LAN (e.g. a
@@ -16,6 +22,11 @@ PORT=3001
# to disable proxy rate limiting.
# PROXY_RATE_LIMIT_RPM=120
+# Per-provider daily request cap, named PROVIDER_DAILY_REQUEST_CAP_<PLATFORM>
+# (platform name upper-cased). Overrides the built-in default for that provider;
+# set to 0 to disable the cap. Example — cap OpenRouter at 50 requests/day:
+# PROVIDER_DAILY_REQUEST_CAP_OPENROUTER=50
+
# Custom-provider URL policy. Cloud metadata and link-local addresses
# (169.254.169.254, metadata.google.internal, fe80::/10, ...) are ALWAYS
# blocked as custom provider base URLs. By default localhost and private LAN
@@ -56,3 +67,12 @@ REQUEST_ANALYTICS_MAX_ROWS=100000
# Vite dev dashboard. Only set this if you serve the dashboard from a
# different host than the API (e.g. http://my-server.local).
# DASHBOARD_ORIGINS=http://my-server.local,http://192.168.1.50
+
+# --- Advanced / embedding ---------------------------------------------------
+# Path to a prebuilt client `dist` directory to serve. Defaults to the bundled
+# client build; set this only if you build the dashboard separately.
+# CLIENT_DIST=/path/to/client/dist
+
+# Explicit path to the .env file to load. Useful for embedders (e.g. the
+# desktop app, where the code runs from inside a bundle). Defaults to ./.env.
+# FREEAPI_ENV_PATH=/path/to/.env
diff --git a/README.md b/README.md
index c3e15ad2..d8466351 100644
--- a/README.md
+++ b/README.md
@@ -185,7 +185,6 @@ Your fresh install ships with the free catalog snapshot (82 models today) and ke
git clone https://github.com/tashfeenahmed/freellmapi.git
cd freellmapi
npm install
-cp .env.example .env
ENCRYPTION_KEY="$(node -e 'console.log(require("crypto").randomBytes(32).toString("hex"))')"
printf "ENCRYPTION_KEY=%s\nPORT=3001\n" "$ENCRYPTION_KEY" > .env
npm run dev
@@ -196,15 +195,14 @@ npm run dev
git clone https://github.com/tashfeenahmed/freellmapi.git
cd freellmapi
npm install
-Copy-Item .env.example .env
$ENCRYPTION_KEY = node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"
"ENCRYPTION_KEY=$ENCRYPTION_KEY`nPORT=3001" | Out-File -Encoding utf8 .env
npm run dev
```
`ENCRYPTION_KEY` is required for startup. The server only falls back to a
-database-stored development key when `DEV_MODE=true` and `NODE_ENV` is not
-`production`; do not use that fallback with real provider keys.
+database-stored development key when `NODE_ENV` is not `production`; do not use
+that fallback with real provider keys.
Request analytics are retained for 90 days or 100000 request rows by default,
whichever limit prunes first. Set `REQUEST_ANALYTICS_RETENTION_DAYS=0` or