Max Vojtkov
a6d8aa8b52
Plugin-framework provider covering projects, environments, applications, Compose stacks, managed databases, domains, mounts, ports, redirects, basic auth, registries, SSH keys, certificates and backup destinations, over Dokploy's tRPC-over-REST API. The shim package exposes the provider to other Go modules, which is how pulumi-dokploy bridges it.
47 lines
2.3 KiB
Markdown
47 lines
2.3 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "dokploy_domain Resource - dokploy"
|
|
subcategory: ""
|
|
description: |-
|
|
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 generated by tfplugindocs -->
|
|
## 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`.
|
|
- `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.
|