diff options
Diffstat (limited to 'docs/install/registries.md')
| -rw-r--r-- | docs/install/registries.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/install/registries.md b/docs/install/registries.md new file mode 100644 index 000000000..e4090e3c9 --- /dev/null +++ b/docs/install/registries.md @@ -0,0 +1,26 @@ +The default registry is `registry.npmjs.org`. This can be globally configured in `bunfig.toml`: + +```toml +[install] +# set default registry as a string +registry = "https://registry.npmjs.org" +# set a token +registry = { url = "https://registry.npmjs.org", token = "123456" } +# set a username/password +registry = "https://username:password@registry.npmjs.org" +``` + +To configure a private registry scoped to a particular organization: + +```toml +[install.scopes] +# registry as string +"@myorg1" = "https://username:password@registry.myorg.com/" + +# registry with username/password +# you can reference environment variables +"@myorg2" = { username = "myusername", password = "$NPM_PASS", url = "https://registry.myorg.com/" } + +# registry with token +"@myorg3" = { token = "$npm_token", url = "https://registry.myorg.com/" } +``` |