In order to keep them small and lightweight, the alpine
based images do not include build tools like make
, gcc
, g++
and the like, so some packages that require them like node-sass
or node-gyp
won't work out of the box. However, the more robust debian
based images do include those tools and should meet those needs.
-
![Image size](https://img.shields.io/badge/image size-117MB-blue.svg) This image is under development and may not be as stable as versioned images. This image is based on a recent version of alpine and compiles a recent version of
node
from source. Package versions are not pinned, insteadhttps://npmjs.org/install.sh
is executed to install a current version ofnpm
, which is then used to install current versions of the packages. -
![Image size](https://img.shields.io/badge/image size-302MB-blue.svg) This image is under development and may not be as stable as versioned images. This image is based on
node:latest
. Package versions are not pinned, instead the includednpm
executable is used to install current versions of the packages. -
![Image size](https://img.shields.io/badge/image size-117MB-blue.svg) Based on
alpine:3.4
withnode
v7.0 compiled from source. -
![Image size](https://img.shields.io/badge/image size-239MB-blue.svg) Based on
node:7.0-wheezy
. -
![Image size](https://img.shields.io/badge/image size-115MB-blue.svg) Based on
alpine:3.4
withnode
v6.9 compiled from source. -
![Image size](https://img.shields.io/badge/image size-234MB-blue.svg) Based on
node:6.9-wheezy
.
Essentially, this is just a set of shell scripts that manage a Node.js docker image. The docker image includes a script (run-as-user
) that allows commands to run as either the current user or the owner/group of the current directory, which the shell scripts take advantage of to make sure files are written with appropriate permissions rather than root.
The images contain the latest stable node
and npm
binaries for debian:jessie
and alpine:3.4
. npm
has been used to install various build tools globally. When using the shell scripts available in the source repository, the current directory is mounted into /src
in the container and a wrapper script executes npm
as a user who's uid
and gid
matches those properties on that directory. This way any output is written as the directory owner/group instead of root or a random user.
If you need additional modules and/or wrapper scripts let me know.
This assumes that you already have Docker installed. A running docker
daemon is required. You probably want to be able to run docker commands without sudo, but even if you excute the scripts with sudo files will be written with the appropriate uid
and gid
.
Several wrapper scripts are available in the source repository:
Installation is just a matter of putting them somewhere in your path and making them executable. An installation script is available and can be executed with a shell curl
+sh -s
command. Simply pass in your command arguments normally.
Usage
install.sh COMMAND [TAG [PREFIX]]
Synopsys
Install a mkenney/npm container execution script locally
Options
COMMAND - Required, the name of the command to install (bower, gulp, npm, etc.)
TAG - Optional, the image tag to use. Default 'latest'
PREFIX - Optional, the location to install the command script. Default '$HOME/bin'
Examples
$ curl -L https://raw.githubusercontent.com/mkenney/docker-npm/master/bin/install.sh | bash -s gulp 7.0-alpine $HOME/bin
$ bash ./install.sh gulp 7.0-alpine $HOME/bin
-
[command] self-update
Each of the scripts have a
self-update
command which pulls down the latest docker image (which all the scripts share) and then updates the shell script itself. If you don't have write permissions on the shell script you'll get a permissions error, you can run the self-update command withsudo
if necessary.
- Created "stable" branches for node v6.9 images
- More performance updates to the CI integration
Please let me know if you have any problems.
-
Modified the
alpine
-based dockerfiles to retain the build toolsThis change increases the image size by ~45MB but its still around 1/2 the size of the
debian
-based images.
Please let me know if you have any problems.
- Added an install script to easily install the command wrapper scripts locally
- Added
travis-ci
tests to test and validate both the installation script and the individual wrapper scripts-
The install script is using
bash
instead ofsh
because the version ofsh
installed ontravis-ci
would constantly have a syntax error on theusage
function definition, regardless of how it was defined. Both of these failed:
-
function usage { ... }
```sh
usage() {
...
}
At some point I'll get that figured out and switch it back to `sh`.
Please let me know if you have any problems.
- Added tty detection to the shell scripts to alter the way the container is executed with piped input.
Please let me know if you have any problems.
- Upgraded
node
to 7.0.0 in thealpine
image. - Created "stable" branches for the 7.0 images
- Merged a change to the wrapper scripts to resolve a reported issue. This change reverts the 2016-07-05 changes.
Please let me know if you have any problems.
Please let me know if you have any problems.
- Because it produces a much smaller image, I have moved the Alpine build into the
master
branch and the Debian build into it's owndebian
branch and made corresponding changes on hub.docker.com. - Added the
--allow-root
option to thebower
script to resolve issue #4. - Merged a PR to prevent ssl certificate issues in
self-update
commands. - Updated the
self-update
command in the scripts to resolve issue #8.
Please let me know if you have any problems.
- Added a markdown-to-html generator for static documentation (
markdown-styles
) and a script to run it (generate-md
). - Removed the dev user from the root group, the way it was setup new files were owned by root because it was the default group.
Please let me know if that change causes any issues.
- Re-structured automated the Docker Hub builds, they are no longer triggered by GitHub pushes. Instead they are triggered by a deployment script that is executed on successful
travis-ci
builds. This way, even if builds are failing the image on DockerHub should remain the last stable image at all times.- There may be an issue with API call throttling on the Docker Hub side, if that seems to be happening I'll dig in further.
- Fixed an issue with the path in the source URL that had been preventing successuful alpine builds for a few days.
Please let me know if you have any problems.
- Fixed a string-comparison issue on logins where the default shell is Bourne shell rather than Bourne again shell.
Please let me know if you have any problems.
- Added updating
npm
to the latest stable version in thedebian
image. - Changed to compiling
node
from source in thealpine
image because the version installed byn
was compiled with a different prefix than theapk
packages which made a mess. I set the build to use the same install prefix as thenode:latest
image (/usr/local
). - Added some simple checks to the travis-ci configuration to catch the 2016-06-28 issue with the missing
shadow
package.
Please let me know if you run into any problems.
alpine:latest
doesn't have theshadow
available (at the moment) so the/run-as-user
script wasn't functioning correctly. Added theedge/testing
repo, installedshadow
and also went ahead and updatednpm
to the latest available version (3.10.2
).
Please let me know if you run into any problems.
- Added
bower
to the image and a wrapper script to the repository. - Added a
node
wrapper script to the repository. - Added mounting your
~/.ssh/
directory into the container to support access to private repositories. If that directory is mounted, thennpm
andbower
will run as theuid
/gid
that owns that~/.ssh/
directory (hopefully you), otherwise it will run as the project directoriesuid
andgid
as usual. - Updated all the wrapper scripts to use variables for the image tag and github branch to make merges simpler
- Created a tagged version of the image based on
alpine:latest
Please let me know if you run into any problems.
- Modified the
run-as-user
script so that it doesn't require specifying which user account in the container should be modified- Instead, always modify the
dev
user. This required updating both the image and the wrapper scripts, if you use the wrapper scripts you should run:sudo npm self-update
sudo gulp self-update
sudo grunt self-update
- Instead, always modify the
Removed the as-user
script (and renamed it run-as-user
) and put it in a separate repo as it's used in several images. Let me know if you have any trouble, this is the first image I've switched over.
Added a wrapper script to the container that executes npm
, gulp
and grunt
commands as a user who's uid
and gid
matches those properties on the current directory. This way any files are installed as the directory owner/group instead of root or a random user.
If you've been using the previous version of the included shell scripts from the project's /bin
directory you will probably need to update the permissions of files created using them or the new scripts are likely to have permissions errors because previously the files would have been created by the root
user. This command should take care of it for you but make sure you understand what it will do before you run it. I can't help you if you hose your system.
- From your project directory:
sudo chown -R $(stat -c '%u' .):$(stat -c '%g' .) ./
If you haven't been using the included scripts, then you don't need to do anything.