From f6e169b130f82a8830316a020a5cbb307c5019f1 Mon Sep 17 00:00:00 2001 From: Jordan Harband Date: Fri, 20 Nov 2026 14:31:22 -0800 Subject: [PATCH] [readme] Docker: improve the "Docker For Development Environment" section - Add `--name` to `docker run` command to make the container easier to manipulate. (This will produce collisions if two developers both try this on the same system, but it's not worth a lot of extra documentation to try to sort out the few developers who can't figure out what's going on from the error messages) - Explain better that the current repo and working copy are copied to ~/.nvm/ inside the container - Explain that the container is not deleted when you exit, and how to re-enter and delete it - General improvements to the language. Co-authored-by: Curt J. Sampson Co-authored-by: Jordan Harband --- README.md | 28 ++++++++-------------------- 1 file changed, 8 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 4084e76e..f63b93cf 100644 --- a/README.md +++ b/README.md @@ -1116,29 +1116,17 @@ export NVM_DIR="$HOME/.nvm" To make development and testing work easier we supply a Dockerfile for development usage. It's based on an Ubuntu base image prepared with essential and useful tools for `nvm` development. To build the docker image of the environment, do a Docker build at the root of `nvm` repository: ```sh -$ docker build -t nvm-dev . +docker build -t nvm-dev . # Create the nvm-dev image +docker images # Confirm nvm-dev appears in the list. + +# Create a container named `nvm-dev` (with the same hostname) +# and enter an interactive session in it. +docker run --name nvm-dev -h nvm-dev -it nvm-dev ``` -This will package your current nvm working copy with our pre-defined development environment into a Docker image named `nvm-dev`. After the build you should see it appear in the list of images: +This will place you in the container in the `~/.nvm/` directory as the `nvm` user. When you exit the container will not be deleted (so as to avoid losing any work in it); you can re-enter the container with `docker start -i nvm-dev` or delete it permanently with `docker container rm -f nvm-dev`. (For more information on using Docker, see the [website][docker-www] and [documentation][docker-docs].) -```sh -$ docker images - -REPOSITORY TAG IMAGE ID CREATED SIZE -nvm-dev latest 9ca4c57a97d8 7 days ago 650 MB -``` - -To start and enter a container based on this image: - -```sh -$ docker run -h nvm-dev -it nvm-dev - -nvm@nvm-dev:~/.nvm$ -``` - -It takes several minutes to build the image and the image size is about 650MB, so it's not suitable for production usage. - -For more information and documentation about Docker, please refer to its [official website][docker-www] and [documentation][docker-docs]: +Note that the build takes several minutes and well over half a gigabyte of disk space, so it's not suitable for production usage. ## Problems