refactor dockerfiles

[josefschabasser]

Pull request checklist

• All tests pass. Demo project builds and runs.
• I have resolved any merge conflicts.

This fixes issue #601.

What's in this pull request?

refactored dockerfiles using newer images, multistage builds, only required packages and other tweaks.
reduces image size by 840MB (deb), 1213MB (git), 1283MB (repo)
new image sizes: 450MB (deb), 207MB (git), 207MB (repo)

• introduce multistage builds
• build using standard image, run using slim image
• upgrade base images
• install only required packages
• move ARGS down to maximize caching
• add dockerignore file and ignore dist/peer-key/
• do not modify lockfile during package installation
• run tests after install/build
• add compatible Node.js versions to readme
• make repo URL configurable
• introduce variable INSTALL_PATH
• add another stage to install production dependencies and further trim image size
• rename and move dockerfiles to better group them and get syntax highlighting
• add ability to mount volumes to /nimiq in git/repo image (feature parity with deb image)
• add syntax highlighting to docs/docker.md
• fixed containers not shutting down on CTRL-C or kill 1
• fixed permission mismatch when mounting volumes to /nimiq and sharing between different images (deb used different UID/GID)

[philippfo9]

would welcome this change!

[josefschabasser]

I think now I'm done. I don't like the second build stage in the git/repo dockerfiles, but I didn't want to change yarn/gulp/gyp behaviour. The second build stage works around build issues (yarn install --production still needs build-essential packages). Besides that, one can now mount images/directories to /nimiq in all images, size went down by a HUGE amount, branch, repo URL, data and install directories are configurable and docker layer caching is used to the max without enabling BuildKit (which should really be considered to share yarn cache between stages).

[josefschabasser]

Okay, now I'm done. Fixed 2 more issues (container not shutting down at all and permission mismatch when sharing /nimiq between different images).

[jeffesquivels]

LGTM in general, just have one question:

[...] docker layer caching is used to the max without enabling BuildKit (which should really be considered to share yarn cache between stages).

Is there any downside to enabling BuildKit?

It seems to me another advantage is that we could use a custom .dockerignore file per each Dockerfile, and thus make the process a bit more efficient by not sending any build context where none is needed (such as the deb or the git cases).

[josefschabasser]

There is no issue at all, I just didn't want to break it for everyone out there. If you want me to, I can enable it, optimize cache sharing between stages and add a note to the readme.