-permissions

[![Gitter][gitter-image]][gitter-url]
[![NPM version][npm-image]][npm-url]
[![Build status][travis-image]][travis-url]
[![Dependency Status][daviddm-image]][daviddm-url]

Comprehensive sails.js user permissions and entitlements system. Supports user authentication with passport.js, role-based permissioning, object ownership, and row-level security.

This package was last updated in 2015. For the most up-to-date information on auth and permissions in Sails, visit the official Sails website.

Install

``sh
$ npm install sails-permissions sails-auth --save
`

Quickstart

Note: Complete documentation available in the sails-permissions wiki: https://github.com/tjwebb/sails-permissions/wiki

$3

`json
{
"generators": {
"modules": {
"permissions-api": "sails-permissions/generator"
}
}
}
`

$3

`sh
$ sails generate permissions-api
`

$3

| variable | description | default |
|:---|:---|:---|
| ADMIN_USERNAME | admin username | admin |
| ADMIN_EMAIL | admin user email address | admin@example.com |
| ADMIN_PASSWORD | admin user password | admin1234 |

##### e.g in config/local.js (file is in .gitignore)
`
sails.config.permissions.adminUsername = 'admin'
sails.config.permissions.adminEmail = 'admin@example.com'
sails.config.permissions.adminPassword = 'admin1234'
`
#### 4. update configs

#### config/policies.js
`js
'*': [
'basicAuth',
'passport',
'sessionAuth',
'ModelPolicy',
'AuditPolicy',
'OwnerPolicy',
'PermissionPolicy',
'RolePolicy',
'CriteriaPolicy'
],

AuthController: {
'*': [ 'passport' ]
}
`

#### 5. Login
You can now login using the aforementioned default login data or the admin settings you specified using the /auth/local endpoint.
`json
{
"identifier": "admin@example.com",
"password": "admin1234"
}
``

License

MIT

[npm-image]: https://img.shields.io/npm/v/sails-permissions.svg?style=flat-square
[npm-url]: https://npmjs.org/package/sails-permissions
[travis-image]: https://img.shields.io/travis/tjwebb/sails-permissions.svg?style=flat-square
[travis-url]: https://travis-ci.org/tjwebb/sails-permissions
[daviddm-image]: http://img.shields.io/david/tjwebb/sails-permissions.svg?style=flat-square
[daviddm-url]: https://david-dm.org/tjwebb/sails-permissions
[gitter-image]: http://img.shields.io/badge/+%20GITTER-JOIN%20CHAT%20%E2%86%92-1DCE73.svg?style=flat-square
[gitter-url]: https://gitter.im/tjwebb/sails-permissions