Skip to content

Commit dad7e65

Browse files
author
linda
committed
started outlining possible compose page outline
1 parent 1f2c25f commit dad7e65

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

docs/concepts/compose-support.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Compose Support
3+
description: Defang supports many of the properties of the Compose specification.
4+
sidebar_position: 160
5+
---
6+
7+
# Compose Support
8+
9+
This page outlines what properties of the [Compose specification](https://docs.docker.com/compose/compose-file/) Defang supports when writing a `compose.yaml` file.
10+
For a more general overview of how Defang works with Compose, please see our [Compose](/docs/concepts/compose) page.
11+
12+
### Supported Compose Properties
13+
|Property | Details
14+
|-|-
15+
|`image` |
16+
17+
### Optional Compose Properties
18+
|Property | Details
19+
|-|-
20+
|`ports` | If left unspecified, a random port will be chosen.
21+
|`memory` | If left unspecified, will resort to default.
22+
|`environment` |
23+
24+
### Depreciated Compose Properties
25+
|Property | Details
26+
|-|-
27+
|`version` | This top-level element is no longer needed in the Compose file. Instead, Defang uses the most recent schema supported for parsing the file.
28+
29+
### Unsupported Compose Properties
30+
|Property | Details
31+
|-|-
32+
|`volume` | Volume mounts are not currently supported by Defang, but will not break the file if included.
33+
34+
35+
36+
### Configuration
37+
You can define sensitive environment variables/configuration for Defang by writing out the variable name and leaving it in as a blank or `null` value in the Compose file. See our [Configuration](/docs/concepts/configuration) page for more.

0 commit comments

Comments
 (0)