Predefined environment variables¶

Variable name	Visibility	Description
`IS_QCK`	Always	This variable is always set to `true`
`QCK_SERVICE_ID`	Always	Service ID
`QCK_SERVICE_NAME`	Always	Service name
`QCK_SERVICE_[NAME]_URL`	Always	URL of the given service
`QCK_SERVICE_[NAME]_DOMAIN`	Always	URL of the given service without protocol.
`QCK_SERVICE_DEFAULT`	Always	Set to `true` if the current service is the default one. To `false` in other case
`QCK_ENVIRONMENT_URL`	Always	Full environment url, with protocol
`QCK_ENVIRONMENT_DOMAIN`	Always	Environment url without protocol
`QCK_ENVIRONMENT_BASE_DOMAIN`	Always	Base domain of the Qaack instance
`QCK_ENVIRONMENT_URL_[ALIAS]`	Always	Similar to QCK_ENVIRONMENT_URL but for a alias
`QCK_ENVIRONMENT_DOMAIN_[ALIAS]`	Always	Similar to QCK_ENVIRONMENT_DOMAIN but for a alias
`QCK_ENVIRONMENT_ID`	Always	Environment ID
`QCK_ENVIRONMENT_REF`	Always	Environment reference
`QCK_ENVIRONMENT_REF_NAME`	Always	Environment reference name
`QCK_ENVIRONMENT_REF_TYPE`	Always	Environment reference type
`QCK_ENVIRONMENT_CREATED_AT_UNIX`	Always	Environment creation time in unix format
`QCK_ENVIRONMENT_CREATED_AT`	Always	Environment creation time
`QCK_ENVIRONMENT_TTL`	Only if the environment has expiration time	Time to live of the environment
`QCK_ENVIRONMENT_EXPIRATION_TIME_UNIX`	Only defined if there if the environment has expiration time.	Expiration time in unix format
`QCK_ENVIRONMENT_EXPIRATION_TIME`	Only defined if there if the environment has expiration time.	Expiration time
`QCK_REPOSITORY_NAME`	Always	Repository name
`QCK_REPOSITORY_TYPE`	Always	Repository type
`QCK_REPOSITORY_ORIGIN`	Only in generic repositories	This variable is set only in generic repositories
`QCK_GROUP_ID`	Always	Group ID
`QCK_GROUP_NAME`	Always	Group name
`QCK_VOLUME_[NAME]`	If volumes defined	Volume name

Custom variables¶

Custom variables can be created on a group or repository. They use the same shape in both scopes:

Field	Type	Description
`name`	string	Variable name.
`value`	base64 string	Variable value encoded as base64 when sent to the API.
`visibility`	`always` or `buildtime`	`always` variables are available at runtime. `buildtime` variables are available only during image build. Defaults to `always`.
`type`	`default` or `file`	`default` injects the value directly. `file` writes the value to a file and injects the file path. Defaults to `default`.
`secret`	boolean	Marks the variable as secret. Defaults to `false`.

Secret variables are normal custom variables with secret: true. Qaack still injects their stored value into environments, but the panel and settings API do not return the value after it is saved. Secret values are returned as an empty string in group and repository settings responses.

Only group admins and owners can create, edit, or delete group and repository variables. Editing a secret variable without sending a value keeps the existing stored value.