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

Service

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

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

Service

api_version

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

  • Required.

kind

Resource kind (must be Service).

  • Required.
  • Allowed values: Service.

metadata

Identifying metadata.

  • Required.

spec

Desired service state.

  • Required.

ServiceMeta

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.

ServiceSpec

destination

Server reference the stack runs on.

  • Required.

description

Human-readable service description.

fqdn

Public URL such as https://app.example.com; Coolify binds domains per compose sub-service so this is advisory and not applied on create yet.

instant_deploy

Start the service immediately after creation (default false).

docker_compose_path

Relative path to a docker-compose.yml in the repository (mutually exclusive with type).

type

Coolify one-click template identifier such as gitea-with-mysql (mutually exclusive with docker_compose_path).

env_vars

Environment variables applied to the service.

ServiceDestination

server

Server name (logical reference).

  • Required.