docs/content/compose/compose-file/_index.md

70 lines
2.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
description: Find the latest recommended version of the Docker Compose file format
for defining multi-container applications.
keywords: docker compose file, docker compose yml, docker compose reference, docker
compose cmd, docker compose user, docker compose image, yaml spec, docker compose
syntax, yaml specification, docker compose specification
title: Overview
toc_max: 4
toc_min: 1
grid:
- title: Status of the Specification
description: Read about the status of the specification.
icon: select_check_box
link: /compose/compose-file/01-status/
- title: The Compose application model
description: Learn about the Compose application model.
icon: storage
link: /compose/compose-file/02-model/
- title: The Compose file
description: Understand the Compose file.
icon: web_stories
link: /compose/compose-file/03-compose-file/
- title: Version and name top-level element
description: Understand version and name attributes for Compose.
icon: feed
link: /compose/compose-file/04-version-and-name/
- title: Services top-level element
description: Explore all services attributes for Compose.
icon: construction
link: /compose/compose-file/05-services/
- title: Networks top-level element
description: Find all networks attributes for Compose.
icon: lan
link: /compose/compose-file/06-networks/
- title: Volumes top-level element
description: Explore all volumes attributes for Compose.
icon: database
link: /compose/compose-file/07-volumes/
- title: Configs top-level element
description: Find out about configs in Compose.
icon: settings_suggest
link: /compose/compose-file/08-configs/
- title: Secrets top-level element
description: Learn about secrets in Compose.
icon: lock
link: /compose/compose-file/09-secrets/
aliases:
- /compose/yaml/
- /compose/compose-file/compose-file-v1/
---
>**New to Compose?**
>
> Find more information about the [key features and use cases of Docker Compose](../features-uses.md) or [try the get started guide](../gettingstarted.md).
{ .tip }
The [Compose Specification](https://github.com/compose-spec/compose-spec/blob/master/spec.md) is the latest and recommended version of the Compose file format. It helps you define a [Compose file](03-compose-file.md) which is used to configure your Docker applications services, networks, volumes, and more.
Legacy versions 2.x and 3.x of the Compose file format were merged into the Compose Specification. It is implemented in versions 1.27.0 and above (also known as Compose V2) of the Docker Compose CLI.
> **Note**
>
> Compose V1 no longer receives updates and will not be available in new releases of Docker Desktop after June 2023.
>
> Compose V2 is included with all currently supported versions of Docker Desktop.
> For more information, see [Migrate to Compose V2](/compose/migrate).
Use the following links to navigate key sections of the Compose Specification.
{{< grid >}}