GitHub Viewer
# nerdctl compose
| :zap: Requirement | nerdctl >= 0.8 |
|-------------------|----------------|
## Usage
The `nerdctl compose` CLI is designed to be compatible with `docker-compose`.
```console
$ nerdctl compose up -d
$ nerdctl compose down
```
See the Command Reference in [`../README.md`](../README.md).
## Spec conformance
`nerdctl compose` implements [The Compose Specification](https://github.com/compose-spec/compose-spec),
which was derived from [Docker Compose file version 3 specification](https://docs.docker.com/compose/compose-file/compose-file-v3/).
### Unimplemented YAML fields
- Fields that correspond to unimplemented `docker run` flags, e.g., `services..links` (corresponds to `docker run --link`)
- Fields that correspond to unimplemented `docker build` flags, e.g., `services..build.extra_hosts` (corresponds to `docker build --add-host`)
- `services..credential_spec`
- `services..deploy.update_config`
- `services..deploy.rollback_config`
- `services..deploy.placement`
- `services..deploy.endpoint_mode`
- `configs..external`
- `secrets..external`
### Incompatibility
#### `services..build.context`
- The value must be a local directory path, not a URL.
#### `services..secrets`, `services..configs`
- `uid`, `gid`: Cannot be specified. The default value is not propagated from `USER` instruction of Dockerfile.
The file owner corresponds to the original file on the host.
- `mode`: Cannot be specified. The file is mounted as read-only, with permission bits that correspond to the original file on the host.
#### `services..volumes[].type: image`
- Whole-image mounts are supported.
- `source` is interpreted as an image reference, including when it matches a service name.
- `services..volumes[].image.subpath` is not yet supported.