0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2025-01-20 22:52:46 -05:00

chore: update docs for 5.13.0

This commit is contained in:
Juan Picado 2022-06-17 05:55:35 +02:00
parent a6be85ac3a
commit 0e74d5ea52
3 changed files with 36 additions and 3 deletions

View file

@ -66,12 +66,21 @@ auth:
file: ./htpasswd
# Maximum amount of users allowed to register, defaults to "+inf".
# You can set this to -1 to disable registration.
#max_users: 1000
# max_users: 1000
# Hash algorithm, possible options are: "bcrypt", "md5", "sha1", "crypt".
algorithm: bcrypt # by default is crypt, but is recommended use bcrypt for new installations
# Rounds number for "bcrypt", will be ignored for other algorithms.
rounds: 10
```
> The default algorithm is `crypt`, considered not secure for production environments, it's recommended for new installations use `bcrypt` instead. Note after verdaccio 6.x
the default will be `bcrypt`.
Property | Type | Required | Example | Support | Description
--- | --- | --- | --- | --- | ---
file | string | Yes | ./htpasswd | all | file that host the encrypted credentials
max_users | number | No | 1000 | all | set limit of users
algorithm | string | No | bcrypt/md5/sha1/crypt | >=5.13.0 | set hasing password algorithm
rounds | number | No | 10 | >=5.13.0 | Rounds number for "bcrypt", will be ignored for other algorithms
In case you decide to prevent users from signing up themselves, you can set `max_users: -1`.
> In case you decide to prevent users from signing up themselves, you can set `max_users: -1`.

View file

@ -34,10 +34,33 @@ Open the `config.yaml` file and update the `auth` section as follows:
The default configuration looks like this, due we use a build-in `htpasswd` plugin by default that you can disable just commenting out the following lines.
### Naming convention {#naming-convention}
Since version `2.0.0` until version plugins must start with the following convention:
- `sinopia-xxx` (deprecated and will be removed on 6.x.x)
- `verdaccio-xxx`
After version `5.12.0` scoped plugins are supported, for example:
```yaml
auth:
'@my-org/auth-awesome-plugin':
foo: some value
bar: another value
store:
'@my-org/store-awesome-plugin':
foo: some value
bar: another value
middleware:
'@my-org/middleware-awesome-plugin':
foo: some value
bar: another value
```
### Authentication Configuration {#authentication-configuration}
```yaml
auth:
htpasswd:
file: ./htpasswd
# max_users: 1000

View file

@ -1,7 +1,7 @@
{
"private": true,
"name": "@verdaccio/website",
"version": "5.10.3",
"version": "5.13.0",
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
@ -59,6 +59,7 @@
"docusaurus-plugin-sass": "^0.2.1",
"esbuild": "0.14.10",
"esbuild-loader": "2.16.0",
"got": "12.1.0",
"prism-react-renderer": "^1.2.1",
"sass": "1.49.0",
"sass-loader": "^12.1.0",