0
Fork 0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-12-23 22:27:34 -05:00
verdaccio/packages/plugins/active-directory/README.md

34 lines
1.3 KiB
Markdown

# @verdaccio/active-directory
Active Directory authentication plugin for Verdaccio
## Installation
```bash
npm install -g @verdaccio/active-directory
```
## Config
This settings can be set in `config.yaml`. All fields are mandatory except `groupName`, which is optional, to add security group(s). Also, this optional field can be a single string or a list of strings. Take care that, when defining `groupName` key, the user that will be authenticating must be in, at least, one of the groups defined, to authenticate successfully.
```yaml
auth:
activedirectory:
url: 'ldap://localhost'
baseDN: 'dc=local,dc=host'
domainSuffix: 'local.host'
# groupName: 'singleGroup' # optional, single group syntax
# groupName: # optional, multiple groups syntax
# - 'group1'
# - 'group2'
```
## Inspiration
This plugin is based on [verdaccio-activedirectory](https://github.com/nowhammies/verdaccio-activedirectory), which is based on [siponia-activedirectory](https://github.com/ela-compil/sinopia-activedirectory).
Thanks to [Doug Dennie](https://github.com/nowhammies) and [Ela-compil sp. z o. o.](https://github.com/ela-compil) for making this possible.
## License
@verdaccio/active-directory is an open source project with [MIT license](LICENSE)