mirror of
https://github.com/verdaccio/verdaccio.git
synced 2025-01-27 22:59:51 -05:00
87 lines
5.9 KiB
Markdown
87 lines
5.9 KiB
Markdown
|
---
|
|||
|
|
id: uplinks
|
|||
|
|
title: "Uplinks"
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
An *uplink* is a link with an external registry that provides access to external packages.
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
### Utilisation
|
|||
|
|
|
|||
|
|
```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 the following properties:
|
|||
|
|
|
|||
|
|
| Propriété | Type | Obligatoire | Exemple | Soutien | Description | Par défaut |
|
|||
|
|
| ------------- | -------------------- | ----------- | ------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- |
|
|||
|
|
| url | chaîne de caractères | Oui | https://registry.npmjs.org/ | tous | L’url du registre | npmjs |
|
|||
|
|
| ca | chaîne de caractères | Non | ~./ssl/client.crt' | tous | Certificat de chemin SSL | Pas par défaut |
|
|||
|
|
| timeout | chaîne de caractères | Non | 100ms | tous | définir le nouveau délai d’attente pour la demande | 30s |
|
|||
|
|
| maxage | chaîne de caractères | Non | 10m | tous | the time threshold to the cache is valid | 2m |
|
|||
|
|
| fail_timeout | chaîne de caractères | Non | 10m | tous | définit le temps maximal pour qu'une demande devienne un échec | 5m |
|
|||
|
|
| max_fails | numéro | Non | 2 | tous | limite maximale d'échecs à chaque demande | 2 |
|
|||
|
|
| cache | booléenne | Non | [vrai,faux] | >= 2.1 | mettre en cache tous les tarballs éloignés dans l'archive | vrai |
|
|||
|
|
| auth | liste | Non | [voir ci-dessous](uplinks.md#auth-property) | >= 2.5 | attribuer l'en-tête "Autorisation" [plus d'informations](http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules) | désactivé |
|
|||
|
|
| en-têtes | liste | Non | autorisation: "Bearer SecretJWToken==" | tous | liste des en-têtes personnalisés pour l'uplink | désactivé |
|
|||
|
|
| strict_ssl | booléenne | Non | [vrai,faux] | >= 3.0 | Si vrai, nécessite que les certificats SSL soient valides. | vrai |
|
|||
|
|
| agent_options | object | Non | maxSockets: 10 | >= 4.0.2 | options for the HTTP or HTTPS Agent responsible for managing uplink connection persistence and reuse [more info](https://nodejs.org/api/http.html#http_class_http_agent) | Pas par défaut |
|
|||
|
|
|
|||
|
|
#### Propriété de l'auth
|
|||
|
|
|
|||
|
|
La propriété `auth` vous permet d'utiliser un jeton d'authentification avec un uplink. Utilisez la variable environnementale par défaut:
|
|||
|
|
|
|||
|
|
```yaml
|
|||
|
|
uplinks:
|
|||
|
|
private:
|
|||
|
|
url: https://private-registry.domain.com/registry
|
|||
|
|
auth:
|
|||
|
|
type: bearer
|
|||
|
|
token_env: true # defaults to `process.env['NPM_TOKEN']`
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
ou par une variable environnementale spécifique:
|
|||
|
|
|
|||
|
|
```yaml
|
|||
|
|
uplinks:
|
|||
|
|
private:
|
|||
|
|
url: https://private-registry.domain.com/registry
|
|||
|
|
auth:
|
|||
|
|
type: bearer
|
|||
|
|
token_env: FOO_TOKEN
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
`token_env: FOO_TOKEN` utilisera en interne `process.env['FOO_TOKEN']`
|
|||
|
|
|
|||
|
|
ou en spécifiant directement un jeton:
|
|||
|
|
|
|||
|
|
```yaml
|
|||
|
|
uplinks:
|
|||
|
|
private:
|
|||
|
|
url: https://private-registry.domain.com/registry
|
|||
|
|
auth:
|
|||
|
|
type: bearer
|
|||
|
|
token: "token"
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
> Remarque: `jeton` a la priorité sur `jeton_env`
|
|||
|
|
|
|||
|
|
### Vous devez savoir
|
|||
|
|
|
|||
|
|
* Uplinks must be registries compatible with the `npm` endpoints. Eg: *verdaccio*, `sinopia@1.4.0`, *npmjs registry*, *yarn registry*, *JFrog*, *Nexus* and more.
|
|||
|
|
* Setting `cache` to false will help to save space in your hard drive. This will avoid store `tarballs` but [it will keep metadata in folders](https://github.com/verdaccio/verdaccio/issues/391).
|
|||
|
|
* 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)
|