Update Dockerfile and README#164
Merged
guyfedwards merged 2 commits intoguyfedwards:masterfrom Oct 8, 2025
larsks:feature/container-image
Merged
Update Dockerfile and README#164guyfedwards merged 2 commits intoguyfedwards:masterfrom larsks:feature/container-image
guyfedwards merged 2 commits intoguyfedwards:masterfrom
larsks:feature/container-image
Conversation
Update the Dockerfile with some best practices: - Install go dependencies separately from building nom. This allows the container engine to cache the dependencies, saving time on future builds. - Use a multi-stage build so that the final image does not contain our build dependencies, source code, compiled code, etc. - Install `docker-config.yml` as described in the README. Previously, this file was not installed in the image. - Install the `nano` editor so that using `E` in the item list will allow someone to customize the configuration. - Configure `nom` as the `ENTRYPOINT`, so that when passing in custom flags it's not necessary to write `nom` twice. That is, instead of: ``` docker run -it --rm nom nom -c /a/different/path ``` You can write: ``` docker run -it --rm nom -c /a/different/path ```
This commit makes a number of small edits to the README: - Run `README` through `dpring fmt --stdin .md` - Add an additional install example - Mention the `-c` alias for `--config-path` - Minor changes to capitalization and phrasing (e.g., prefer "configuration" to "config", etc) - Show an example of mounting a configuration file into a container
Owner
|
Thanks @larsks |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request contains two commits:
Update the Dockerfile with some best practices and corrections:
Install go dependencies separately from building nom. This allows the
container engine to cache the dependencies, saving time on future
builds.
Use a multi-stage build so that the final image does not contain our
build dependencies, source code, compiled code, etc.
Install
docker-config.ymlas described in the README. Previously, thisfile was not installed in the image.
Install the
nanoeditor so that usingEin theitem list will allow someone to customize the configuration.
Configure
nomas theENTRYPOINT, so that when passing in custom flagsit's not necessary to write
nomtwice. That is, instead of:You can write:
Update the README
This commit makes a number of small edits to the README:
READMEthroughdpring fmt --stdin .md-calias for--config-path"configuration" to "config", etc)