1
0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-11-13 03:35:52 +01:00
verdaccio/conf/full.yaml

152 lines
5.2 KiB
YAML
Raw Normal View History

2013-06-13 16:21:14 +02:00
# path to a directory with all packages
storage: ./storage
2013-09-24 06:27:47 +02:00
# a list of users
2014-07-26 15:14:06 +02:00
#
2014-10-20 20:40:33 +02:00
# This could be deprecated soon, use auth plugins instead (see htpasswd below).
2013-06-13 16:21:14 +02:00
users:
admin:
# crypto.createHash('sha1').update(pass).digest('hex')
password: a94a8fe5ccb19ba61c4c0873d391e987982fbbd3
2013-06-13 16:21:14 +02:00
web:
# web interface is disabled by default in 0.x, will be enabled soon in 1.x
# when all its issues will be fixed
#
# set this to `true` if you want to experiment with web ui now;
# this has a lot of issues, e.g. no auth yet, so use at your own risk
#enable: true
title: Verdaccio
# logo: logo.png
# template: custom.hbs
# tagline: "Some <b>HTML</b> enabled tagline that sits between the actual \
#header and the list of packages. You can even add <a \
#href=\"https://github.com\">links</a>!"
2013-06-13 16:21:14 +02:00
2014-09-02 02:27:04 +02:00
auth:
htpasswd:
2014-09-14 17:57:39 +02:00
file: ./htpasswd
2014-09-02 02:27:04 +02:00
# Maximum amount of users allowed to register, defaults to "+inf".
# You can set this to -1 to disable registration.
2014-09-02 02:27:04 +02:00
#max_users: 1000
2014-06-26 18:21:23 +02:00
2013-09-24 06:27:47 +02:00
# a list of other known repositories we can talk to
2013-06-13 16:21:14 +02:00
uplinks:
npmjs:
url: https://registry.npmjs.org/
# amount of time to wait for repository to respond
# before giving up and use the local cached copy
#timeout: 30s
# maximum time in which data is considered up to date
2013-10-22 10:34:07 +02:00
#
# default is 2 minutes, so server won't request the same data from
# uplink if a similar request was made less than 2 minutes ago
#maxage: 2m
2013-10-22 10:34:07 +02:00
2014-03-13 19:32:44 +01:00
# if two subsequent requests fail, no further requests will be sent to
# this uplink for five minutes
#max_fails: 2
#fail_timeout: 5m
# timeouts are defined in the same way as nginx, see:
# http://wiki.nginx.org/ConfigNotation
# add/override HTTP headers sent to the uplink server
# this allows for HTTP Basic auth for example:
#headers:
# authorization: "Basic YourBase64EncodedCredentials=="
2013-06-13 16:21:14 +02:00
packages:
# uncomment this for packages with "local-" prefix to be available
2013-09-24 06:36:43 +02:00
# for admin only, it's a recommended way of handling private packages
#'local-*':
2015-04-08 22:54:59 +02:00
# access: admin
# publish: admin
# # you can override storage directory for a group of packages this way:
# storage: 'local_storage'
2013-09-24 06:36:43 +02:00
'**':
2014-09-02 02:27:04 +02:00
# allow all users to read packages (including non-authenticated users)
#
# you can specify usernames/groupnames (depending on your auth plugin)
# and three keywords: "$all", "$anonymous", "$authenticated"
2015-04-08 22:54:59 +02:00
access: $all
2013-06-13 16:21:14 +02:00
2013-09-24 06:27:47 +02:00
# allow 'admin' to publish packages
2015-04-08 22:54:59 +02:00
publish: admin
2013-09-24 06:27:47 +02:00
# if package is not available locally, proxy requests to 'npmjs' registry
proxy: npmjs
2013-09-24 06:36:43 +02:00
#####################################################################
# Advanced settings
#####################################################################
# if you use nginx with custom path, use this to override links
#url_prefix: https://dev.company.local/verdaccio/
2013-09-24 06:36:43 +02:00
# You can specify listen address (or simply a port).
# If you add multiple values, verdaccio will listen on all of them.
#
# Examples:
#
#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
# Configure HTTPS, it is required if you use "https" protocol above.
#https:
# key: path/to/server.key
# cert: path/to/server.crt
2013-09-24 06:40:46 +02:00
# type: file | stdout | stderr
# level: trace | debug | info | http (default) | warn | error | fatal
#
# parameters for file: name is filename
# {type: 'file', path: 'verdaccio.log', level: 'debug'},
#
# parameters for stdout and stderr: format: json | pretty | pretty-timestamped
# {type: 'stdout', format: 'pretty', level: 'debug'},
2013-10-12 16:37:47 +02:00
logs:
- {type: stdout, format: pretty, level: http}
#- {type: file, path: verdaccio.log, level: info}
2013-11-24 18:07:54 +01:00
# you can specify proxy used with all requests in wget-like manner here
# (or set up ENV variables with the same name)
#http_proxy: http://something.local/
#https_proxy: https://something.local/
#no_proxy: localhost,127.0.0.1
# maximum size of uploaded json document
# increase it if you have "request entity too large" errors
#max_body_size: 1mb
# Notify Settings
# Notify was built primarily to use with Slack's Incoming
# webhooks, but will also deliver a simple payload to
# any endpoint. Currently only active for publish / create
# commands.
notify:
# Choose a method. Technically this will accept any HTTP
# request method, but probably stick to GET or POST
method: POST
# If this endpoint requires specific headers, set them here
# as an array of key: value objects.
headers: [{'Content-type': 'application/x-www-form-urlencoded'}]
# set the URL endpoint for this call
endpoint: https://hooks.slack.com/...
# Finally, the content you will be sending in the body.
# This data will first be run through Handlebars to parse
# any Handlebar expressions. All data housed in the metadata object
# is available for use within the expressions.
content: ' {{ handlebar-expression }}'
# For Slack, follow the following format:
# content: '{ "text": "Package *{{ name }}* published to version *{{ dist-tags.latest }}*", "username": "Verdaccio", "icon_emoji": ":package:" }'