2017-12-16 07:29:58 -05:00
---
id: uplinks
title: Uplinks
---
An *uplink* is a link with an external registry that provides acccess to external packages.
### Usage
```yaml
uplinks:
npmjs:
url: https://registry.npmjs.org/
server2:
url: http://mirror.local.net/
timeout: 100ms
server3:
url: http://mirror2.local.net:9000/
baduplink:
url: http://localhost:55666/
```
### Configuration
You can define mutiple uplinks and each of them must have an unique name (key). They can have two properties:
New Crowdin translations (#461)
* New translations ansible.md (Chinese Traditional)
* New translations uplinks.md (Chinese Traditional, Hong Kong)
* New translations ssl.md (Urdu (Pakistan))
* New translations test.md (Chinese Traditional)
* New translations test.md (Chinese Traditional, Hong Kong)
* New translations test.md (Portuguese, Brazilian)
* New translations test.md (Spanish)
* New translations test.md (Urdu (Pakistan))
* New translations uplinks.md (Chinese Traditional)
* New translations uplinks.md (Portuguese, Brazilian)
* New translations ssl.md (Portuguese, Brazilian)
* New translations uplinks.md (Spanish)
* New translations uplinks.md (Urdu (Pakistan))
* New translations use-cases.md (Chinese Traditional)
* New translations use-cases.md (Chinese Traditional, Hong Kong)
* New translations use-cases.md (Portuguese, Brazilian)
* New translations use-cases.md (Spanish)
* New translations use-cases.md (Urdu (Pakistan))
* New translations ssl.md (Spanish)
* New translations ssl.md (Chinese Traditional, Hong Kong)
* New translations web.md (Chinese Traditional, Hong Kong)
* New translations reverse-proxy.md (Chinese Traditional, Hong Kong)
* New translations protect-your-dependencies.md (Urdu (Pakistan))
* New translations repositories.md (Chinese Traditional)
* New translations repositories.md (Chinese Traditional, Hong Kong)
* New translations repositories.md (Portuguese, Brazilian)
* New translations repositories.md (Spanish)
* New translations repositories.md (Urdu (Pakistan))
* New translations reverse-proxy.md (Chinese Traditional)
* New translations reverse-proxy.md (Portuguese, Brazilian)
* New translations ssl.md (Chinese Traditional)
* New translations reverse-proxy.md (Spanish)
* New translations reverse-proxy.md (Urdu (Pakistan))
* New translations server.md (Chinese Traditional)
* New translations server.md (Chinese Traditional, Hong Kong)
* New translations server.md (Portuguese, Brazilian)
* New translations server.md (Spanish)
* New translations server.md (Urdu (Pakistan))
* New translations web.md (Chinese Traditional)
* New translations web.md (Portuguese, Brazilian)
* New translations protect-your-dependencies.md (Portuguese, Brazilian)
* New translations repositories.md (Chinese Simplified)
* New translations install.md (Chinese Simplified)
* New translations kubernetes.md (Chinese Simplified)
* New translations logger.md (Chinese Simplified)
* New translations notifications.md (Chinese Simplified)
* New translations packages.md (Chinese Simplified)
* New translations plugins.md (Chinese Simplified)
* New translations protect-your-dependencies.md (Chinese Simplified)
* New translations reverse-proxy.md (Chinese Simplified)
* New translations home.md (Chinese Simplified)
* New translations server.md (Chinese Simplified)
* New translations ssl.md (Chinese Simplified)
* New translations test.md (Chinese Simplified)
* New translations uplinks.md (Chinese Simplified)
* New translations use-cases.md (Chinese Simplified)
* New translations web.md (Chinese Simplified)
* New translations windows.md (Chinese Simplified)
* New translations iis-server.md (Chinese Simplified)
* New translations docker.md (Chinese Simplified)
* New translations web.md (Spanish)
* New translations web.md (Urdu (Pakistan))
* New translations windows.md (Chinese Traditional)
* New translations windows.md (Chinese Traditional, Hong Kong)
* New translations windows.md (Portuguese, Brazilian)
* New translations windows.md (Spanish)
* New translations windows.md (Urdu (Pakistan))
* New translations dev-plugins.md (Chinese Simplified)
* New translations ansible.md (Chinese Simplified)
* New translations auth.md (Chinese Simplified)
* New translations cli.md (Chinese Simplified)
* New translations config.md (Chinese Simplified)
* New translations contributing.md (Chinese Simplified)
* New translations protect-your-dependencies.md (Spanish)
* New translations protect-your-dependencies.md (Chinese Traditional, Hong Kong)
* New translations ansible.md (Chinese Traditional, Hong Kong)
* New translations dev-plugins.md (Chinese Traditional)
* New translations config.md (Spanish)
* New translations config.md (Urdu (Pakistan))
* New translations contributing.md (Chinese Traditional)
* New translations contributing.md (Chinese Traditional, Hong Kong)
* New translations contributing.md (Portuguese, Brazilian)
* New translations contributing.md (Spanish)
* New translations contributing.md (Urdu (Pakistan))
* New translations dev-plugins.md (Chinese Traditional, Hong Kong)
* New translations config.md (Chinese Traditional, Hong Kong)
* New translations dev-plugins.md (Portuguese, Brazilian)
* New translations dev-plugins.md (Spanish)
* New translations dev-plugins.md (Urdu (Pakistan))
* New translations docker.md (Chinese Traditional)
* New translations docker.md (Chinese Traditional, Hong Kong)
* New translations docker.md (Portuguese, Brazilian)
* New translations docker.md (Spanish)
* New translations config.md (Portuguese, Brazilian)
* New translations config.md (Chinese Traditional)
* New translations home.md (Chinese Traditional)
* New translations auth.md (Urdu (Pakistan))
* New translations ansible.md (Portuguese, Brazilian)
* New translations ansible.md (Spanish)
* New translations ansible.md (Urdu (Pakistan))
* New translations auth.md (Chinese Traditional)
* New translations auth.md (Chinese Traditional, Hong Kong)
* New translations auth.md (Portuguese, Brazilian)
* New translations auth.md (Spanish)
* New translations cli.md (Urdu (Pakistan))
* New translations cli.md (Chinese Traditional)
* New translations cli.md (Chinese Traditional, Hong Kong)
* New translations cli.md (Portuguese, Brazilian)
* New translations cli.md (Spanish)
* New translations docker.md (Urdu (Pakistan))
* New translations home.md (Chinese Traditional, Hong Kong)
* New translations protect-your-dependencies.md (Chinese Traditional)
* New translations packages.md (Chinese Traditional, Hong Kong)
* New translations logger.md (Urdu (Pakistan))
* New translations notifications.md (Chinese Traditional)
* New translations notifications.md (Chinese Traditional, Hong Kong)
* New translations notifications.md (Portuguese, Brazilian)
* New translations notifications.md (Spanish)
* New translations notifications.md (Urdu (Pakistan))
* New translations packages.md (Chinese Traditional)
* New translations packages.md (Portuguese, Brazilian)
* New translations logger.md (Portuguese, Brazilian)
* New translations packages.md (Spanish)
* New translations packages.md (Urdu (Pakistan))
* New translations plugins.md (Chinese Traditional)
* New translations plugins.md (Chinese Traditional, Hong Kong)
* New translations plugins.md (Portuguese, Brazilian)
* New translations plugins.md (Spanish)
* New translations plugins.md (Urdu (Pakistan))
* New translations logger.md (Spanish)
* New translations logger.md (Chinese Traditional, Hong Kong)
* New translations home.md (Portuguese, Brazilian)
* New translations install.md (Chinese Traditional)
* New translations home.md (Spanish)
* New translations home.md (Urdu (Pakistan))
* New translations iis-server.md (Chinese Traditional)
* New translations iis-server.md (Chinese Traditional, Hong Kong)
* New translations iis-server.md (Portuguese, Brazilian)
* New translations iis-server.md (Spanish)
* New translations iis-server.md (Urdu (Pakistan))
* New translations install.md (Chinese Traditional, Hong Kong)
* New translations logger.md (Chinese Traditional)
* New translations install.md (Portuguese, Brazilian)
* New translations install.md (Spanish)
* New translations install.md (Urdu (Pakistan))
* New translations kubernetes.md (Chinese Traditional)
* New translations kubernetes.md (Chinese Traditional, Hong Kong)
* New translations kubernetes.md (Portuguese, Brazilian)
* New translations kubernetes.md (Spanish)
* New translations kubernetes.md (Urdu (Pakistan))
2018-01-09 12:52:17 -05:00
| Property | Type | Required | Example | Support | Description | Default |
| ------------ | ------- | -------- | ----------------------------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | -------- |
| url | string | Yes | https://registry.npmjs.org/ | all | The registry url | npmjs |
| timeout | string | No | 100ms | all | set new timeout for the request | 30s |
| maxage | string | No | 10m | all | limit maximun failure request | 2m |
| fail_timeout | string | No | 10m | all | defines max time when a request becomes a failure | 5m |
| max_fails | number | No | 2 | all | limit maximun failure request | 2 |
| cache | boolean | No | [true,false] | >= 2.1 | avoid cache tarballs | true |
| auth | list | No | type: [bearer,basic], [token: "token",token_env: [true,\<get name process.env\>]] | >= 2.5 | assigns the header 'Authorization' see: http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules | disabled |
| headers | list | No | authorization: "Basic YourBase64EncodedCredentials==" | all | list of custom headers for the uplink | disabled |
2017-12-16 07:29:58 -05:00
### You Must know
* Uplinks must be registries compatible with the `npm` endpoints. Eg: *verdaccio* , *sinopia@1.4.0* , *npmjs registry* , *yarn registry* and more.
* Setting `cache` to false will help to save space in your hard drive.
* Exceed with multiple uplinks might slow down the lookup of your packages due for each request a npm client does, verdaccio does 1 call for each uplink.
* The (timeout, maxage and fail_timeout) format follow the [NGINX measurement units ](http://nginx.org/en/docs/syntax.html )