60 lines
1.5 KiB
Markdown
60 lines
1.5 KiB
Markdown
|
|
## Installation
|
|
|
|
```sh
|
|
$ npm install sinopia
|
|
$ npm install sinopia-htpasswd
|
|
```
|
|
|
|
PS: Actually, this module is bundled with sinopia, so you don't have to install it like this. But with other auth plugins you have to.
|
|
|
|
## Config
|
|
|
|
Add to your `config.yaml`:
|
|
|
|
```yaml
|
|
auth:
|
|
htpasswd:
|
|
users_file: ./htpasswd
|
|
|
|
# Maximum amount of users allowed to register, defaults to "+inf".
|
|
# You can set this to 0 to disable registration.
|
|
#max_users: 1000
|
|
```
|
|
|
|
## For plugin writers
|
|
|
|
It's called as:
|
|
|
|
```js
|
|
require('sinopia-htpasswd')(config, stuff)
|
|
```
|
|
|
|
Where:
|
|
|
|
- config - module's own config
|
|
- stuff - collection of different internal sinopia objects
|
|
- stuff.config - main config
|
|
- stuff.logger - logger
|
|
|
|
This should export two functions:
|
|
|
|
- `adduser(user, password, cb)`
|
|
|
|
It should respond with:
|
|
- `cb(err)` in case of an error (error will be returned to user)
|
|
- `cb(null, false)` in case registration is disabled (next auth plugin will be executed)
|
|
- `cb(null, true)` in case user registered successfully
|
|
|
|
It's useful to set `err.status` property to set http status code (e.g. `err.status = 403`).
|
|
|
|
- `authenticate(user, password, cb)`
|
|
|
|
It should respond with:
|
|
- `cb(err)` in case of a fatal error (error will be returned to user, keep those rare)
|
|
- `cb(null, false)` in case user not authenticated (next auth plugin will be executed)
|
|
- `cb(null, [groups])` in case user is authenticated
|
|
|
|
Groups is an array of all users/usergroups this user has access to. You should probably include username itself here.
|
|
|