Skip to content

Update Dockerfile and README#164

Merged
guyfedwards merged 2 commits intoguyfedwards:masterfrom
larsks:feature/container-image
Oct 8, 2025
Merged

Update Dockerfile and README#164
guyfedwards merged 2 commits intoguyfedwards:masterfrom
larsks:feature/container-image

Conversation

@larsks
Copy link
Copy Markdown
Contributor

@larsks larsks commented Oct 4, 2025

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.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
    

Update the README

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

larsks added 2 commits October 4, 2025 08:54
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
@guyfedwards guyfedwards merged commit 78068cf into guyfedwards:master Oct 8, 2025
2 checks passed
@guyfedwards
Copy link
Copy Markdown
Owner

Thanks @larsks

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