Skip to main content

Osvědčené postupy

The following guide is a list of the best practices collected and that we usually recommend to all users. Do not take this guide as mandatory, you might pick some of them according your needs.

Své osvědčené postupy můžete sdílet s komunitou Verdaccio.

Soukromý registr

You can add users and manage which users can access which packages.

It is recommended that you define a prefix for your private packages, for example local-* or scoped @my-company/*, so all your private things will look like this: local-foo. This way you can clearly separate public packages from private ones.

 yaml
packages:
'@my-company/*':
access: $all
publish: $authenticated
'local-*':
access: $all
publish: $authenticated
'@*/*':
access: $all
publish: $authenticated
'**':
access: $all
publish: $authenticated

Vždy si pamatujte, že pořadí přístupu k balíčkům je důležité, balíčky jsou vždy porovnávány shora dolů.

Using public packages from npmjs.org

If a package doesn't exist in the storage, the server will try to fetch it from npmjs.org. If npmjs.org is down, it serves packages from the cache pretending that no other packages exist. Verdaccio will download only what's needed (requested by clients), and this information will be cached, so if the client requests the same thing a second time it can be served without asking npmjs.org for it.

Příklad:

If you successfully request express@4.0.1 from the server once, you'll be able to do it again (with all of it's dependencies) any time, even if npmjs.org is down. Though note that express@4.0.0 will not be downloaded until it's actually needed by somebody. And if npmjs.org is offline, the server will say that only express@4.0.1 (what's in the cache) is published, but nothing else.

Override public packages

Chcete-li použít upravenou verzi nějakého veřejného balíčku foo, můžete jej publikovat pouze na místní server, takže když spustíte npm install foo, bude stažena Vámi vytvořená verze.

There's two options here:

  1. Chcete vytvořit samostatý fork a zastavit synchronizaci s veřejnou verzí.

    If you want to do that, you should modify your configuration file so Verdaccio won't make requests regarding this package to npmjs anymore. Add a separate entry for this package to config.yaml and remove npmjs from proxy list and restart the server.

    packages:
    '@my-company/*':
    access: $all
    publish: $authenticated
    # zakomentujte nebo ponechte prázdné
    # proxy:

    Když svůj balíček publikujete lokálně, **měli byste pravděpodobně začít s řetězcem verzí vyšším, než je stávající **, takže nebude v konfliktu s existujícím balíčkem ve vyrovnávací paměti.

  2. You want to temporarily use your version, but return to public one as soon as it's updated.

    In order to avoid version conflicts, you should use a custom pre-release suffix of the next patch version. For example, if a public package has version 0.1.2, you can upload 0.1.3-my-temp-fix.

     npm version 0.1.3-moje-docasna-oprava
    npm --publish --tag fix --registry http://localhost:4873

    Tímto způsobem bude váš balíček používán, dokud jeho původní správce nezmění svůj veřejný balíček na 0.1.3.

Bezpečnost

Security starts in your environment.

Additional reading:

Strong package access with $authenticated

By default all packages you publish in Verdaccio are accessible for all users. We recommend protecting your registry from external non-authorized users by updating the access property of your packages to $authenticated.

packages:
'@my-company/*':
access: $authenticated
publish: $authenticated
'@*/*':
access: $authenticated
publish: $authenticated
'**':
access: $authenticated
publish: $authenticated

Tímto způsobem, ** nikdo nebude mít zálohu vašeho registru, pokud není autorizován a soukromé balíčky nebudou zobrazeny v uživatelském rozhraní **.

Remove proxy to increase security at private packages

Používání ** HTTPS ** je běžným doporučením, z tohoto důvodu doporučujeme přečíst si sekci SSL, abyste mohli Verdaccio zabezpečit nebo používat HTTPSreverse proxy nad Verdaccio.

packages:
"@*/*":
access: $authenticated
publish: $authenticated
proxy: npmjs
"**":
access: $authenticated
publish: $authenticated
proxy: npmjs

This means, if a private packaged eg: @my-company/auth is published locally, the registry will look up at the public registry. If your intention is fully protection, remove the proxy property from your configuration, for instance:

packages:
"@my-company/*":
access: $authenticated
publish: $authenticated
unpublish: $authenticated
"@*/*":
access: $authenticated
publish: $authenticated
proxy: npmjs
"**":
access: $authenticated
publish: $authenticated
proxy: npmjs

Použití této konfigurace přepíše současný systém a budete moci řídit, jak dlouho bude token platný.

Server

Secured Connections

Using HTTPS is a common recommendation. For this reason we recommend reading the SSL section to make Verdaccio secure, or alternatively using an HTTPS reverse proxy on top of Verdaccio.

Expiring Tokens

Since verdaccio@3.x the tokens have no expiration date. For such reason we introduced in the next verdaccio@4.x the JWT feature PR#896

security:
api:
jwt:
sign:
expiresIn: 15d
notBefore: 0
web:
sign:
expiresIn: 7d

Using this configuration will override the current system and you will be able to control how long the token will live.

Using JWT also improves the performance with authentication plugins. The old system will perform an unpackage and validate the credentials on every request, while JWT will rely on the token signature instead, avoiding the overhead for the plugin.

As a side note, be aware at npmjs and the legacy verdaccio token never expires** unless you invalidate manually.