add expose statement to document exposed port #39
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
I was kind of surprised we didn't have this in here already. the [docker reference](https://docs.docker.com/engine/reference/builder/#expose) specifies this is mostly for documentation towards users of a microservice. I think it's valuable to make it clear that microservices based on the template listen on port 80. Exposed ports are also used by other "proxy type" microservices such as the letsencrypt companion to figure out how to forward calls to the container in question. From the reference: > The EXPOSE instruction informs Docker that the container listens on the specified network ports at runtime. You can specify whether the port listens on TCP or UDP, and the default is TCP if the protocol is not specified. > The EXPOSE instruction does not actually publish the port. It functions as a type of documentation between the person who builds the image and the person who runs the container, about which ports are intended to be published. To actually publish the port when running the container, use the -p flag on docker run to publish and map one or more ports, or the -P flag to publish all exposed ports and map them to high-order ports.
elpoelma
pushed a commit
that referenced
this pull request
Feb 28, 2023
* add expose statement (#39) I was kind of surprised we didn't have this in here already. the [docker reference](https://docs.docker.com/engine/reference/builder/#expose) specifies this is mostly for documentation towards users of a microservice. I think it's valuable to make it clear that microservices based on the template listen on port 80. Exposed ports are also used by other "proxy type" microservices such as the letsencrypt companion to figure out how to forward calls to the container in question. From the reference: > The EXPOSE instruction informs Docker that the container listens on the specified network ports at runtime. You can specify whether the port listens on TCP or UDP, and the default is TCP if the protocol is not specified. > The EXPOSE instruction does not actually publish the port. It functions as a type of documentation between the person who builds the image and the person who runs the container, about which ports are intended to be published. To actually publish the port when running the container, use the -p flag on docker run to publish and map one or more ports, or the -P flag to publish all exposed ports and map them to high-order ports. * Allow overriding port and hostname (#47) * Allow overriding port and hostname * Update server.js * Update Dockerfile * instructions on handling delta's in a JS service (#48) * Add documentation to allow overriding port and hostname (#49) * Allow overriding port and hostname * Update server.js * Update Dockerfile * Update Dockerfile * Update README.md --------- Co-authored-by: Niels V <[email protected]>
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 was kind of surprised we didn't have this in here already.
the docker reference specifies this is mostly for documentation towards users of a microservice. I think it's valuable to make it clear that microservices based on the template listen on port 80. Exposed ports are also used by other "proxy type" microservices such as the letsencrypt companion to figure out how to forward calls to the container in question.
From the reference: