Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adds more information on how to use compose #3695

Closed
wants to merge 3 commits into from

Conversation

cdrage
Copy link
Contributor

@cdrage cdrage commented Aug 28, 2023

docs: adds more information on how to use compose

What does this PR do?

  • Adds more information on the Compose specification Go implementation
  • Adds compatibility steps for windows, linux and macOS
  • Explains the .bat file which is an undocumented feature

Screenshot/screencast of this PR

N/A, see website preview

What issues does this PR fix or reference?

Closes #3615
Closes #3557

How to test this PR?

View the site

Signed-off-by: Charlie Drage [email protected]

### What does this PR do?

* Adds more information on the Compose specification Go implementation
* Adds compatibility steps for windows, linux and macOS
* Explains the .bat file which is an undocumented feature

### Screenshot/screencast of this PR

<!-- Please include a screenshot or a screencast
explaining what is doing this PR -->

N/A, see website preview

### What issues does this PR fix or reference?

<!-- Include any related issues from Podman Desktop
repository (or from another issue tracker). -->

Closes containers#3615
Closes containers#3557

### How to test this PR?

<!-- Please explain steps to reproduce -->

View the site

Signed-off-by: Charlie Drage <[email protected]>
@cdrage cdrage requested review from slemeur, themr0c, benoitf and a team as code owners August 28, 2023 18:38
@cdrage cdrage requested review from dgolovin and lstocchi and removed request for a team August 28, 2023 18:38
Podman Desktop supports the [Compose spec](https://compose-spec.io). With Podman Desktop, users can easily create and manage multi-container applications by using Compose files.
Podman Desktop supports the [Compose specification](https://compose-spec.io). With Podman Desktop, users can easily create and manage multi-container applications by using Compose files.

We support two version of the Compose specification:
Copy link
Contributor

@themr0c themr0c Aug 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line conflicts with the last line ("Any containers already deployed by Docker Compose / Podman Compose will be automatically shown within Podman Desktop. You do not need to do anything!").

I believe we have to distinguish:

  • Podman Desktop automatically detects any container or service that has a valid compose label (regardless of the Compose engine that created the container or service).

  • Podman Destkop can install and run two Compose engines: Compose and Podman Compose (but not Docker Compose).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah got it! I'll update it.

This line is incorrect:
Podman Destkop can install and run two Compose engines: Compose and Podman Compose (but not Docker Compose).

We install only Compose (and download it as the docker-compose binary), not Podman Compose.

And Compose = Docker Compose. Docker references Compose as just "Compose" rather than Docker Compose.

cdrage and others added 2 commits August 29, 2023 08:11
Co-authored-by: Fabrice Flore-Thébault <[email protected]>
Signed-off-by: Charlie Drage <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>
Signed-off-by: Charlie Drage <[email protected]>
@cdrage cdrage closed this Aug 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants