Environment variables
These are environment variables available to your app at runtime provided by HOPS.
| var | what | see |
|---|---|---|
DATABASE_URL | Full URL/connection string of provisioned database. postgres://user:password@host:port/database | postgres |
DB_DATABASE | database of the provisioned database, alias of PGDATABASE | postgres |
DB_HOST | host of the provisioned database, alias of PGHOST | postgres |
DB_PORT | port of the provisioned database, alias of PGPORT | postgres |
DB_PASSWORD | password of the provisioned database, alias of PGPASSWORD | postgres |
DB_USERNAME | user of the provisioned database, alias of PGUSER | postgres |
HOPS_BUILD_NUMBER | Deprecated in favour of HOPS_BUILD_ID | |
HOPS_BUILD_ID | The build id associated with the running container. | |
HOPS_DEPLOYMENT_ID | The deployment id for the deploy that is currently running. | iterapp.toml |
HOPS_DOMAIN | The main domain the app listens to. | domains |
HOPS_DOMAINS | Comma speratated list of all domains the app listens to. | domains |
HOPS_ENV | The environment the app is running in. (E.g prod, test, snap3, etc) | environments |
HOPS_GIT_SHA | The GIT SHA hash used for building | iterapp.toml |
ITERAPP_BUILD_NUMBER | Deprecated in favour of HOPS_BUILD_ID | |
ITERAPP_DEPLOYMENT_ID | Deprecated in favour of HOPS_DEPLOYMENT_ID | |
ITERAPP_GIT_SHA | Deprecated in favour of HOPS_GIT_SHA | |
NATS_CA_FILE | Path to a file with the CA-certificate used to sign the TLS-certificate used by NATS | NATS |
NATS_CREDENTIALS | The credentials required to connect to the nats-server | NATS |
NATS_CREDENTIALS_FILE | Path of a file with the same content as in NATS_CREDENTIALS | NATS |
NATS_URL | URL used to connect to the nats-server | NATS |
PGDATABASE | database of the provisioned database, alias of DB_DATABASE | postgres |
PGHOST | host of the provisioned database, alias of DB_HOST | postgres |
PGPASSWORD | password of the provisioned database, alias of DB_PASSWORD | postgres |
PGPORT | port of the provisioned database, alias of DB_PORT | postgres |
PGUSER | user of the provisioned database, alias of DB_USER | postgres |
PORT | set by the port property in iterapp.toml (defaults to 3000) | iterapp.toml |
REDIS_HOST | host for provisioned Redis. | redis |
REDIS_PASSWORD | password for provisioned Redis. | redis |
REDIS_PORT | port for provisioned Redis. | redis |
REDIS_URL | URL/connection string for provisioned Redis. redis://user:password@host:port | redis |
REDIS_USER | user for provisioned Redis. | redis |
Custom variables
In addition to the variables mentioned above, all environment variables you
specify in iterapp.toml will be available the app in the appropriate
environment.
System variables
In addition to the variables mentioned above, the OS/distro/runtime of your app (for example Ubuntu, ZSH) will set environment variables available to your app.