This is a Dockerfile to build a container image for nodeJS, with the ability to push and pull source code to and from git.
The source files for this project can be found here: https://github.com/TheBoroer/docker-nodejs
If you have any improvements please submit a pull request.
The Docker hub build can be found here: https://hub.docker.com/u/boro/nodejs/
| Tag | nodeJS | Alpine | Freebind (repo) |
|---|---|---|---|
| latest | 12.16.3 | 3.11 | yes |
| 12.16.3 | 12.16.3 | 3.11 | yes |
| 10.17.0 | 10.17.0 | 3.9 | yes |
| 10.16.0 | 10.16.0 | 3.9 | yes |
| 8.11.2 | 8.11.2 | 3.6 | yes |
| 8.6.0 | 8.6.0 | 3.6 | yes |
| 6.11.4 | 6.11.4 | 3.4 | yes |
| 4.6.0 | 4.6.0 | 3.4 | no |
To build from source you need to clone the git repo and run docker build:
git clone https://github.com/TheBoroer/docker-nodejs
.git
docker build -t nodejs:latest .
docker pull boro/nodejs
To simply run the container:
sudo docker run -d boro/nodejs
To install component for you node application to run simply include a packages.json file in the root of your application. The container will then install the components on start.
At the moment the container looks for server.js in your web root and executes that.
The following flags are a list of all the currently supported options that can be changed by passing in the variables to docker with the -e flag.
- NODE_START : Set to a custom node start command (e.g.
npm startornode dist/server.js). Defaults tonode server.jsin the/appdirectory. - USE_YARN : Set to 1 to install packages via Yarn instead of NPM.
- GIT_REPO : URL to the repository containing your source code. If you are using a personal token, this is the https URL without https://, e.g github.com/project/ for ssh prepend with git@ e.g git@github.com:project.git
- GIT_BRANCH : Select a specific branch (optional)
- GIT_EMAIL : Set your email for code pushing (required for git to work)
- GIT_NAME : Set your name for code pushing (required for git to work)
- GIT_PERSONAL_TOKEN : Personal access token for your git account (required for HTTPS git access)
- GIT_USERNAME : Git username for use with personal tokens. (required for HTTPS git access)
- RUN_SCRIPTS : Set to 1 to execute scripts
One of the nice features of this container is its ability to pull code from a git repository with a couple of environmental variables passed at run time.
REQUIRED: To create a personal access token on Github follow this guide.
You can pass the container your personal access token from your git account using the GIT_PERSONAL_TOKEN flag. This token must be setup with the correct permissions in git in order to push and pull code.
Since the access token acts as a password with limited access, the git push/pull uses HTTPS to authenticate. You will need to specify your GIT_USERNAME and GIT_PERSONAL_TOKEN variables to push and pull. You'll need to also have the GIT_EMAIL, GIT_NAME and GIT_REPO common variables defined.
docker run -d -e 'GIT_EMAIL=email_address' -e 'GIT_NAME=full_name' -e 'GIT_USERNAME=git_username' -e 'GIT_REPO=github.com/project' -e 'GIT_PERSONAL_TOKEN=<long_token_string_here>' richarvey/nginx-nodejs:latest
To pull a repository and specify a branch add the GIT_BRANCH environment variable:
docker run -d -e 'GIT_EMAIL=email_address' -e 'GIT_NAME=full_name' -e 'GIT_USERNAME=git_username' -e 'GIT_REPO=github.com/project' -e 'GIT_PERSONAL_TOKEN=<long_token_string_here>' -e 'GIT_BRANCH=stage' richarvey/nginx-nodejs:latest
There is often an occasion where you need to run a script on code to do a transformation once code lands in the container. For this reason we have developed scripting support. By including a scripts folder in your git repository and passing the RUN_SCRIPTS=1 flag to your command line the container will execute your scripts. Please see the repo layout guidelines for more details on how to organise this.
Specify the GIT_EMAIL and GIT_NAME variables for this to work. They are used to set up git correctly and allow the container to push/pull.
To set the variables pass them in as environment variables on the docker command line.
Example:
sudo docker run -d -e 'YOUR_VAR=VALUE' boro/nodejs
All logs should now print out in stdout/stderr and are available via the docker logs command:
docker logs <CONTAINER_NAME>
You can set your webroot in the container to anything you want using the WEBROOT variable e.g -e "WEBROOT=/app/public". By default code is checked out into /app/ so if your git repository does not have code in the root you'll need to use this variable.