4.2.2

Translate

Configuration File

Этот файл является краеугольным камнем verdaccio. В нём вы можете изменить стандартное поведение, включить плагины и расширенные возможности.

Файл конфигурации по умолчанию config.yaml будет создан, когда вы самый первый раз запустите verdaccio.

Конфигурация по умолчанию

Стандартная конфигурация поддерживает scoped-пакеты и позволяет любым пользователям получить доступ ко всем пакетам, но только авторизованные пользователи могут публиковать пакеты.

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}

Разделы

Следующие разделы пояснят, что каждое свойство означает, и какими дополнительными опциями обладает.

Хранилище

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

storage: ./storage

Плагины

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

plugins: ./plugins

Аутентификация

Настройка аутентификация делается здесь. По умолчанию аутентификация основана на htpasswd и является встроенной. Вы можете изменить это при помощи плагинов. Читайте об этом в разделе Аутентификация.

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

Безопасность

Работает, начиная с verdaccio@4.0.0 #168

Этот блок позволяет кастомизировать авторизацию токенами. Чтобы включить авторизацию по JWT (json web token), вам надо добавить блок jwt к разделу api, а раздел web успользует jwt по умолчанию.

Конфигурация разделена на две части, api и web. Чтобы использовать JWT в api, его надо прописать там в явном виде, иначе будут использоваться "старые" токены (aes192). Для JWT, вы можете кастомизировать свойства токена signature и verification, добавивив свои собственные поля.

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

Мы настоятельно рекомендем перейти на JWT, так как "старые" токены (aes192) устарели и исчезнут в следующих версиях.

Сервер

Набор свойств, которые позволяют изменить поведение сервера, особенно это касается API (Express.js).

Вы можете указать HTTP/1.1-серверу keep-alive таймаут в секундах, для входящих соединений. Если вы укажете 0, то сервер будет вести себя аналогично Node.js версии ниже 8.0.0, который не имел keep-alive таймаута. WORKAROUND: С помощью этой конфигурации вы можете обойти баг #301. Установить в 0 в случае 60 - недостаточно.

server:
  keepAliveTimeout: 60

Web UI

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 is the ability of the system 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/

Packages

Packages allow the user to control how the packages are gonna be accessed. For more information about this section read the packages page.

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

Расширенные настройки

Offline Publish

By default verdaccio does not allow to publish when the client is offline, that behavior can be overridden by setting this to true.

publish:
  allow_offline: false

Since: verdaccio@2.3.6 due #223

URL Prefix

url_prefix: /verdaccio/

Мы рекомендуем использовать подпапку /verdaccio/ вместо URI.

Max Body Size

By default the maximum body size for a JSON document is 10mb, if you run in errors as "request entity too large" you may increase this value.

max_body_size: 10mb

Listen Port

verdaccio runs by default in 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

Прокси

Proxies are special-purpose HTTP servers designed to transfer data from remote servers to local clients.

http_proxy и https_proxy

If you have a proxy in your network you can set a X-Forwarded-For header using the following properties.

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

no_proxy

This variable should contain a comma-separated list of domain extensions proxy should not be used for.

no_proxy: localhost,127.0.0.1

Уведомления

Enabling notifications to third-party tools is fairly easy via web hooks. 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"}'

For more detailed configuration settings, please check the source code.

Audit

Since: 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.

If you have a new installation it comes by default, otherwise you need to add the following props to your config file

middlewares:
  audit:
    enabled: true
← ВыступленияАплинки →