OrbSearchDocs
GuideReference

Environment variables

Every setting of the stack's .env, what it does, its default and the services that read it.

Settings for docker compose. make .env copies this file to .env and fills in the empty secrets; run again after this file gains a setting, it adds only what .env lacks. By hand, generate each secret with openssl rand -hex 32 (APP_KEY: "base64:" followed by openssl rand -base64 32).

APP_KEYRequired

The control plane's encryption key. Read by control.

APP_URLDefault http://localhost:8000

Where merchants open the panel. Read by control.

Postgres: the superuser only sets up the roles; the control plane, the indexer and the Query API have one each.

POSTGRES_PASSWORDRequired

Read by postgres.

DB_PASSWORDRequired

Read by postgres, control.

MEILI_MASTER_KEYRequired

At least 16 bytes. Only the indexer holds it. Read by meilisearch, indexer.

MEILI_SEARCH_KEYRequired

The Query API's key, which may only search and list indexes; the indexer creates it from the master key at start. make .env derives it; by hand, it is the master key's HMAC of the key's uid: printf %s 5e7d2c4a-8f1b-4c3e-9a6d-0b2f4e6a8c1d | openssl dgst -sha256 -hmac "$MEILI_MASTER_KEY" Read by orbsearch.

ORBSEARCH_MANAGEMENT_KEYRequired

Authorizes the management API: Authorization: Bearer <key>. Read by control.

The panel and the Query API listen on this host address. 127.0.0.1 keeps them for a proxy on this machine, which also terminates TLS; 0.0.0.0 opens them to the network.

PUBLISH_ADDRESSDefault 127.0.0.1

Read by orbsearch, control.

CONTROL_PORTDefault 8000

Read by control.

ORBSEARCH_PORTDefault 7800

Read by orbsearch.

Postgres and Meilisearch listen on 127.0.0.1 only.

POSTGRES_PORTDefault 5432

Read by postgres.

MEILISEARCH_PORTDefault 7700

Read by meilisearch.

DEMO_PORTDefault 3000

The demo storefront, which make e2e serves on the host for its browser tests. Read by control.

SHOP_URLDefault http://localhost:${DEMO_PORT:-3000}Example https://shop.example

Where the shop answers, so the panel's previews show its photos; the demo storefront at DEMO_PORT when unset. Read by control.

ORBSEARCH_FEEDS_FROM_PRIVATE_NETWORKSDefault false

The catalog source's feed is fetched from the public internet only. true also fetches from private, loopback and link-local addresses, such as a feed on this machine or on the shop's own network; make stack sets it. Read by control.

TRUSTED_PROXIES

Behind a proxy that terminates TLS: its addresses, comma-separated. Never *. Read by control.

A real mailer turns on email verification; without one, mail goes to the log.

MAIL_MAILERExample smtp

Read by control.

AI_GATEWAY_API_KEY

Optional: a Vercel AI Gateway key turns on mapping suggestions in the import panel (model typesafe-ai/jev). Without it, the panel maps with the import's own rules only. Read by orbsearch.

Guide: Settings

On this page

No Headings