Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/techjarves/Odysseus-Portable/llms.txt

Use this file to discover all available pages before exploring further.

Odysseus Portable reads a small set of environment variables at startup to configure ports, select the inference backend, tune context window size, and seed admin credentials. Every variable has a sensible built-in default, so you only need to set the ones you want to change. Environment variables always take precedence over values stored in data/launcher_config.json, and CLI flags (e.g., --backend=llama) take precedence over both — making it easy to mix persistent defaults with one-off overrides.

Variable Reference

ODYSSEUS_BACKEND
string
Selects the inference backend. Accepted values are llama (or its aliases llamacpp and llama.cpp) and ollama. When not set, the value from data/launcher_config.json is used; if that is also absent, the orchestrator defaults to llama.
ODYSSEUS_PORT
number
Port for the Odysseus web UI. Default: 7070. If the requested port is already occupied, the orchestrator automatically increments to the next free port.
ODYSSEUS_PROXY_PORT
number
Port for the API proxy server that sits between the web UI and the inference backend. Default: 8080. Auto-increments if unavailable.
ODYSSEUS_LLAMA_PORT
number
Port used by the llama-server process (llama.cpp backend only). Default: 10086. Auto-increments if unavailable.
ODYSSEUS_LLAMA_CTX
number
Forces a specific context window size (number of tokens) for llama-server. When unset, the orchestrator auto-calculates an appropriate size based on available GPU/RAM, model size, and the number of parallel slots. Set this only when you need to override the automatic selection.
ODYSSEUS_LLAMA_PARALLEL
number
Number of parallel inference slots to initialise in llama-server. More slots allow simultaneous requests but consume additional memory proportionally. Default: 1.
ODYSSEUS_ADMIN_USER
string
Admin username seeded into the Odysseus database during the first-time setup step. Default: admin. Changing this after the database has already been created has no effect — update the credential from within the web UI instead.
ODYSSEUS_ADMIN_PASSWORD
string
Admin password seeded into the Odysseus database during setup. Default: techjarves.
Change the default password from the user profile settings inside the web UI after your first sign-in. Never leave the default credential in place on a shared or networked machine.
ODYSSEUS_ALLOW_SYSTEM_GIT
string
Unix-only. Set to 1 to force the orchestrator to accept the host system’s git executable even when the automatic availability check does not pass. On Linux and macOS the launcher already uses system git automatically when it detects a working installation; this flag is only needed in environments where the git binary exists but fails the default version probe.

Setting Variables Before Launch

Prefix variables inline on the same line as the start command:
ODYSSEUS_BACKEND=llama ODYSSEUS_PORT=8000 ./start.sh
Or export them for the session:
export ODYSSEUS_BACKEND=llama
export ODYSSEUS_PORT=8000
export ODYSSEUS_LLAMA_PARALLEL=2
./start.sh

Precedence Order

Environment variables sit in the middle of a three-tier configuration hierarchy:
  1. CLI flags (e.g., --backend=llama) — highest priority, override everything
  2. Environment variables (e.g., ODYSSEUS_BACKEND=llama) — override the config file
  3. data/launcher_config.json — persisted defaults, loaded at startup
  4. Built-in defaults — lowest priority, used when nothing else is set
For settings you want to persist across every launch without typing environment variables each time, write them to data/launcher_config.json instead. See the Launcher Config page for details.

Build docs developers (and LLMs) love