Thanks to visit codestin.com
Credit goes to github.com

Skip to content

sstedman/kappa

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

109 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kappa

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

Quickstart

Deploying a kappa server only requires 2 artifacts. These files can be put under source control and deployed via any mechansim.

  • package.json file
  • a Hapi Composer manifest (config.json)

First, create a package.json file for your server, adding kappa as a dependency and a startup script to kick off the server.

$ npm init
# ...
$ npm install --save kappa # or manually add kappa to your dependencies
// package.json
{
    "scripts": {
        "start": "./node_modules/.bin/hapi -c config.json"
    }
}

Then, create a config.json file which is a Hapi Composer manifest file. This will have any custom settings for your particular installation. (See the example config example/config.json for layout and the config section below for kappa-specific configuration options.)

Once the two artifacts have been deployed to your server, simply run it.

$ npm install
$ npm start

Configuration

kappa configuration 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/ghost/_rewrite/', 'https://registry.npmjs.org/']

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.

About

A hierarchical npm-registry proxy

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%