---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "dokploy_compose Resource - dokploy"
subcategory: ""
description: |-
  A Docker Compose or Docker Swarm stack managed by Dokploy.
  Set compose_file to manage the stack definition inline (with source_type = "raw"), or point the stack at a Git repository and set compose_path.
  ~> Creating this resource does not deploy the stack.
---

# dokploy_compose (Resource)

A Docker Compose or Docker Swarm stack managed by Dokploy.

Set `compose_file` to manage the stack definition inline (with `source_type = "raw"`), or point the stack at a Git repository and set `compose_path`.

~> Creating this resource does **not** deploy the stack.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `environment_id` (String) Environment this stack belongs to.
- `name` (String) Display name of the stack.

### Optional

- `app_name` (String) Unique Docker stack name. Generated by Dokploy when omitted. Changing it forces a new stack.
- `auto_deploy` (Boolean) Deploy automatically when the configured trigger fires.
- `bitbucket_branch` (String) Bitbucket branch to deploy.
- `bitbucket_id` (String) ID of the configured Bitbucket provider connection.
- `bitbucket_owner` (String) Bitbucket repository owner.
- `bitbucket_repository` (String) Bitbucket repository name.
- `bitbucket_repository_slug` (String) Bitbucket repository slug.
- `branch` (String) GitHub branch to deploy.
- `command` (String) Custom `docker compose` command to run.
- `compose_file` (String) Inline Compose file contents. Used when `source_type` is `raw`.
- `compose_path` (String) Path to the Compose file within the repository.
- `compose_type` (String) Whether to run the stack with Docker Compose or Docker Swarm. Valid values: `docker-compose`, `stack`.
- `custom_git_branch` (String) Branch to deploy for a custom Git remote.
- `custom_git_ssh_key_id` (String) SSH key used to clone a private custom Git remote.
- `custom_git_url` (String) Git remote URL, when `source_type` is `git`.
- `delete_volumes` (Boolean) Whether to delete the stack's Docker volumes when this resource is destroyed. Defaults to `false`, which preserves the data.
- `description` (String) Free-form description.
- `enable_submodules` (Boolean) Clone Git submodules when checking out the repository.
- `env` (String) Environment variables in `KEY=value` format, one per line.
- `gitea_branch` (String) Gitea branch to deploy.
- `gitea_id` (String) ID of the configured Gitea provider connection.
- `gitea_owner` (String) Gitea repository owner.
- `gitea_repository` (String) Gitea repository name.
- `github_id` (String) ID of the configured GitHub provider connection.
- `gitlab_branch` (String) GitLab branch to deploy.
- `gitlab_id` (String) ID of the configured GitLab provider connection.
- `gitlab_owner` (String) GitLab repository owner.
- `gitlab_path_namespace` (String) Full GitLab namespace path.
- `gitlab_project_id` (Number) Numeric GitLab project ID.
- `gitlab_repository` (String) GitLab repository name.
- `isolated_deployment` (Boolean) Run the stack on its own isolated Docker network.
- `isolated_deployments_volume` (Boolean) Prefix volume names for isolated deployments. Retained for backwards compatibility.
- `owner` (String) GitHub repository owner.
- `randomize` (Boolean) Append a random suffix to service and volume names.
- `repository` (String) GitHub repository name.
- `server_id` (String) Remote server to deploy on. Omit to use the Dokploy host itself.
- `source_type` (String) Where the Compose file comes from. Valid values: `git`, `github`, `gitlab`, `bitbucket`, `gitea`, `raw`.
- `suffix` (String) Suffix appended to generated resource names.
- `trigger_type` (String) What triggers an automatic deployment. Valid values: `push`, `tag`.
- `watch_paths` (List of String) Glob patterns that limit which changed paths trigger an automatic deployment.

### Read-Only

- `compose_status` (String) Current status reported by Dokploy: `idle`, `running`, `done` or `error`.
- `created_at` (String) RFC 3339 timestamp of when the stack was created.
- `id` (String) Unique compose identifier.