diff options
author | Rebecca Turner <me@re-becca.org> | 2016-10-08 01:49:31 +0300 |
---|---|---|
committer | Rebecca Turner <me@re-becca.org> | 2016-10-20 13:42:47 +0300 |
commit | c246a75ac8697f4ca11d316b7e7db5f24af7972b (patch) | |
tree | 90bd48d1ea5b255eb6c9b75b094a2fc3ef8c441d /doc | |
parent | 506de80dc0a0576ec2aab0ed8dc3eef3c1dabc23 (diff) |
doc: Document headers we add to registry requests
Credit: @iarna
PR-URL: https://github.com/npm/npm/pull/14129
Reviewed-By: @ashleygwilliams
Diffstat (limited to 'doc')
-rw-r--r-- | doc/misc/npm-registry.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/misc/npm-registry.md b/doc/misc/npm-registry.md index becffa2f6..17d0d4acf 100644 --- a/doc/misc/npm-registry.md +++ b/doc/misc/npm-registry.md @@ -21,6 +21,29 @@ The registry URL used is determined by the scope of the package (see supplied by the `registry` config parameter. See `npm-config(1)`, `npmrc(5)`, and `npm-config(7)` for more on managing npm's configuration. +## Does npm send any information about me back to the registry? + +Yes. + +When making requests of the registry npm adds two headers with information +about your environment: + +* `Npm-Scope` – If your project is scoped, this header will contain its + scope. In the future npm hopes to build registry features that use this + information to allow you to customize your experience for your + organization. +* `Npm-In-CI` – Set to "true" if npm believes this install is running in a + continous integration environment, "false" otherwise. This is detected by + looking for the following environment variables: `CI`, `TDDIUM`, + `JENKINS_URL`, `bamboo.buildKey`. If you'd like to learn more you may find + the [original PR](https://github.com/npm/npm-registry-client/pull/129) + interesting. + This is used to gather better metrics on how npm is used by humans, versus + build farms. + +The npm registry does not to correlate the information in these headers with +any authenticated accounts that may be used in the same requests. + ## Can I run my own private registry? Yes! |