Skip to main content

Faili Iṣeto

Faili yii ni pataki igun ti verdaccio nibi ti o ti le se aiyipada iwa atilẹwa naa, ṣe imuṣiṣẹ awọn ohun elo ati awọn ẹya ara to jẹ afikun.

Faili iṣeto atilẹwa kan config.yaml jẹ ṣiṣẹda ni igba akọkọ ti o ba ṣe amulo verdaccio.

Iṣeto Atilẹwa#

Iṣeto atilẹwa naa ni atilẹyin fun scoped awọn akopọ ati fayegba eyikeyi olumulo lati wọle si gbogbo awọn akopọ ṣugbọn nikan jẹki awọn olumulo ti o ni ifasẹsi lati se atẹjade.

storage: ./storageauth:  htpasswd:    file: ./htpasswduplinks:  npmjs:    url: https://registry.npmjs.org/packages:  '@*/*':    access: $all    publish: $authenticated    proxy: npmjs  '**':    proxy: npmjslogs:  - {type: stdout, format: pretty, level: http}

Awọn abala#

Awọn abala wọnyi ṣe alaye nipa nkan ti ohun ini kọọkan tumọ si ati awọn aṣaayan oriṣiriṣi.

Storage#

Is the location of the default storage. Verdaccio is by default based on local file system.

storage: ./storage

Plugins#

Is the location of the plugin directory. Useful for Docker/Kubernetes-based deployments.

plugins: ./plugins

Sise ifasẹsi#

The authentication setup is done here. The default auth is based on htpasswd and is built in. You can modify this behaviour via plugins. For more information about this section read the auth page.

auth:  htpasswd:    file: ./htpasswd    max_users: 1000

Aabo#

Niwọn: verdaccio@4.0.0 #168

The security block allows you to customise the token signature. To enable a new JWT (JSON Web Tokens) signature you need to add the block jwt to the api section; web uses jwt by default.

The configuration is separated in two sections, api and web. To use JWT on api it has to be defined, otherwise the legacy token signature (aes192) will be used. For JWT you might want to customize the signature and the token verification with your own properties.

security:  api:    legacy: true    jwt:      sign:        expiresIn: 29d      verify:        someProp: [value]   web:     sign:       expiresIn: 7d # 7 days by default     verify:        someProp: [value]

A ṣe igbaniyanju to ga lati ko lọ si JWT niwọnti ibuwọlu ijogun (aes192) ti wa ni iparun ati pe o ma farasin ni awọn ẹya ọjọ iwaju.

Server#

Awọn eto ohun elo lati ṣe ayipada iwa ti ohun elo olupese naa, paapaa API (Express.js).

You can specify HTTP/1.1 server keep alive timeout in seconds for incomming connections. A value of 0 makes the http server behave similarly to Node.js versions prior to 8.0.0, which did not have a keep-alive timeout. WORKAROUND: Through given configuration you can workaround following issue https://github.com/verdaccio/verdaccio/issues/301. Set to 0 in case 60 is not enough.

server:  keepAliveTimeout: 60

UI Ayelujara#

This property allow you to modify the look and feel of the web UI. For more information about this section read the web UI page.

web:  enable: true  title: Verdaccio  logo: logo.png  scope:

Uplinks#

Uplinks add the ability to fetch packages from remote registries when those packages are not available locally. For more information about this section read the uplinks page.

uplinks:  npmjs:    url: https://registry.npmjs.org/

Awọn akopọ#

This section allows you to control how packages are accessed. For more information about this section read the packages page.

packages:  '@*/*':    access: $all    publish: $authenticated    proxy: npmjs

Iṣeto Giga#

Atẹjade Alaisilorila#

By default verdaccio does not allow you to publish packages when the client is offline. This can be can be overridden by setting this value to true.

publish:  allow_offline: false
Niwọn: verdaccio@2.3.6 nitori #223

Ibẹrẹ URL#

The prefix is intended to be used when the server runs behinds the proxy and won't work properly if is used without a reverse proxy, check the reverse proxy setup page for more details.

url_prefix: /verdaccio/

Verdaccio 5 has an improved prefix behaviour and the VERDACCIO_PUBLIC_URL is available for use, learn how to here.

Max Body Size#

verdaccio n ṣiṣẹ ni atilẹwa ni ibudo naa 4873. Yiyi ibudo naa pada le ṣee ṣe nipasẹ cli tabi ninu faili iṣeto naa, awọn aṣayan wọnyi fẹsẹmulẹ.

max_body_size: 10mb

Listen Port#

verdaccio runs by default on the port 4873. Changing the port can be done via CLI or in the configuration file. The following options are valid:

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#

To enable https in verdaccio it's enough to set the listen flag with the protocol https://. For more information about this section read the SSL page.

https:    key: ./path/verdaccio-key.pem    cert: ./path/verdaccio-cert.pem    ca: ./path/verdaccio-csr.pem

Proxy#

Ti o ba ni aṣoju ikọkọ kan ninu nẹtiwọki rẹ o le ṣeto akọle X-Forwarded-For kan nipa lilo awọn ohun ini wọnyi.

http_proxy and https_proxy#

Alayipada yii yẹ ki o ni awọn akojọpọ awọn afikun ibudo ti o jẹ yiya sọtọ pẹlu aami idanuduro diẹ ti aṣoju ikọkọ ko gbọdọ jẹ lilo fun.

http_proxy: http://something.local/https_proxy: https://something.local/

no_proxy#

Ṣiṣe imuṣiṣẹ awọn ifitonileti si awọn irinṣẹ alagata rọrun diẹ nipasẹ awọn ikọ ayelujara. Fun alaye siwaju sii nipa abala yii ka oju ewe awọn ifitonileti.

no_proxy: localhost,127.0.0.1

Awọn ifitonileti#

Enabling notifications to third-party tools is fairly easy via webhooks. For more information about this section read the notifications page.

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"}'

Fun alaye awọn eto iṣeto siwaju sii, jọwọ ṣayẹwo koodu orisun naa.

Audit#

Lati: verdaccio@3.0.0

npm audit is a new command released with npm 6.x. Verdaccio includes a built-in middleware plugin to handle this command.

Ti o ba sẹsẹ fi sori ẹrọ o ma n ba wa ni atilẹwa, bibẹkọ o nilo lati se afikun awọn atilẹyin wọnyi sinu faili iṣeto rẹ

middlewares:  audit:    enabled: true

Experiments#

This release includes a new property named experiments that can be placed in the config.yaml and is completely optional.

We want to be able to ship new things without affecting production environments. This flag allows us to add new features and get feedback from the community who decides to use them.

Here one example:

Here is one example:

experiments:  changePassword: false

To disable the experiments warning in the console, you must comment out the whole experiments section.