From 13007c7aad6145ed91fb8f776b9015c615023398 Mon Sep 17 00:00:00 2001 From: Steven Date: Fri, 21 Jul 2017 09:46:42 -0400 Subject: [PATCH 1/3] Update content and license for node --- node/content.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++-- node/license.md | 5 +++- 2 files changed, 65 insertions(+), 3 deletions(-) diff --git a/node/content.md b/node/content.md index 33af0d8bc..1e79530e6 100644 --- a/node/content.md +++ b/node/content.md @@ -29,12 +29,71 @@ $ docker run -it --rm --name my-running-app my-nodejs-app ### Notes -The image assumes that your application has a file named [`package.json`](https://docs.npmjs.com/files/package.json) listing its dependencies and defining its [start script](https://docs.npmjs.com/misc/scripts#default-values). +The image assumes that your application has a file named +[`package.json`](https://docs.npmjs.com/files/package.json) listing its +dependencies and defining its [start +script](https://docs.npmjs.com/misc/scripts#default-values). + +It also assumes that you have a file named [`.dockerignore`](https://docs.docker.com/engine/reference/builder/#/dockerignore-file) otherwise it will copy your local npm modules: + +``` +node_modules +``` + +We have assembled a [Best Practices Guide](https://github.com/nodejs/docker-node/blob/master/docs/BestPractices.md) for those using these images on a daily basis. ## Run a single Node.js script -For many simple, single file projects, you may find it inconvenient to write a complete `Dockerfile`. In such cases, you can run a Node.js script by using the Node.js Docker image directly: +For many simple, single file projects, you may find it inconvenient to write a +complete `Dockerfile`. In such cases, you can run a Node.js script by using the +Node.js Docker image directly: ```console $ docker run -it --rm --name my-running-script -v "$PWD":/usr/src/app -w /usr/src/app node:4 node your-daemon-or-script.js ``` + +## Verbosity + +By default the Node.js Docker Image has npm log verbosity set to `info` instead +of the default `warn`. This is because of the way Docker is isolated from the +host operating system and you are not guaranteed to be able to retrieve the +`npm-debug.log` file when npm fails. + +When npm fails, it writes it's verbose log to a log file inside the container. +If npm fails during an install when building a Docker Image with the `docker +build` command, this log file will become inaccessible when Docker exits. + +The Docker Working Group have chosen to be overly verbose during a build to +provide an easy audit trail when install fails. If you prefer npm to be less +verbose you can easily reset the verbosity of npm using the following +techniques: + +### Dockerfile + +If you create your own `Dockerfile` which inherits from the `node` image you can +simply use `ENV` to override `NPM_CONFIG_LOGLEVEL`. + +``` +FROM node +ENV NPM_CONFIG_LOGLEVEL warn +... +``` + +### Docker Run + +If you run the node image using `docker run` you can use the `-e` flag to +override `NPM_CONFIG_LOGLEVEL`. + +``` +$ docker run -e NPM_CONFIG_LOGLEVEL=warn node ... +``` + +### NPM run + +If you are running npm commands you can use `--loglevel` to control the +verbosity of the output. + +``` +$ docker run node npm --loglevel=warn ... +``` + diff --git a/node/license.md b/node/license.md index 21197f781..7f3da68b7 100644 --- a/node/license.md +++ b/node/license.md @@ -1 +1,4 @@ -View [license information](https://github.com/joyent/node/blob/master/LICENSE) for the software contained in this image. +[License information](https://github.com/nodejs/node/blob/master/LICENSE) for +the software contained in this image. [License +information](https://github.com/nodejs/docker-node/blob/master/LICENSE) for the +Node.js Docker project. \ No newline at end of file From af8eb27def983994a2af4d27806d0c0c726e5ab4 Mon Sep 17 00:00:00 2001 From: Steven Date: Fri, 21 Jul 2017 09:56:21 -0400 Subject: [PATCH 2/3] Add missing notes in content --- node/content.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/node/content.md b/node/content.md index 1e79530e6..52ea0121a 100644 --- a/node/content.md +++ b/node/content.md @@ -42,6 +42,12 @@ node_modules We have assembled a [Best Practices Guide](https://github.com/nodejs/docker-node/blob/master/docs/BestPractices.md) for those using these images on a daily basis. +All of the images contain pre-installed versions of `node`, +[`npm`](https://www.npmjs.com/), and [`yarn`](https://yarnpkg.com). For each +supported architecture, the supported variants are different. In the file +[architectures](https://github.com/nodejs/docker-node/blob/master/architectures), +it lists all supported variants for all of the architectures that we support now. + ## Run a single Node.js script For many simple, single file projects, you may find it inconvenient to write a @@ -96,4 +102,3 @@ verbosity of the output. ``` $ docker run node npm --loglevel=warn ... ``` - From 7b06f3458eac263e2b6b7b0b52d694b3ace5b546 Mon Sep 17 00:00:00 2001 From: Tianon Gravi Date: Mon, 31 Jul 2017 15:54:25 -0700 Subject: [PATCH 3/3] Apply markdownfmt --- node/content.md | 58 +++++++++++++------------------------------------ node/license.md | 5 +---- 2 files changed, 16 insertions(+), 47 deletions(-) diff --git a/node/content.md b/node/content.md index 52ea0121a..416f8e1f3 100644 --- a/node/content.md +++ b/node/content.md @@ -29,30 +29,19 @@ $ docker run -it --rm --name my-running-app my-nodejs-app ### Notes -The image assumes that your application has a file named -[`package.json`](https://docs.npmjs.com/files/package.json) listing its -dependencies and defining its [start -script](https://docs.npmjs.com/misc/scripts#default-values). +The image assumes that your application has a file named [`package.json`](https://docs.npmjs.com/files/package.json) listing its dependencies and defining its [start script](https://docs.npmjs.com/misc/scripts#default-values). It also assumes that you have a file named [`.dockerignore`](https://docs.docker.com/engine/reference/builder/#/dockerignore-file) otherwise it will copy your local npm modules: -``` -node_modules -``` + node_modules We have assembled a [Best Practices Guide](https://github.com/nodejs/docker-node/blob/master/docs/BestPractices.md) for those using these images on a daily basis. -All of the images contain pre-installed versions of `node`, -[`npm`](https://www.npmjs.com/), and [`yarn`](https://yarnpkg.com). For each -supported architecture, the supported variants are different. In the file -[architectures](https://github.com/nodejs/docker-node/blob/master/architectures), -it lists all supported variants for all of the architectures that we support now. +All of the images contain pre-installed versions of `node`, [`npm`](https://www.npmjs.com/), and [`yarn`](https://yarnpkg.com). For each supported architecture, the supported variants are different. In the file [architectures](https://github.com/nodejs/docker-node/blob/master/architectures), it lists all supported variants for all of the architectures that we support now. ## Run a single Node.js script -For many simple, single file projects, you may find it inconvenient to write a -complete `Dockerfile`. In such cases, you can run a Node.js script by using the -Node.js Docker image directly: +For many simple, single file projects, you may find it inconvenient to write a complete `Dockerfile`. In such cases, you can run a Node.js script by using the Node.js Docker image directly: ```console $ docker run -it --rm --name my-running-script -v "$PWD":/usr/src/app -w /usr/src/app node:4 node your-daemon-or-script.js @@ -60,45 +49,28 @@ $ docker run -it --rm --name my-running-script -v "$PWD":/usr/src/app -w /usr/sr ## Verbosity -By default the Node.js Docker Image has npm log verbosity set to `info` instead -of the default `warn`. This is because of the way Docker is isolated from the -host operating system and you are not guaranteed to be able to retrieve the -`npm-debug.log` file when npm fails. +By default the Node.js Docker Image has npm log verbosity set to `info` instead of the default `warn`. This is because of the way Docker is isolated from the host operating system and you are not guaranteed to be able to retrieve the `npm-debug.log` file when npm fails. -When npm fails, it writes it's verbose log to a log file inside the container. -If npm fails during an install when building a Docker Image with the `docker -build` command, this log file will become inaccessible when Docker exits. +When npm fails, it writes it's verbose log to a log file inside the container. If npm fails during an install when building a Docker Image with the `docker build` command, this log file will become inaccessible when Docker exits. -The Docker Working Group have chosen to be overly verbose during a build to -provide an easy audit trail when install fails. If you prefer npm to be less -verbose you can easily reset the verbosity of npm using the following -techniques: +The Docker Working Group have chosen to be overly verbose during a build to provide an easy audit trail when install fails. If you prefer npm to be less verbose you can easily reset the verbosity of npm using the following techniques: ### Dockerfile -If you create your own `Dockerfile` which inherits from the `node` image you can -simply use `ENV` to override `NPM_CONFIG_LOGLEVEL`. +If you create your own `Dockerfile` which inherits from the `node` image you can simply use `ENV` to override `NPM_CONFIG_LOGLEVEL`. -``` -FROM node -ENV NPM_CONFIG_LOGLEVEL warn -... -``` + FROM node + ENV NPM_CONFIG_LOGLEVEL warn + ... ### Docker Run -If you run the node image using `docker run` you can use the `-e` flag to -override `NPM_CONFIG_LOGLEVEL`. +If you run the node image using `docker run` you can use the `-e` flag to override `NPM_CONFIG_LOGLEVEL`. -``` -$ docker run -e NPM_CONFIG_LOGLEVEL=warn node ... -``` + $ docker run -e NPM_CONFIG_LOGLEVEL=warn node ... ### NPM run -If you are running npm commands you can use `--loglevel` to control the -verbosity of the output. +If you are running npm commands you can use `--loglevel` to control the verbosity of the output. -``` -$ docker run node npm --loglevel=warn ... -``` + $ docker run node npm --loglevel=warn ... diff --git a/node/license.md b/node/license.md index 7f3da68b7..68b09dd6d 100644 --- a/node/license.md +++ b/node/license.md @@ -1,4 +1 @@ -[License information](https://github.com/nodejs/node/blob/master/LICENSE) for -the software contained in this image. [License -information](https://github.com/nodejs/docker-node/blob/master/LICENSE) for the -Node.js Docker project. \ No newline at end of file +View [license information](https://github.com/nodejs/node/blob/master/LICENSE) for Node.js or [license information](https://github.com/nodejs/docker-node/blob/master/LICENSE) for the Node.js Docker project.