mirror of
https://github.com/verdaccio/verdaccio.git
synced 2025-02-17 23:45:29 -05:00
198 lines
5.8 KiB
Markdown
198 lines
5.8 KiB
Markdown
|
---
|
|||
|
id: configuration
|
|||
|
title: "Fichier de configuration"
|
|||
|
---
|
|||
|
Ce fichier est le pilier de verdaccio où vous pouvez modifier le comportement par défaut, activer les plugins et étendre les fonctionnalités.
|
|||
|
|
|||
|
Un fichier de configuration par défaut est créé la première fois que vous exécutez `verdaccio`.
|
|||
|
|
|||
|
## Configuration par défaut
|
|||
|
|
|||
|
La configuration par défaut a un support pour les packs **portée(scoped)** et permet à tout utilisateur à accéder à tous les packs, mais seuls **les utilisateurs authentifiés qui peuvent publier**.
|
|||
|
|
|||
|
```yaml
|
|||
|
storage: ./storage
|
|||
|
auth:
|
|||
|
htpasswd:
|
|||
|
file: ./htpasswd
|
|||
|
uplinks:
|
|||
|
npmjs:
|
|||
|
url: https://registry.npmjs.org/
|
|||
|
packages:
|
|||
|
'@*/*':
|
|||
|
access: $all
|
|||
|
publish: $authenticated
|
|||
|
proxy: npmjs
|
|||
|
'**':
|
|||
|
proxy: npmjs
|
|||
|
logs:
|
|||
|
- {type: stdout, format: pretty, level: http}
|
|||
|
```
|
|||
|
|
|||
|
## Sections
|
|||
|
|
|||
|
Les sections suivantes expliquent ce que signifie chaque propriété et les différentes options.
|
|||
|
|
|||
|
### Stockage
|
|||
|
|
|||
|
C'est le chemin de stockage par défaut. **Verdaccio est basé par défaut sur le fichier système local**.
|
|||
|
|
|||
|
```yaml
|
|||
|
stockage: ./stockage
|
|||
|
```
|
|||
|
|
|||
|
### Plugins
|
|||
|
|
|||
|
C'est le chemin du répertoire des plugins. Utile pour les déploiements basées sur Docker/Kubernetes.
|
|||
|
|
|||
|
```yaml
|
|||
|
plugins: ./plugins
|
|||
|
```
|
|||
|
|
|||
|
### Authentification
|
|||
|
|
|||
|
Le paramètre d'authentification est défini ici, l'authentification par défaut est basée sur `htpasswd` et est intégrée. Vous pouvez modifier ce comportement via les[plugins](plugins.md). Pour plus d'informations sur cette section, consultez la [ page d'authentification ](auth.md).
|
|||
|
|
|||
|
```yaml
|
|||
|
auth:
|
|||
|
htpasswd:
|
|||
|
file: ./htpasswd
|
|||
|
max_users: 1000
|
|||
|
```
|
|||
|
|
|||
|
### Interface utilisateur Web
|
|||
|
|
|||
|
Cette propriété vous permet de modifier les fonctionnalités de l'interface utilisateur Web. Pour plus d'informations sur cette section, consultez la [ page de l'interface utilisateur Web ](web.md).
|
|||
|
|
|||
|
```yaml
|
|||
|
web:
|
|||
|
enable: true
|
|||
|
title: Verdaccio
|
|||
|
logo: logo.png
|
|||
|
scope:
|
|||
|
```
|
|||
|
|
|||
|
### Uplinks
|
|||
|
|
|||
|
Uplinks est la capacité du système à récupérer des paquets à partir de registres distants lorsque ces paquets ne sont pas disponibles localement. Pour plus d'informations sur cette section, lisez [uplinks page](uplinks.md).
|
|||
|
|
|||
|
```yaml
|
|||
|
uplinks:
|
|||
|
npmjs:
|
|||
|
url: https://registry.npmjs.org/
|
|||
|
```
|
|||
|
|
|||
|
### Paquets
|
|||
|
|
|||
|
Les Paquets permettent à l'utilisateur de contrôler comment les paquets sont rendus accessibles. Pour plus d'informations sur cette section, consultez la [ page des paquets ](packages.md).
|
|||
|
|
|||
|
```yaml
|
|||
|
packages:
|
|||
|
'@*/*':
|
|||
|
access: $all
|
|||
|
publish: $authenticated
|
|||
|
proxy: npmjs
|
|||
|
```
|
|||
|
|
|||
|
## Paramètres avancés
|
|||
|
|
|||
|
### Publication hors ligne
|
|||
|
|
|||
|
Par défaut `verdaccio` n'autorise pas le client à publier lorsqu'il est hors ligne, ce comportement peut être remplacé en définissant cette option *Vraie*.
|
|||
|
|
|||
|
```yaml
|
|||
|
publish:
|
|||
|
allow_offline: false
|
|||
|
```
|
|||
|
|
|||
|
<small>Since: <code>verdaccio@2.3.6</code> due <a href="https://github.com/verdaccio/verdaccio/pull/223">#223</a></small>
|
|||
|
|
|||
|
### Préfixe de l'URL
|
|||
|
|
|||
|
```yaml
|
|||
|
url_prefix: https://dev.company.local/verdaccio/
|
|||
|
```
|
|||
|
|
|||
|
Depuis: `verdaccio@2.3.6` due [#197](https://github.com/verdaccio/verdaccio/pull/197)
|
|||
|
|
|||
|
### Taille maximale du corps
|
|||
|
|
|||
|
Par défaut, la taille maximale du corps d'un document JSON est `10mb`. Si vous rencontrez des erreurs telles que ` "entité de demande trop grande" `, vous pouvez augmenter cette valeur.
|
|||
|
|
|||
|
```yaml
|
|||
|
max_body_size: 10mb
|
|||
|
```
|
|||
|
|
|||
|
### Port d’écoute
|
|||
|
|
|||
|
`verdaccio` s’exécute par défaut dans le port `4873`. La modification du port peut être faite via [cli](cli.md) ou dans le fichier de configuration, les options suivantes sont valides.
|
|||
|
|
|||
|
```yaml
|
|||
|
listen:
|
|||
|
# - localhost:4873 # default value
|
|||
|
# - http://localhost:4873 # same thing
|
|||
|
# - 0.0.0.0:4873 # listen on all addresses (INADDR_ANY)
|
|||
|
# - https://example.org:4873 # if you want to use https
|
|||
|
# - "[::1]:4873" # ipv6
|
|||
|
# - unix:/tmp/verdaccio.sock # unix socket
|
|||
|
```
|
|||
|
|
|||
|
### HTTPS
|
|||
|
|
|||
|
Pour activer `https` dans `verdaccio` il suffit de définir le drapeau `Ecoute` avec le protocole *https://*. Pour plus d’informations sur cette section, lisez [ssl page](ssl.md).
|
|||
|
|
|||
|
```yaml
|
|||
|
https:
|
|||
|
key: ./path/verdaccio-key.pem
|
|||
|
cert: ./path/verdaccio-cert.pem
|
|||
|
ca: ./path/verdaccio-csr.pem
|
|||
|
```
|
|||
|
|
|||
|
### Proxy
|
|||
|
|
|||
|
Les Proxy sont des serveurs HTTP spéciaux conçus pour transférer des données de serveurs distants vers des clients locaux.
|
|||
|
|
|||
|
#### http_proxy and https_proxy
|
|||
|
|
|||
|
Si vous avez un proxy sur votre réseau, vous pouvez définir un en-tête `X-Forwarded-For` à l'aide des propriétés suivantes.
|
|||
|
|
|||
|
```yaml
|
|||
|
http_proxy: http://something.local/
|
|||
|
https_proxy: https://something.local/
|
|||
|
```
|
|||
|
|
|||
|
#### no_proxy
|
|||
|
|
|||
|
Cette variable doit contenir une liste d'extensions de domaine séparées par des virgules pour lesquelles le proxy ne doit pas être utilisé.
|
|||
|
|
|||
|
```yaml
|
|||
|
no_proxy: localhost,127.0.0.1
|
|||
|
```
|
|||
|
|
|||
|
### Notifications
|
|||
|
|
|||
|
L'activation des notifications d'outils tiers est assez facile via des webhooks. Pour plus d'informations sur cette section, consultez la [ page de notification ](notifications.md).
|
|||
|
|
|||
|
```yaml
|
|||
|
notify:
|
|||
|
method: POST
|
|||
|
headers: [{'Content-Type': 'application/json'}]
|
|||
|
endpoint: https://usagge.hipchat.com/v2/room/3729485/notification?auth_token=mySecretToken
|
|||
|
content: '{"color":"green","message":"New package published: * {{ name }}*","notify":true,"message_format":"text"}'
|
|||
|
```
|
|||
|
|
|||
|
> Pour plus de détails sur les paramètres de configuration, veuillez [ vérifier le code source ](https://github.com/verdaccio/verdaccio/tree/master/conf).
|
|||
|
|
|||
|
### Audit
|
|||
|
|
|||
|
<small>Depuis : <code>verdaccio@3.0.0</code></small>
|
|||
|
|
|||
|
` npm audit ` est une nouvelle commande émise avec[ npm 6.x ](https://github.com/npm/npm/releases/tag/v6.1.0). Verdaccio inclut un plugin middleware intégré pour gérer cette commande.
|
|||
|
|
|||
|
> Si vous avez une nouvelle installation, elle est fournie par défaut. Sinon, vous devez ajouter les propriétés suivantes à votre fichier de configuration
|
|||
|
|
|||
|
```yaml
|
|||
|
middlewares:
|
|||
|
audit:
|
|||
|
enabled: true
|
|||
|
```
|