Registry In A Box
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
test
.gitignore
.travis.yml
LICENSE.txt
README.md
index.js
package.json

README.md

reginabox

Build Status

reginabox (Registry In A Box) is an easy way to set up an npm registry mirror on your local network, and let local network users know about it.

Installation

$ npm i -g reginabox

Installation on Windows

Things are a little trickier on Windows. This project depends on node_mdns which in turn depends on Apple's "Bonjour SDK for Windows." You'll need an Apple Developer account to download the SDK, and the SDK should be installed before you attempt to install reginabox or node_mdns. See the node-mdns installation instructions for more details on installing node_mdns.

Usage

$ reginabox mirror [outputdir] will run registry-static and a corresponding web server to go along with it. If outputdir is provided, it will be used as the output directory, where it stores all the tarballs and metadata. Otherwise, $PWD/registry will be used. It will also make the server discoverable via zeroconf.

$ reginabox discover queries the local network for servers that are run using the command above. Once it finds a usable server, it outputs the command to set the registry, and then exits.

License

See LICENSE.txt