deps/npm/html/doc/misc/npm-registry.html

   1 <!doctype html>
   2 <html>
   3   <title>npm-registry</title>
   4   <meta http-equiv="content-type" value="text/html;utf-8">
   5   <link rel="stylesheet" type="text/css" href="../../static/style.css">
   6   <link rel="canonical" href="https://www.npmjs.org/doc/misc/npm-registry.html">
   7   <script async=true src="../../static/toc.js"></script>
   8
   9   <body>
  10     <div id="wrapper">
  11
  12 <h1><a href="../misc/npm-registry.html">npm-registry</a></h1> <p>The JavaScript Package Registry</p>
  13 <h2 id="description">DESCRIPTION</h2>
  14 <p>To resolve packages by name and version, npm talks to a registry website
  15 that implements the CommonJS Package Registry specification for reading
  16 package info.</p>
  17 <p>Additionally, npm&#39;s package registry implementation supports several
  18 write APIs as well, to allow for publishing packages and managing user
  19 account information.</p>
  20 <p>The official public npm registry is at <a href="http://registry.npmjs.org/">http://registry.npmjs.org/</a>.  It
  21 is powered by a CouchDB database, of which there is a public mirror at
  22 <a href="http://skimdb.npmjs.com/registry">http://skimdb.npmjs.com/registry</a>.  The code for the couchapp is
  23 available at <a href="http://github.com/npm/npm-registry-couchapp">http://github.com/npm/npm-registry-couchapp</a>.</p>
  24 <p>The registry URL used is determined by the scope of the package (see
  25 <code><a href="../misc/npm-scope.html">npm-scope(7)</a></code>). If no scope is specified, the default registry is used, which is
  26 supplied by the <code>registry</code> config parameter.  See <code><a href="../cli/npm-config.html">npm-config(1)</a></code>,
  27 <code><a href="../files/npmrc.html">npmrc(5)</a></code>, and <code><a href="../misc/npm-config.html">npm-config(7)</a></code> for more on managing npm&#39;s configuration.</p>
  28 <h2 id="can-i-run-my-own-private-registry-">Can I run my own private registry?</h2>
  29 <p>Yes!</p>
  30 <p>The easiest way is to replicate the couch database, and use the same (or
  31 similar) design doc to implement the APIs.</p>
  32 <p>If you set up continuous replication from the official CouchDB, and then
  33 set your internal CouchDB as the registry config, then you&#39;ll be able
  34 to read any published packages, in addition to your private ones, and by
  35 default will only publish internally. </p>
  36 <p>If you then want to publish a package for the whole world to see, you can
  37 simply override the <code>--registry</code> option for that <code>publish</code> command.</p>
  38 <h2 id="i-don-t-want-my-package-published-in-the-official-registry-it-s-private-">I don&#39;t want my package published in the official registry. It&#39;s private.</h2>
  39 <p>Set <code>&quot;private&quot;: true</code> in your package.json to prevent it from being
  40 published at all, or
  41 <code>&quot;publishConfig&quot;:{&quot;registry&quot;:&quot;http://my-internal-registry.local&quot;}</code>
  42 to force it to be published only to your internal registry.</p>
  43 <p>See <code><a href="../files/package.json.html">package.json(5)</a></code> for more info on what goes in the package.json file.</p>
  44 <h2 id="will-you-replicate-from-my-registry-into-the-public-one-">Will you replicate from my registry into the public one?</h2>
  45 <p>No.  If you want things to be public, then publish them into the public
  46 registry using npm.  What little security there is would be for nought
  47 otherwise.</p>
  48 <h2 id="do-i-have-to-use-couchdb-to-build-a-registry-that-npm-can-talk-to-">Do I have to use couchdb to build a registry that npm can talk to?</h2>
  49 <p>No, but it&#39;s way easier.  Basically, yes, you do, or you have to
  50 effectively implement the entire CouchDB API anyway.</p>
  51 <h2 id="is-there-a-website-or-something-to-see-package-docs-and-such-">Is there a website or something to see package docs and such?</h2>
  52 <p>Yes, head over to <a href="https://npmjs.com/">https://npmjs.com/</a></p>
  53 <h2 id="see-also">SEE ALSO</h2>
  54 <ul>
  55 <li><a href="../cli/npm-config.html">npm-config(1)</a></li>
  56 <li><a href="../misc/npm-config.html">npm-config(7)</a></li>
  57 <li><a href="../files/npmrc.html">npmrc(5)</a></li>
  58 <li><a href="../misc/npm-developers.html">npm-developers(7)</a></li>
  59 <li><a href="../misc/npm-disputes.html">npm-disputes(7)</a></li>
  60 </ul>
  61
  62 </div>
  63
  64 <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
  65 <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18>&nbsp;</td></tr>
  66 <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td colspan=6 style="width:60px;height:10px;background:#fff">&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td></tr>
  67 <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2>&nbsp;</td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td></tr>
  68 <tr><td style="width:10px;height:10px;background:#fff" rowspan=2>&nbsp;</td></tr>
  69 <tr><td style="width:10px;height:10px;background:#fff">&nbsp;</td></tr>
  70 <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6>&nbsp;</td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td></tr>
  71 <tr><td colspan=5 style="width:50px;height:10px;background:#fff">&nbsp;</td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4>&nbsp;</td><td style="width:90px;height:10px;background:#fff" colspan=9>&nbsp;</td></tr>
  72 </table>
  73 <p id="footer">npm-registry &mdash; npm@2.14.4</p>
  74