Streamlined compose install instructions #7
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR streamlines the Docker Compose installation instructions by removing the local build process and using the official published Docker image instead. The changes simplify deployment by eliminating the need for users to build the image locally and standardize the port configuration across all Docker examples.
- Removed the local build process from Docker Compose examples and switched to using the official published image
- Standardized port mapping to 5000:5000 across all Docker examples for consistency
- Removed deprecated
versionfield from compose files and updated documentation
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Updated Docker Compose instructions to use official image instead of local build, standardized port mapping to 5000:5000, and removed deprecated Dockerfile example |
| compose.yml | Added development usage disclaimer comment |
PianoNic
reviewed
Aug 1, 2025
Owner
|
Nice Job 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I removed the build part in the example compose file which is located in the README.
Since an official docker image is published on GHCR and Docker Hub, this is unnecessary and hinders the user to update easily.
I also removed the
versionfrom the compose example, since this was deprecated.Furthermore, I changed the published ports of all docker example to port 5000 which is the internal port, to eliminate the difference between docker and manual installations.