# Aspire.Hosting.Docker

- Module: `Aspire.Hosting.Docker`
- Version: `13.4.0`
- Source: [GitHub](https://github.com/microsoft/aspire)
- Functions: `16`
- Types: `14`

## Types

- [CapturedEnvironmentVariable](/reference/api/typescript/aspire.hosting.docker/capturedenvironmentvariable.md) -- `handle` - 6 members -- Represents a captured environment variable that will be written to the .env file adjacent to the Docker Compose file.
- [ComposeFile](/reference/api/typescript/aspire.hosting.docker/composefile.md) -- `handle` - 21 members -- Represents a Docker Compose file with properties and configurations for services, networks, volumes, secrets, configs, and custom extensions.
- [Config](/reference/api/typescript/aspire.hosting.docker/config.md) -- `handle` - 10 members -- Represents a configuration object in a Docker Compose file.
- [ConfigReference](/reference/api/typescript/aspire.hosting.docker/configreference.md) -- `handle` - 10 members -- Represents a reference to a configuration used within a service resource.
- [DockerComposeAspireDashboardResource](/reference/api/typescript/aspire.hosting.docker/dockercomposeaspiredashboardresource.md) -- `handle` - 4 members -- Represents a resource for the Aspire Dashboard. This resource is used to visualize telemetry data in the Aspire Hosting environment.
- [DockerComposeEnvironmentResource](/reference/api/typescript/aspire.hosting.docker/dockercomposeenvironmentresource.md) -- `handle` - 10 members -- Represents a Docker Compose environment resource that can host application resources.
- [DockerComposeServiceResource](/reference/api/typescript/aspire.hosting.docker/dockercomposeserviceresource.md) -- `handle` - 1 members -- Represents a compute resource for Docker Compose with strongly-typed properties.
- [Network](/reference/api/typescript/aspire.hosting.docker/network.md) -- `handle` - 16 members -- Represents a Docker network configuration as part of a Compose file.
- [Secret](/reference/api/typescript/aspire.hosting.docker/secret.md) -- `handle` - 8 members -- Represents a Secret object in a Docker Compose configuration file.
- [SecretReference](/reference/api/typescript/aspire.hosting.docker/secretreference.md) -- `handle` - 10 members -- Represents a reference to a secret within a Docker service configuration.
- [Service](/reference/api/typescript/aspire.hosting.docker/service.md) -- `handle` - 97 members -- Represents a Docker Compose service definition.
- [ServiceDependency](/reference/api/typescript/aspire.hosting.docker/servicedependency.md) -- `handle` - 2 members -- Represents a service dependency in a Docker Compose file.
- [Ulimit](/reference/api/typescript/aspire.hosting.docker/ulimit.md) -- `handle` - 4 members -- Represents the configuration for system resource limits (ulimits) for a container.
- [Volume](/reference/api/typescript/aspire.hosting.docker/volume.md) -- `handle` - 18 members -- Represents a volume definition in a Docker Compose configuration file.

## Functions

- [addConfig](/reference/api/typescript/aspire.hosting.docker/addconfig.md) -- `method` -- Adds a top-level config definition to the Docker Compose file.
- [addDockerComposeEnvironment](/reference/api/typescript/aspire.hosting.docker/adddockercomposeenvironment.md) -- `method` -- Adds a Docker Compose environment to the application model.
- [addNetwork](/reference/api/typescript/aspire.hosting.docker/addnetwork.md) -- `method` -- Adds a top-level network definition to the Docker Compose file.
- [addSecret](/reference/api/typescript/aspire.hosting.docker/addsecret.md) -- `method` -- Adds a top-level secret definition to the Docker Compose file.
- [addService](/reference/api/typescript/aspire.hosting.docker/addservice.md) -- `method` -- Adds a service definition to the Docker Compose file.
- [addVolume](/reference/api/typescript/aspire.hosting.docker/addvolume.md) -- `method` -- Adds a top-level volume definition to the Docker Compose file.
- [addVolume](/reference/api/typescript/aspire.hosting.docker/addvolume.md) -- `method` -- Adds a volume mount to a generated Docker Compose service.
- [asEnvironmentPlaceholder](/reference/api/typescript/aspire.hosting.docker/asenvironmentplaceholder.md) -- `method` -- Creates a Docker Compose environment variable placeholder from a parameter builder
- [configureComposeFile](/reference/api/typescript/aspire.hosting.docker/configurecomposefile.md) -- `method` -- Configures the Docker Compose file for the environment resource.
- [configureDashboard](/reference/api/typescript/aspire.hosting.docker/configuredashboard.md) -- `method` -- Configures the dashboard properties for this Docker Compose environment.
- [configureEnvFile](/reference/api/typescript/aspire.hosting.docker/configureenvfile.md) -- `method` -- Configures the captured environment variables for the Docker Compose environment before they are written to the .env file.
- [publishAsDockerComposeService](/reference/api/typescript/aspire.hosting.docker/publishasdockercomposeservice.md) -- `method` -- Publishes the specified resource as a Docker Compose service.
- [withDashboard](/reference/api/typescript/aspire.hosting.docker/withdashboard.md) -- `method` -- Enables the Aspire dashboard for telemetry visualization in this Docker Compose environment.
- [withForwardedHeaders](/reference/api/typescript/aspire.hosting.docker/withforwardedheaders.md) -- `method` -- Configures whether forwarded headers processing is enabled for the Aspire dashboard container.
- [withHostPort](/reference/api/typescript/aspire.hosting.docker/withhostport.md) -- `method` -- Configures the port used to access the Aspire Dashboard from a browser.
- [withProperties](/reference/api/typescript/aspire.hosting.docker/withproperties.md) -- `method` -- Allows setting the properties of a Docker Compose environment resource.