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

Fix docker compose file example in README.md #475

Merged
merged 1 commit into from
Oct 21, 2024

Conversation

FalkoFlessner
Copy link
Contributor

@FalkoFlessner FalkoFlessner commented Oct 16, 2024

In README.md is an example docker-compose.yaml file that can be improved in two points

In README.md is an example docker-compose.yaml file that can be improved
in two points

- The "version" top level element is obsolete, see
  https://docs.docker.com/reference/compose-file/version-and-name/
- The "command" element contains a superflous "pebble" that prevents the
  following parameters from being parsed. (In the included
  docker-compose.yaml, the "command" element is already correct, see
  https://github.com/letsencrypt/pebble/blob/e08dd94e723a0e8d005d7c6149a8666e4bf5d877/docker-compose.yml#L5
  for comparison.)
@mcpherrinm
Copy link
Contributor

Perhaps we should just remove the example from the README and reference the docker-compose.yml, as it's more likely to be tested and correct.

@FalkoFlessner
Copy link
Contributor Author

Sounds reasonable. Do you want this to be part of this PR?

@mcpherrinm
Copy link
Contributor

Let's merge this as-is, and we can always do that as another change if we want.

@mcpherrinm mcpherrinm merged commit ddbc6be into letsencrypt:main Oct 21, 2024
14 checks passed
@mcpherrinm mcpherrinm changed the title Fix(NOISSUE): Fix docker compose file example in README.md Fix docker compose file example in README.md Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants