7.8 KiB
id | title |
---|---|
konfigurisanje | Fajl za konfigurisanje |
This file is the cornerstone of Verdaccio where you can modify the default behaviour, enable plugins and extend features.
A default configuration file config.yaml
is created the very first time you run verdaccio
.
Podrazumevane postavke (Default Configuration)
The default configuration has support for scoped packages and allows any user to access all packages, but only authenticated users to publish.
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 }
Sekcije
The following sections explain what each property means and their different options.
Memorija za skladištenje
Je lokacija na kojoj se vrši skladištenje podataka. Verdaccio je inicijalno podešen kao local file system.
storage: ./storage
Plugins
Is the location of the plugin directory. Useful for Docker/Kubernetes-based deployments.
plugins: ./plugins
Authentication
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
Sigurnost
Since: verdaccio@4.0.0
#168
Sigurnosni blok Vam omogućava da prilagodite potpis za token (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.
Konfiguracija je podeljena u dve sekcije, api
i 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]
Jako Vam preporučujemo da se prebacite na JWT pošto je legacy signature (
aes192
) zastareo i neće ga biti u novijim verzijama.
Server
Skup svojstava za menjanje ponašanja server aplikacije, posebno API-ja (Express.js).
Možete zadati da HTTP/1.1 server održava vreme posle kojeg se budi za dolazne konekcije. Ako zadate vrednost 0, http server će se ponašati slično kao Node.js verzije starije od 8.0.0, koje nisu imale ugrađenu funkciju: keep-alive timeout. ZAOBILAŽENJE: Datim konfigurisanjem, možete zaobići sledeći problem: https://github.com/verdaccio/verdaccio/issues/301. Set to 0 in case 60 is not enough.
server:
keepAliveTimeout: 60
Web UI (korisnički interfejs)
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/
Paketi
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
Napredna podešavanja
Publikovanje offline
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
Počevši od verzije: verdaccio@2.3.6
član (due) #223
URL Prefix
The prefix is intended to be used when the server runs behinds the proxy, check the reverse proxy setup page for more details.
url_prefix: /verdaccio/
Verdaccio 5 has an improved prefix behaviour, check here details.
Maksimalna veličina body sekcije dokumenta
By default the maximum body size for a JSON document is 10mb
, if you run into errors that state "request entity too large"
you may increase this value.
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
Proxies are special-purpose HTTP servers designed to transfer data from remote servers to local clients.
http_proxy i 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 that the proxy should not be used for.
no_proxy: localhost,127.0.0.1
Notifikacije
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"}'
Za detaljnije opcije podešavanja, molimo Vas da pogledate source code.
Audit (revizija)
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.
Ako imate novu instalaciju, sve je već uključeno u okviru nje. U suprotnom, treba da dodate navedene dodatke (props) u Vaš config fajl
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.
The features under this flag might not be stable or might be removed in future releases.
Here is one example:
experiments:
token: false
To disable the experiments warning in the console, you must comment out the whole
experiments
section.