deps/npm/man/man7/npm-registry.7

   1 .\" Generated with Ronnjs 0.3.8
   2 .\" http://github.com/kapouer/ronnjs/
   3 .
   4 .TH "NPM\-REGISTRY" "7" "November 2013" "" ""
   5 .
   6 .SH "NAME"
   7 \fBnpm-registry\fR \-\- The JavaScript Package Registry
   8 .
   9 .SH "DESCRIPTION"
  10 To resolve packages by name and version, npm talks to a registry website
  11 that implements the CommonJS Package Registry specification for reading
  12 package info\.
  13 .
  14 .P
  15 Additionally, npm\'s package registry implementation supports several
  16 write APIs as well, to allow for publishing packages and managing user
  17 account information\.
  18 .
  19 .P
  20 The official public npm registry is at \fIhttp://registry\.npmjs\.org/\fR\|\.  It
  21 is powered by a CouchDB database at \fIhttp://isaacs\.iriscouch\.com/registry\fR\|\.  The code for the couchapp is
  22 available at \fIhttp://github\.com/isaacs/npmjs\.org\fR\|\.  npm user accounts
  23 are CouchDB users, stored in the \fIhttp://isaacs\.iriscouch\.com/_users\fR
  24 database\.
  25 .
  26 .P
  27 npm help  npm help The registry URL is supplied by the \fBregistry\fR config parameter\.  See \fBnpm\-config\fR, \fBnpmrcnpm help  \fR, and \fBnpm\-config\fR for more on managing
  28 npm\'s configuration\.
  29 .
  30 .SH "Can I run my own private registry?"
  31 Yes!
  32 .
  33 .P
  34 The easiest way is to replicate the couch database, and use the same (or
  35 similar) design doc to implement the APIs\.
  36 .
  37 .P
  38 If you set up continuous replication from the official CouchDB, and then
  39 set your internal CouchDB as the registry config, then you\'ll be able
  40 to read any published packages, in addition to your private ones, and by
  41 default will only publish internally\.  If you then want to publish a
  42 package for the whole world to see, you can simply override the \fB\-\-registry\fR config for that command\.
  43 .
  44 .SH "I don&#39;t want my package published in the official registry\. It&#39;s private\."
  45 Set \fB"private": true\fR in your package\.json to prevent it from being
  46 published at all, or \fB"publishConfig":{"registry":"http://my\-internal\-registry\.local"}\fR
  47 to force it to be published only to your internal registry\.
  48 .
  49 .P
  50 npm help  See \fBpackage\.json\fR for more info on what goes in the package\.json file\.
  51 .
  52 .SH "Will you replicate from my registry into the public one?"
  53 No\.  If you want things to be public, then publish them into the public
  54 registry using npm\.  What little security there is would be for nought
  55 otherwise\.
  56 .
  57 .SH "Do I have to use couchdb to build a registry that npm can talk to?"
  58 No, but it\'s way easier\.  Basically, yes, you do, or you have to
  59 effectively implement the entire CouchDB API anyway\.
  60 .
  61 .SH "Is there a website or something to see package docs and such?"
  62 Yes, head over to \fIhttps://npmjs\.org/\fR
  63 .
  64 .SH "SEE ALSO"
  65 .
  66 .IP "\(bu" 4
  67 npm help config
  68 .
  69 .IP "\(bu" 4
  70 npm help  config
  71 .
  72 .IP "\(bu" 4
  73 npm help  npmrc
  74 .
  75 .IP "\(bu" 4
  76 npm help  developers
  77 .
  78 .IP "\(bu" 4
  79 npm help  disputes
  80 .
  81 .IP "" 0
  82