0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-16 21:56:25 -05:00

(doc): Upload authorization documentation

This commit is contained in:
Juan Picado @jotadeveloper 2017-07-05 21:04:09 +02:00 committed by juanpicado
parent ee8063401e
commit 3e78ad3471
2 changed files with 39 additions and 1 deletions

View file

@ -16,12 +16,12 @@ from a fresh look at the code and the outstanding issues. So here we are 🎉
* [Packages Access](packages.md)
* [Enable Notifications](notifications.md)
* [Installing Plugins](plugins.md)
* [Authorization and access](auth.md)
<!---
* [Logs](logs.md)
* [Configure the Web](web.md)
* [Understand the storage](storage.md)
* [Authorization and access](auth.md)
-->
## Advanced Configurations

38
wiki/auth.md Normal file
View file

@ -0,0 +1,38 @@
# Authentification
The authentification is tied to the auth [plugin](plugins.md) you are using. The package restrictions also is handled by the [Package Access](packages.md).
The client authentification is handled by `npm` client itself. Once you login to the application:
```bash
npm adduser --registry http://localhost:4873
```
A token is generated in the `npm` configuration file hosted in your user home folder. For more information about `.npmrc` read the [official documentation](https://docs.npmjs.com/files/npmrc).
```bash
cat .npmrc
registry=http://localhost:5555/
//localhost:5555/:_authToken="secretVerdaccioToken"
//registry.npmjs.org/:_authToken=secretNpmjsToken
```
## Default htpasswd
In order to simplify the setup, `verdaccio` use a build-in plugin based on `htpasswd`.
```yaml
auth:
htpasswd:
file: ./htpasswd
# Maximum amount of users allowed to register, defaults to "+inf".
# You can set this to -1 to disable registration.
#max_users: 1000
```
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
In case to decide do not allow user to login, you can set `max_users: -1`.