# reginabox

**Repository Path**: mirrors_yahoo/reginabox

## Basic Information

- **Project Name**: reginabox
- **Description**: Registry In A Box
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2026-10-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# reginabox

[![Build Status](https://travis-ci.org/yahoo/reginabox.svg)](https://travis-ci.org/yahoo/reginabox)

**`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`](https://github.com/agnat/node_mdns) which in turn depends on Apple's "[Bonjour SDK for Windows](https://developer.apple.com/downloads/index.action?q=Bonjour%20SDK%20for%20Windows)." 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](https://github.com/agnat/node_mdns#installation) for more details on installing `node_mdns`.

### Usage

`$ reginabox mirror [outputdir]` will run [registry-static](https://www.npmjs.com/package/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](http://en.wikipedia.org/wiki/Zero-configuration_networking).

`$ 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