Skip to content

Commit

Permalink
Document the availability and use of the Docker image
Browse files Browse the repository at this point in the history
  • Loading branch information
Homme Zwaagstra committed Dec 16, 2013
1 parent f871641 commit d7bac22
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,11 @@ a cache request to the ImageMagick `display` program.

## Installation

### Using NPM

The latest stable release of Node Mapcache is available via the Node
Package Manager:

* Ensure [Mapserver Mapcache](http://www.mapserver.org/trunk/mapcache) is
installed. It should be built from source as we need the build directory in
the next step:
Expand All @@ -210,6 +215,40 @@ a cache request to the ImageMagick `display` program.

`npm test mapcache`

### Using Docker

Assuming you have [Docker](http://www.docker.io/) available on your
system, the following command will obtain a docker image with the
latest Node Mapcache code from git built against the latest Mapserver
Mapcache git checkout:

docker pull homme/node-mapcache:latest

Note that the latest Mapcache git checkout is the latest **at the time
the image was built**. If you want the absolute latest code of both
Node Mapcache *and* Mapcache, build the docker image yourself locally
along these lines:

docker build -t homme/node-mapcache:latest https://raw.github.com/geo-data/node-mapcache/master/docker/latest/Dockerfile

By default the image runs the Node Mapcache tests:

docker run homme/node-mapcache:latest

Running Node directly from the image allows you to `require()` and
play around with Node Mapcache interactively:

docker run -t -i homme/node-mapcache:latest /usr/bin/node
> var mapcache = require('mapcache');
undefined
> mapcache.versions
{ node_mapcache: '0.1.12',
mapcache: '1.3dev',
apr: '1.4.6' }

See the [Docker Index](https://index.docker.io/u/homme/node-mapcache/)
for further information.

## Recommendations

* If you want raw speed use the Apache Mapcache module or reverse proxy your
Expand Down

0 comments on commit d7bac22

Please sign in to comment.