Files
terraform-provider-dokploy/docs/resources/domain.md
T
max-voitcov 2d1caf6e73
build / build (push) Successful in 3m56s
release / release (push) Successful in 15m2s
Cover what Dokploy v0.30 added
Six new resources, all backed by endpoints that did not exist before v0.30.0
and verified end-to-end against a live v0.30.2 instance:

  dokploy_network         Docker networks, now first-class. Services attach
                          through network_ids, which is what deprecates
                          Compose's isolated_deployment upstream.
  dokploy_dns_provider    Cloudflare or Route53, so adding a domain creates
                          its DNS record.
  dokploy_vault_provider  Env values resolved from HashiCorp Vault, Infisical,
                          AWS, Doppler, Azure or Scaleway at deploy time, so
                          the secret never lands in Dokploy or in state.
  dokploy_schedule        Cron jobs in a container, a stack, or on a server.
  dokploy_volume_backup   Scheduled backups of a named volume — the companion
                          to a mount that persists.
  dokploy_libsql          The sixth managed database engine.

libsql.create is the strictest endpoint in the API: eleven keys required to
be present, several only meaningfully null, no generated service name, and it
returns `true` rather than the row. CreateDefaults and ListIDs absorb all
three so the resource behaves like every other database.

Also filled the gaps a field-by-field diff against the live schema turned up:
domain gains `enabled` (the v0.30.0 park-a-domain toggle), compose gains
create_env_file, icon and service_networks, application gains icon and
preview_require_collaborator_permissions, and mounts accept libsql.

DNS and vault credentials are masked by Dokploy on read, so `config` is
tagged noread and keeps the configured value, as the basic-auth password
already does.
2026-08-26 00:40:27 +03:00

2.5 KiB

page_title, subcategory, description
page_title subcategory description
dokploy_domain Resource - dokploy A domain routed to an application or a Compose service through Dokploy's Traefik instance. Set exactly one of application_id or compose_id. When targeting a Compose stack, service_name selects which service in the stack receives the traffic.

dokploy_domain (Resource)

A domain routed to an application or a Compose service through Dokploy's Traefik instance.

Set exactly one of application_id or compose_id. When targeting a Compose stack, service_name selects which service in the stack receives the traffic.

Schema

Required

  • host (String) Fully-qualified hostname, for example api.example.com.

Optional

  • application_id (String) Application this domain routes to.
  • certificate_type (String) How TLS certificates are obtained. Use letsencrypt for automatic certificates. Valid values: letsencrypt, none, custom.
  • compose_id (String) Compose stack this domain routes to.
  • custom_cert_resolver (String) Traefik certificate resolver name, when certificate_type is custom.
  • custom_entrypoint (String) Traefik entrypoint to bind, when not using the defaults.
  • domain_type (String) What kind of target this domain points at. Valid values: compose, application, preview.
  • enabled (Boolean) Whether the domain is served. Setting this to false removes the route from Traefik but keeps the certificate, path and middleware configuration intact, so the domain can be brought back without reconfiguring it.
  • forward_auth_enabled (Boolean) Protect this domain with Dokploy's forward auth.
  • https (Boolean) Serve the domain over HTTPS and redirect HTTP traffic to it.
  • internal_path (String) Path the request is rewritten to before it reaches the container, defaults to /.
  • middlewares (List of String) Names of Traefik middlewares to apply.
  • path (String) Path prefix this domain routes, defaults to /.
  • port (Number) Container port that receives the traffic, defaults to 3000.
  • preview_deployment_id (String) Preview deployment this domain routes to.
  • service_name (String) Name of the service inside a Compose stack that receives the traffic. Required when compose_id is set.
  • strip_path (Boolean) Strip path from the request before forwarding it.

Read-Only

  • created_at (String) RFC 3339 timestamp of when the domain was created.
  • id (String) Unique domain identifier.