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

60 lines
2.7 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: Compose file reference
toc_max: 4
toc_min: 1
grid:
- title: Version and name top-level element
description: Understand version and name attributes for Compose.
icon: text_snippet
link: /reference/compose-file/version-and-name/
- title: Services top-level element
description: Explore all services attributes for Compose.
icon: construction
link: /reference/compose-file/services/
- title: Networks top-level element
description: Find all networks attributes for Compose.
icon: lan
link: /reference/compose-file/networks/
- title: Volumes top-level element
description: Explore all volumes attributes for Compose.
icon: database
link: /reference/compose-file/volumes/
- title: Configs top-level element
description: Find out about configs in Compose.
icon: settings
link: /reference/compose-file/configs/
- title: Secrets top-level element
description: Learn about secrets in Compose.
icon: lock
link: /reference/compose-file/secrets/
aliases:
- /compose/yaml/
- /compose/compose-file/compose-file-v1/
- /compose/compose-file/
- /compose/reference/overview/
---
>**New to Docker Compose?**
>
> Find more information about the [key features and use cases of Docker Compose](/manuals/compose/intro/features-uses.md) or [try the quickstart guide](/manuals/compose/gettingstarted.md).
The Compose Specification is the latest and recommended version of the Compose file format. It helps you define a [Compose file](/manuals/compose/intro/compose-application-model.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.
The Compose Specification on Docker Docs is the Docker Compose implementation. If you wish to implement your own version of the Compose Specification, see the [Compose Specification repository](https://github.com/compose-spec/compose-spec).
Use the following links to navigate key sections of the Compose Specification.
> [!TIP]
>
> Want a better editing experience for Compose files in VS Code?
> Check out the [Docker VS Code Extension (Beta)](https://marketplace.visualstudio.com/items?itemName=docker.docker) for linting, code navigation, and vulnerability scanning.
{{< grid >}}