Installation Configuration
Installation Configuration
Configuration Parameters Table
The LLMInspect installer prompts for the following configuration options, in this order. Values marked as hidden are not shown while you type.
| Parameter | Description | What to enter | Example |
|---|---|---|---|
| MongoDB Configuration | |||
| MONGO_INITDB_ROOT_USERNAME | Sets the root or administrative username for your MongoDB instance | A username of at least 4 characters | mongoadmin |
| MONGO_INITDB_ROOT_PASSWORD | Password for the MongoDB root user (hidden) | A strong password of at least 8 characters | - |
| Keycloak Configuration | |||
| KEYCLOAK_ADMIN_PASSWORD | Password for the Keycloak administrator account admin, which you use to manage users in the Keycloak admin console (hidden) |
A strong password of at least 8 characters | - |
| API Keys | |||
| OPENAI_API_KEY | API key for accessing OpenAI services (hidden) | Your OpenAI API key | - |
| GEMINI_API_KEY | API key for accessing Google Gemini services (hidden) | Your Gemini API key | - |
| Endpoint URLs | |||
| LLAMA_GUARD_URL | Complete URL of your Llama Guard instance, used for content safety checks | The full endpoint, including protocol, IP address or host name, port and /generate |
http://192.168.1.100:8080/generate |
| LLM_BASE_URL | Base URL of your local LLM's chat completion endpoint | The endpoint up to and including /v1/. For example, if the full endpoint is http://192.168.1.60:8000/v1/chat/completions, enter http://192.168.1.60:8000/v1/ |
https://llm.example.com:5000/v1/ |
| LLM Gateway Credentials | |||
| LLMGW_KEY | License key used to authenticate your deployment with the LLM Gateway | The license key provided with your LLMInspect subscription | LLMGW-KEY-9876543210 |
| AUTHCODE | Authentication code required for secure access to the LLM Gateway | The auth code provided with your license key | auth1234 |
Note: The installer does not check the length or format of these values, so enter them carefully.
Other Values the Installer Asks For
| Prompt | What to enter | Example |
|---|---|---|
Docker Hub Username and Password |
The Docker Hub account that has access to the LLMInspect images. The password is shown on screen as you type it. | - |
Please enter your Fully Qualified Domain Name (FQDN) |
The domain name of the LLMInspect server, without https:// or a port. Only asked when you do not pass --cert-file, --cert-key and --domain. |
llminspect.example.com |
Values Generated Automatically
When you enter the values interactively, the installer generates the following internal secrets for you. You do not need to provide them:
APISIX_ADMIN_KEYandAPISIX_VIEWER_KEY(API gateway keys)OPENID_CLIENT_SECRET,GRAFANA_OAUTH_CLIENT_SECRETandLLMGW_OAUTH_CLIENT_SECRET(authentication client secrets)POSTGRES_USERandPOSTGRES_PASSWORD(Keycloak database credentials)
Using an Environment File
With --env-file, the installer reads the values from a file instead of asking for them. The file must contain all nine parameters from the table above, one KEY=VALUE per line:
MONGO_INITDB_ROOT_USERNAME=mongoadmin
MONGO_INITDB_ROOT_PASSWORD=<strong-password>
KEYCLOAK_ADMIN_PASSWORD=<strong-password>
OPENAI_API_KEY=<your-openai-api-key>
GEMINI_API_KEY=<your-gemini-api-key>
LLAMA_GUARD_URL=http://192.168.1.100:8080/generate
LLM_BASE_URL=http://192.168.1.60:8000/v1/
LLMGW_KEY=<your-license-key>
AUTHCODE=<your-auth-code>
When you use an environment file, the installer does not generate the internal secrets listed above. Add them to the file yourself, for example with values generated by openssl rand -hex 16:
APISIX_ADMIN_KEY=<random-value>
APISIX_VIEWER_KEY=<random-value>
OPENID_CLIENT_SECRET=<random-value>
GRAFANA_OAUTH_CLIENT_SECRET=<random-value>
LLMGW_OAUTH_CLIENT_SECRET=<random-value>
POSTGRES_USER=<random-value>
POSTGRES_PASSWORD=<random-value>
If you leave them out, the installation still completes, but these components keep the default values shipped with LLMInspect.
Keep the environment file secure, because it contains your passwords and API keys.