From 6d8aa9817c37d8c3b7f38659427f2727409ba423 Mon Sep 17 00:00:00 2001 From: Tony Patrinos Date: Tue, 14 Jun 2022 17:48:56 +0200 Subject: [PATCH] Improved documentation comments in docker.yaml (#3228) --- packages/config/src/conf/docker.yaml | 49 +++++++++++++++------------- 1 file changed, 26 insertions(+), 23 deletions(-) diff --git a/packages/config/src/conf/docker.yaml b/packages/config/src/conf/docker.yaml index 22ca2adad..179a0e157 100644 --- a/packages/config/src/conf/docker.yaml +++ b/packages/config/src/conf/docker.yaml @@ -1,7 +1,6 @@ # -# This is the default configuration file. It allows all users to do anything, -# please read carefully the documentation and best practices to -# improve security. +# This is the default configuration file. As it allows all users to do anything, +# please read carefully the documentation and best practices to improve security. # # Do not configure host and port under `listen` in this file # as it will be ignored when using docker. @@ -21,18 +20,18 @@ plugins: /verdaccio/plugins # https://verdaccio.org/docs/webui web: title: Verdaccio - # comment out to disable gravatar support + # Comment out to disable gravatar support # gravatar: false - # by default packages are ordercer ascendant (asc|desc) + # By default packages are ordered ascendant (asc|desc) # sort_packages: asc - # convert your UI to the dark side + # Convert your UI to the dark side # darkMode: true # html_cache: true - # by default all features are displayed + # By default all features are displayed # login: true # showInfo: true # showSettings: true - # In combination with darkMode you can force specific theme + # In combination with darkMode you can force a specific theme # showThemeSwitch: true # showFooter: true # showSearch: true @@ -41,12 +40,12 @@ web: # HTML tags injected after manifest # scriptsBodyAfter: # - '' - # HTML tags injected before ends + # HTML tags injected before end # metaScripts: # - '' # - '' # - '' - # HTML tags injected first child at + # HTML tags injected as first child at # bodyBefore: # - '
html before webpack scripts
' # Public path for template manifest scripts (only manifest) @@ -61,7 +60,7 @@ auth: # max_users: 1000 # https://verdaccio.org/docs/configuration#uplinks -# a list of other known repositories we can talk to +# A list of other known repositories we can talk to uplinks: npmjs: url: https://registry.npmjs.org/ @@ -78,14 +77,14 @@ packages: proxy: npmjs '**': - # allow all users (including non-authenticated users) to read and + # Allow all users (including non-authenticated users) to read and # publish all packages # - # you can specify usernames/groupnames (depending on your auth plugin) + # You can specify usernames/groupnames (depending on your auth plugin) # and three keywords: "$all", "$anonymous", "$authenticated" access: $all - # allow all known users to publish/publish packages + # Allow all known users to publish/publish packages # (anyone can register by default, remember?) publish: $authenticated unpublish: $authenticated @@ -93,14 +92,16 @@ packages: # if package is not available locally, proxy requests to 'npmjs' registry proxy: npmjs -# To improve your security configuration and avoid dependency confusion +# To improve your security configuration and avoid dependency confusion # consider removing the proxy property for private packages # https://verdaccio.org/docs/best#remove-proxy-to-increase-security-at-private-packages # https://verdaccio.org/docs/configuration#server -# You can specify HTTP/1.1 server keep alive timeout in seconds for incoming 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. +# You can specify the HTTP/1.1 server keep alive timeout in seconds for incoming 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 work around the following issue: +# https://github.com/verdaccio/verdaccio/issues/301. Set to 0 in case 60 is not enough. server: keepAliveTimeout: 60 @@ -152,7 +153,7 @@ server: # - "[::1]:4873" # ipv6 # - unix:/tmp/verdaccio.sock # unix socket -# The HTTPS configuration is useful if you do not consider use a HTTP Proxy +# The HTTPS configuration is useful if you do not consider using an HTTP Proxy # https://verdaccio.org/docs/configuration#https # https: # key: ./path/verdaccio-key.pem @@ -178,17 +179,19 @@ middlewares: # log settings log: { type: stdout, format: pretty, level: http } #experiments: -# # support for npm token command +# # Support for npm token command # token: false -# # enable tarball URL redirect for hosting tarball with a different server, the tarball_url_redirect can be a template string +# # Enable tarball URL redirect for hosting tarball with a different server. +# # The tarball_url_redirect can be a template string # tarball_url_redirect: 'https://mycdn.com/verdaccio/${packageName}/${filename}' -# # the tarball_url_redirect can be a function, takes packageName and filename and returns the url, when working with a js configuration file +# # The tarball_url_redirect can be a function, takes packageName and filename and returns the url, +# # when working with a js configuration file # tarball_url_redirect(packageName, filename) { # const signedUrl = // generate a signed url # return signedUrl; # } -# translate your registry, api i18n not available yet +# Translate your registry, api i18n not available yet # i18n: # list of the available translations https://github.com/verdaccio/verdaccio/blob/master/packages/plugins/ui-theme/src/i18n/ABOUT_TRANSLATIONS.md # web: en-US