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
   7   <body>
   8     <div id="wrapper">
   9 <h1><a href="../misc/npm-registry.html">npm-registry</a></h1> <p>The JavaScript Package Registry</p>
  10
  11 <h2 id="DESCRIPTION">DESCRIPTION</h2>
  12
  13 <p>To resolve packages by name and version, npm talks to a registry website
  14 that implements the CommonJS Package Registry specification for reading
  15 package info.</p>
  16
  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
  21 <p>The official public npm registry is at <a href="http://registry.npmjs.org/">http://registry.npmjs.org/</a>.  It
  22 is powered by a CouchDB database at
  23 <a href="http://isaacs.iriscouch.com/registry">http://isaacs.iriscouch.com/registry</a>.  The code for the couchapp is
  24 available at <a href="http://github.com/isaacs/npmjs.org">http://github.com/isaacs/npmjs.org</a>.  npm user accounts
  25 are CouchDB users, stored in the <a href="http://isaacs.iriscouch.com/_users">http://isaacs.iriscouch.com/_users</a>
  26 database.</p>
  27
  28 <p>The registry URL is supplied by the <code>registry</code> config parameter.  See
  29 <code><a href="../cli/npm-config.html">npm-config(1)</a></code>, <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
  30 npm&#39;s configuration.</p>
  31
  32 <h2 id="Can-I-run-my-own-private-registry">Can I run my own private registry?</h2>
  33
  34 <p>Yes!</p>
  35
  36 <p>The easiest way is to replicate the couch database, and use the same (or
  37 similar) design doc to implement the APIs.</p>
  38
  39 <p>If you set up continuous replication from the official CouchDB, and then
  40 set your internal CouchDB as the registry config, then you&#39;ll be able
  41 to read any published packages, in addition to your private ones, and by
  42 default will only publish internally.  If you then want to publish a
  43 package for the whole world to see, you can simply override the
  44 <code>--registry</code> config for that command.</p>
  45
  46 <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>
  47
  48 <p>Set <code>&quot;private&quot;: true</code> in your package.json to prevent it from being
  49 published at all, or
  50 <code>&quot;publishConfig&quot;:{&quot;registry&quot;:&quot;http://my-internal-registry.local&quot;}</code>
  51 to force it to be published only to your internal registry.</p>
  52
  53 <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>
  54
  55 <h2 id="Will-you-replicate-from-my-registry-into-the-public-one">Will you replicate from my registry into the public one?</h2>
  56
  57 <p>No.  If you want things to be public, then publish them into the public
  58 registry using npm.  What little security there is would be for nought
  59 otherwise.</p>
  60
  61 <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>
  62
  63 <p>No, but it&#39;s way easier.  Basically, yes, you do, or you have to
  64 effectively implement the entire CouchDB API anyway.</p>
  65
  66 <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>
  67
  68 <p>Yes, head over to <a href="https://npmjs.org/">https://npmjs.org/</a></p>
  69
  70 <h2 id="SEE-ALSO">SEE ALSO</h2>
  71
  72 <ul><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../misc/npm-developers.html">npm-developers(7)</a></li><li><a href="../misc/npm-disputes.html">npm-disputes(7)</a></li></ul>
  73 </div>
  74 <p id="footer">npm-registry &mdash; npm@1.3.17</p>
  75 <script>
  76 ;(function () {
  77 var wrapper = document.getElementById("wrapper")
  78 var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0)
  79   .filter(function (el) {
  80     return el.parentNode === wrapper
  81         && el.tagName.match(/H[1-6]/)
  82         && el.id
  83   })
  84 var l = 2
  85   , toc = document.createElement("ul")
  86 toc.innerHTML = els.map(function (el) {
  87   var i = el.tagName.charAt(1)
  88     , out = ""
  89   while (i > l) {
  90     out += "<ul>"
  91     l ++
  92   }
  93   while (i < l) {
  94     out += "</ul>"
  95     l --
  96   }
  97   out += "<li><a href='#" + el.id + "'>" +
  98     ( el.innerText || el.text || el.innerHTML)
  99     + "</a>"
 100   return out
 101 }).join("\n")
 102 toc.id = "toc"
 103 document.body.appendChild(toc)
 104 })()
 105 </script>