# DockerComposeEnvironmentExtensions

- Kind: `class`
- Package: [Aspire.Hosting.Docker](/reference/api/csharp/aspire.hosting.docker.md)
- Version: `13.3.0`
- Namespace: `Aspire.Hosting`
- Target framework: `net8.0`
- Source: [GitHub](https://github.com/microsoft/aspire/blob/5bd693ae1897dee5e2ce71c2cc08879c1c7eff51/src/Aspire.Hosting.Docker/DockerComposeEnvironmentExtensions.cs)

Provides extension methods for adding Docker Compose environment resources to the application model.

## Definition

```csharp
namespace Aspire.Hosting;

public static class DockerComposeEnvironmentExtensions
{
    // ...
}
```

## Methods

- [AddDockerComposeEnvironment(IDistributedApplicationBuilder, string)](/reference/api/csharp/aspire.hosting.docker/dockercomposeenvironmentextensions/methods.md#adddockercomposeenvironment-idistributedapplicationbuilder-string) : `IResourceBuilder<DockerComposeEnvironmentResource>` `extension` `ats export` -- Adds a Docker Compose environment to the application model.
- [ConfigureComposeFile(IResourceBuilder<DockerComposeEnvironmentResource>, Action<ComposeFile>)](/reference/api/csharp/aspire.hosting.docker/dockercomposeenvironmentextensions/methods.md#configurecomposefile-iresourcebuilder-dockercomposeenvironmentresource-action-composefile) : `IResourceBuilder<DockerComposeEnvironmentResource>` `extension` `ats export` -- Configures the Docker Compose file for the environment resource.
- [ConfigureEnvFile(IResourceBuilder<DockerComposeEnvironmentResource>, Action<IDictionary<string, CapturedEnvironmentVariable>>)](/reference/api/csharp/aspire.hosting.docker/dockercomposeenvironmentextensions/methods.md#configureenvfile-iresourcebuilder-dockercomposeenvironmentresource-action-idictionary-string-capturedenvironmentvariable) : `IResourceBuilder<DockerComposeEnvironmentResource>` `extension` `ats export` -- Configures the captured environment variables for the Docker Compose environment before they are written to the .env file.
- [WithDashboard(IResourceBuilder<DockerComposeEnvironmentResource>, bool)](/reference/api/csharp/aspire.hosting.docker/dockercomposeenvironmentextensions/methods.md#withdashboard-iresourcebuilder-dockercomposeenvironmentresource-bool) : `IResourceBuilder<DockerComposeEnvironmentResource>` `extension` `ats export` -- Enables the Aspire dashboard for telemetry visualization in this Docker Compose environment.
- [WithDashboard(IResourceBuilder<DockerComposeEnvironmentResource>, Action<IResourceBuilder<DockerComposeAspireDashboardResource>>)](/reference/api/csharp/aspire.hosting.docker/dockercomposeenvironmentextensions/methods.md#withdashboard-iresourcebuilder-dockercomposeenvironmentresource-action-iresourcebuilder-dockercomposeaspiredashboardresource) : `IResourceBuilder<DockerComposeEnvironmentResource>` `extension` `ats export` -- Configures the dashboard properties for this Docker Compose environment.
- [WithProperties(IResourceBuilder<DockerComposeEnvironmentResource>, Action<DockerComposeEnvironmentResource>)](/reference/api/csharp/aspire.hosting.docker/dockercomposeenvironmentextensions/methods.md#withproperties-iresourcebuilder-dockercomposeenvironmentresource-action-dockercomposeenvironmentresource) : `IResourceBuilder<DockerComposeEnvironmentResource>` `extension` `ats export` -- Allows setting the properties of a Docker Compose environment resource.