Simple email application for Android. Original source code: https://framagit.org/dystopia-project/simple-email
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

100 lines
3.8 KiB

  1. npm-registry(7) -- The JavaScript Package Registry
  2. ==================================================
  3. ## DESCRIPTION
  4. To resolve packages by name and version, npm talks to a registry website
  5. that implements the CommonJS Package Registry specification for reading
  6. package info.
  7. npm is configured to use npm, Inc.'s public registry at
  8. <https://registry.npmjs.org> by default. Use of the npm public registry is
  9. subject to terms of use available at <https://www.npmjs.com/policies/terms>.
  10. You can configure npm to use any compatible registry you like, and even run
  11. your own registry. Use of someone else's registry may be governed by their
  12. terms of use.
  13. npm's package registry implementation supports several
  14. write APIs as well, to allow for publishing packages and managing user
  15. account information.
  16. The npm public registry is powered by a CouchDB database,
  17. of which there is a public mirror at
  18. <https://skimdb.npmjs.com/registry>. The code for the couchapp is
  19. available at <https://github.com/npm/npm-registry-couchapp>.
  20. The registry URL used is determined by the scope of the package (see
  21. `npm-scope(7)`). If no scope is specified, the default registry is used, which is
  22. supplied by the `registry` config parameter. See `npm-config(1)`,
  23. `npmrc(5)`, and `npm-config(7)` for more on managing npm's configuration.
  24. ## Does npm send any information about me back to the registry?
  25. Yes.
  26. When making requests of the registry npm adds two headers with information
  27. about your environment:
  28. * `Npm-Scope` – If your project is scoped, this header will contain its
  29. scope. In the future npm hopes to build registry features that use this
  30. information to allow you to customize your experience for your
  31. organization.
  32. * `Npm-In-CI` – Set to "true" if npm believes this install is running in a
  33. continous integration environment, "false" otherwise. This is detected by
  34. looking for the following environment variables: `CI`, `TDDIUM`,
  35. `JENKINS_URL`, `bamboo.buildKey`. If you'd like to learn more you may find
  36. the [original PR](https://github.com/npm/npm-registry-client/pull/129)
  37. interesting.
  38. This is used to gather better metrics on how npm is used by humans, versus
  39. build farms.
  40. The npm registry does not try to correlate the information in these headers
  41. with any authenticated accounts that may be used in the same requests.
  42. ## Can I run my own private registry?
  43. Yes!
  44. The easiest way is to replicate the couch database, and use the same (or
  45. similar) design doc to implement the APIs.
  46. If you set up continuous replication from the official CouchDB, and then
  47. set your internal CouchDB as the registry config, then you'll be able
  48. to read any published packages, in addition to your private ones, and by
  49. default will only publish internally.
  50. If you then want to publish a package for the whole world to see, you can
  51. simply override the `--registry` option for that `publish` command.
  52. ## I don't want my package published in the official registry. It's private.
  53. Set `"private": true` in your package.json to prevent it from being
  54. published at all, or
  55. `"publishConfig":{"registry":"http://my-internal-registry.local"}`
  56. to force it to be published only to your internal registry.
  57. See `package.json(5)` for more info on what goes in the package.json file.
  58. ## Will you replicate from my registry into the public one?
  59. No. If you want things to be public, then publish them into the public
  60. registry using npm. What little security there is would be for nought
  61. otherwise.
  62. ## Do I have to use couchdb to build a registry that npm can talk to?
  63. No, but it's way easier. Basically, yes, you do, or you have to
  64. effectively implement the entire CouchDB API anyway.
  65. ## Is there a website or something to see package docs and such?
  66. Yes, head over to <https://www.npmjs.com/>
  67. ## SEE ALSO
  68. * npm-config(1)
  69. * npm-config(7)
  70. * npmrc(5)
  71. * npm-developers(7)
  72. * npm-disputes(7)