Skip to content

Latest commit

 

History

History
138 lines (102 loc) · 4.23 KB

README.md

File metadata and controls

138 lines (102 loc) · 4.23 KB
Raw

Docker npm_lazy

Add this Docker container to your orchestration and enjoy near-instantaneous package dependency resolutions, courtesy of mixu's lazy npm cache (repository mixu/npm_lazy).

Usage

In order to utilize the container's service, you'll have to configure the server's settings and also direct your local npm clients to use it as it's source for registry data.

There are two ways you can use the containerized npm_lazy server:

  • by mapping the server's port locally, exposing it within your host environment
  • by linking it to other containers

Using the server from your local host

The server defaults are configured to play nicely with local setups, i.e. when you want the npm client from your host to retrieve the packages through the cache from the running container.

The only important thing you need to do is to map the default exposed port from the container to the same port on your host:

# Start a detached container, mapping the exposed port locally
sudo docker run -d -p 8080:8080 apicht/npm_lazy

You can verify that the service is then accessible from your host via:

$ curl http://localhost:8080
{"db_name":"registry"}

Linking with other containers

If you would like containers residing on your host to use the npm_lazy server, give your container a hostname and add your configuration module to the container.

Then, configure the npm clients on all the linked containers and configure their registries to point to the npm_lazy host.

Here's a high-level overview using fig.sh:

web:
  image: google/nodejs
  environment:
    - npm_config_registry=http://npmlazy
  links:
    - npmlazy
npmlazy:
  image: apicht/npm_lazy
  command: --show-config --port=80 --external-url=http://npmlazy

Configuring the npm_lazy server

The npm_lazy/server is wrapped with a thin client that allows you to dynamically configure the server from the command-line options on startup.

You can configure the server by passing arguments when starting the container.

$ node index.js --help

  Usage: index [options]

  Starts a dynamically configured npm_lazy server instance

  Options:

    -h, --help                             output usage information
    -V, --version                          output the version number
    --show-config                          display the effective server configuration on startup
    --logging-opts_log-to-console [value]  
    --logging-opts_log-to-file [value]
    --logging-opts_filename [value]
    --cache-directory [value]
    --cache-age [value]
    --http-timeout [value]
    --max-retries [value]
    --reject-unauthorized [value]
    --external-url [value]
    --remote-url [value]
    --port [value]
    --host [value]
    --proxy_https [value]
    --proxy_http [value]

Configuring the npm client

There are several ways you can configure the npm client, outlined from official sources.

A few great examples involve configuring the environment:

docker run -e npm_config_registry=http://localhost:8080 nodejsapp

or providing a project-specific npmrc file:

# myproj/.npmrc
registry = http://localhost:8080/

Default container behavior

You'll have to pay attention to the configured server's port and external URL. The server's provided defaults configure the server to listen on 0.0.0.0:8080 and to be accessible from the URL http://localhost:8080.

Make sure the networking requirements for the server are satisfied correctly and that the server running within your container matches the details of how it is accessed externally.

You can pass the --show-config container command to display the server's runtime configuration.

See also