Skip to main content
Version: Next

Configuration

Settings use the EP_ prefix and nothing else. The backend's own settings keep their own names in the backend's .env; Emuplane never writes there.

Two kinds of setting​

That split is the porting contract:

  • Container settings — read at runtime, and docker-compose.yml passes exactly this set; a deployment may supply only what it needs because every other key has a default.
  • Deployment settings — image, network, container names and published ports. They never reach the container.

Container settings​

KeyDefaultWhat it does
EP_BACKENDministackbackend profile; ministack is the tested one (MiniStack 1.5.40-full), and generic is the neutral fallback for an emulator this repository has not been tested against
EP_BACKEND_URLhttp://localhost:4566the emulator endpoint the control talks to; the default is the single-host lab, and a container sets its own because localhost there is the container
EP_CONSOLE_URLhttp://localhost:4570the address a browser uses; set it to the proxy's address behind one
EP_GATEWAY_URLhttp://localhost:4571the address clients sign against; set it to the proxy's address behind one
EP_STORE_ACCOUNT111111111111account the control reads its own DynamoDB tables as
EP_STORE_REGIONus-east-1region those tables live in
EP_STORE_URLemptywhere the control's own tables live; empty means EP_BACKEND_URL, so repointing the backend moves the accounts with it
EP_POLL_SECONDS10seconds between emulator health polls
EP_SESSION_SECONDS28800session lifetime, extended on activity
EP_RECENT_LIMIT5services under Recently visited
TZAfrica/Nairobizone the console renders timestamps in

Mail is optional, for the password-reset link:

KeyDefaultWhat it does
EP_MAIL_HOSTemptyrelay for the reset mail; empty means mail is off and /forgot falls back to an administrator-issued link
EP_MAIL_PORT587relay port (465 with EP_MAIL_SECURITY=ssl)
EP_MAIL_SECURITYstarttlsstarttls, ssl, or none for a local relay
EP_MAIL_USER / EP_MAIL_PASSWORDemptyrelay credentials; the password is a secret and belongs in .env only
EP_MAIL_FROMemptyFrom header
EP_RESET_SECONDS1800how long a reset link stays valid