Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Application

Generated by iac-coolify docs gen from the struct tags in internal/resource. Do not edit by hand.

This is the reference for the Application resource and its nested types. Each field below maps 1:1 to a YAML key.

Application

api_version

API schema version (must be iac-coolify/v1).

  • Required.

kind

Resource kind (must be Application).

  • Required.
  • Allowed values: Application.

metadata

Identifying metadata.

  • Required.

spec

Desired application state.

  • Required.

ApplicationMeta

name

Logical name used as the immutable key.

  • Required.

project

Logical project name (referenced by name).

  • Required.

environment

Environment name such as staging or production.

  • Required.

ApplicationSpec

description

Human-readable application description.

build_pack

Build pack to use.

  • Required.
  • Allowed values: dockerfile, dockerimage, nixpacks, docker-compose, static, railpack.

image

Docker image (required when build_pack is dockerimage).

dockerfile

Inline Dockerfile content for build_pack dockerfile in inline mode; mutually exclusive with source.

source

Public git source for build_pack dockerfile/nixpacks/docker-compose/static/railpack.

destination

Server and network reference.

  • Required.

fqdn

Public URL such as https://app.example.com.

port

Container port exposed (required for build_pack dockerimage).

health_check

HTTP health check configuration.

limits

CPU and memory limits.

preview

Pull-request preview configuration.

env_vars

Inline environment variables.

env_vars_from

Names of EnvVar resources whose variables are merged into this application.

ImageSpec

name

Docker image name including the registry path.

  • Required.

tag

Docker image tag.

  • Required.

SourceSpec

git_repository

Public git repository URL (https:// http:// or git@).

  • Required.

git_branch

Git branch to deploy.

  • Required.

ports_exposes

Ports the build exposes such as 3000.

  • Required.

DestinationRef

server

Server name (logical reference).

  • Required.

network

Docker network name.

  • Required.

HealthCheckSpec

enabled

Whether the health check is enabled.

path

HTTP path to probe such as /health.

LimitsSpec

cpu_shares

Relative CPU shares.

memory

Memory limit such as 512m.

PreviewSpec

url_template

Preview URL template such as {{pr_id}}.{{domain}}.

EnvVarEntry

name

Variable name.

  • Required.

value

Visible value (supports ${env:VAR} interpolation); use value_secret for sensitive values.

value_secret

Sensitive value; MUST be ${env:NAME} or ${sops:path} and is shown as [REDACTED].