Kappa
======


Based on [npm-delegate] (https://npmjs.org/package/npm-delegate) by Jason Denizac , this module
is a hapi plugin used to proxy npm to support private npm repos without replicating the entire public registry.

> NOTE: The config.json described below is a Hapi Composer manifest
that describes kappa as a plugin. See ./example/global/config.json or
./example/local/config.json for more information.

#### Quickstart

##### Global Installation
``bash
$ npm install -g kappa
$ kappa -c config.json
`

##### Local Installation
If you choose to install locally, running kappa is as easy as
`bash
$ npm init
$ npm install --save kappa

add start script to package.json:

$ npm start
`

You can then put those artifacts (config.json and package.json) under source control for simple deployments later:
`bash
$ git clone git@github.com:me/myregistry.git
$ cd myregistry
$ npm install
$ npm start
`

#### Options
kappa plugin currently supports the following parameters

- vhost - the virtual host associated with the kappa server, e.g. 'npm.mydomain.com'
- paths (optional) - any ordered array of npm repositories to use, e.g. Defaults to ['http://localhost:5984/registry/_design/app/_rewrite/', 'https://registry.npmjs.org/']
- rewriteTarballs (optional) - When true rewrites the tarball URL in packages to download each resource via kappa. When false, tarball URLs
are left untouched, allowing the client to download package tarballs directly from the registry that fulfilled the package request. Defaults to true`.

For read operations (GET, HEAD, etc) the proxy will first attempt to fetch the module from the first registry.
If the requested module is not found it continues to the next registry, and so on.

For write operations the proxy will only attempt to write to the FIRST registry. All auth occurs with the first registry as well.