Bibliup

Settings

Settings live in the .env file. .env.example is the full, commented list. After changing one, run docker compose up -d to apply it.

Which Compose files run

COMPOSE_FILE, at the top of .env, chooses the files every docker compose command uses, so you never type -f flags. Leave it as docker-compose.yml on a CPU-only machine, or use the line ending in docker-compose.gpu.yml with an NVIDIA graphics card. After changing it, run docker compose up -d --build.

The settings you are most likely to change

VariableWhat it does
CHAT_MODELSModels the chat picker offers, first one the default. Each must also be installed by the engine (LOCALAI_MODELS, or a config file under localai/)
TLDR_MODELSetting it turns on the one-line TLDR: summaries, written slowly in the background
WHISPER_URL / WHISPER_MODELTranscription; required for audio, which stays hidden until it is set
THEOLOGICAL_GROUNDINGThe tradition chat answers from (stance only, answers stay grounded)
DEFAULT_TRANSLATIONS / PREFERRED_TRANSLATIONTranslations search and chat start with, and the one a verse is shown in
DEFAULT_INTERLINEARSWhich interlinear a reader sees first (bsb, tahot, tagnt)
IMAGE_URL / IMAGE_MODELSImage generation, GPU only and off by default: see Image models
RERANK_MODELAn optional model that orders retrieved sources: see Reranker
AUTH_OIDC_* / AUTH_SECRET / AUTH_URLOptional sign-in: see Sign-in
SOURCE_CODE_URLWhere the app's source links point; set it if you serve a changed Bibliup (see the Licence)
LOCALEDefault interface language (English ships)
LOG_LEVEL / LOG_FORMAT / OTEL_EXPORTER_OTLP_ENDPOINT / OTEL_EXPORTER_OTLP_HEADERSLogging, and optional OpenTelemetry export (headers: comma-separated key=value pairs, e.g. an auth token, sent with every export)
USAGE_RETENTION_DAYSHow long each reader's own usage statistics are kept, in days
PROFILING_ENABLEDOn-demand CPU and heap profiles on port 9464 (see Monitoring)

Ports

Ports are set in docker-compose.yml. Comment out a ports line to free a clash.

PortWhat
3000The app
3001The OpenAI /v1 and MCP /mcp endpoints (see Use it from other apps)
9464Metrics and API reference
9200Elasticsearch
27017MongoDB
8090The AI engine (localhost only)
8081Landing page (on every network address: comment out its ports line on a private install)
6274MCP Inspector (localhost only)
16686Jaeger, GPU only (localhost only)