Skip to content

docs(npmrc): add example of URI fragment limitations #8099

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: latest
Choose a base branch
from
Open

docs(npmrc): add example of URI fragment limitations #8099

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17c94c4
[refs #8095] docs(npmrc): add example of URI fragment limitations
misse Feb 11, 2025
289b85e
add breakdown of registry and auth config
misse Mar 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 40 additions & 9 deletions docs/lib/content/configuring-npm/npmrc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ to override default configs in a standard and consistent manner.
### Auth related configuration

The settings `_auth`, `_authToken`, `username` and `_password` must all be
scoped to a specific registry. This ensures that `npm` will never send
scoped to a specific `registry`. This ensures that `npm` will never send
credentials to the wrong host.

The full list is:
Expand All @@ -112,23 +112,54 @@ the scope may look like `//registry.npmjs.org/:`. If it must be scoped to a
specific path on the host that path may also be provided, such as
`//my-custom-registry.org/unique/path:`.

#### How NPM matches Registry URL with auth configuration

Let's say you have:

```ini
@myorg:registry=https://registry.npmjs.org/myorg
```

npm will look for:

```ini
//registry.npmjs.org/myorg/:_authToken=...
```

If instead you put:

```ini
//registry.npmjs.org/:_authToken=...
```

That won’t be used, because it **doesn’t match** what npm looks for from the registry URL you defined.

#### Extended configuration example

```ini
; bad config
_authToken=MYTOKEN

; good config
@myorg:registry=https://somewhere-else.com/myorg
@another:registry=https://somewhere-else.com/another
@myorg:registry=https://somewhere-else.npmjs.org/myorg
@another:registry=https://somewhere-else.npmjs.org/another
@anotherorg:registry=https:///registry.npmjs.org/path/anotherorg

; Applies to any registry at https://registry.npmjs.org/ but not to any sub-path (see @anotherorg)
//registry.npmjs.org/:_authToken=MYTOKEN

; would apply to both @myorg and @another
//somewhere-else.com/:_authToken=MYTOKEN
; Applies to both @myorg and @another but noth @anotherorg
//somewhere-else.npmjs.org/:_authToken=MYTOKEN

; Only applies to @myorg
//somewhere-else.npmjs.org/myorg/:_authToken=MYTOKEN1

; Only applies to @another
//somewhere-else.npmjs.org/another/:_authToken=MYTOKEN2

; would apply only to @myorg
//somewhere-else.com/myorg/:_authToken=MYTOKEN1
; Only applies to @anotherorg
//registry.npmjs.org/path/anotherorg:_authToken=MYTOKEN3

; would apply only to @another
//somewhere-else.com/another/:_authToken=MYTOKEN2
```

### See also
Expand Down