2.0.0-15-hf1 • Published 3 years ago
@inspire-platform/sails-hook-permissions v2.0.0-15-hf1
@inspire-platform/sails-hook-permissions
Comprehensive sails.js user permissions and entitlements system. Supports user authentication with passport.js, role-based permissioning, object ownership, and row-level security.
Contents
- Install
- Quickstart
- Concepts
- Configuration
- Managing Permissions
Install
$ npm install @inspire-platform/sails-hook-permissions --save
Quickstart
1. configure sailsrc
{
"generators": {
"modules": {
"permissions-api": "@inspire-platform/sails-hook-permissions/generator"
}
}
}
2. run generator
WARNING! The generator is not currently up to date with the 2.x.x releases.
$ sails generate permissions-api
3. Manual configuration
Env vars
variable | description | default |
---|---|---|
ADMIN_USERNAME | admin username | admin |
ADMIN_EMAIL | admin user email address | admin@example.com |
ADMIN_PASSWORD | admin user password | admin1234 |
config/permissions.js (or config/local.js)
...
permissions: {
adminUser: {
username: 'admin',
email: 'admin@example.com',
password: 'admin1234'
// add custom fields here if your model requires them
}
},
...
config/policies.js
'*': [
'basicAuth',
'passport',
'sessionAuth',
'ModelPolicy',
'AuditPolicy',
'OwnerPolicy',
'PermissionPolicy',
'RolePolicy',
'CriteriaPolicy'
],
AuthController: {
'*': [ 'passport' ]
}
4. Login
You can now login using the aforementioned default login data or the admin settings you specified using the /auth/local
endpoint.
{
"identifier": "admin@example.com",
"password": "admin1234"
}
License
MIT
2.0.0-15-hf1
3 years ago
2.2.1
5 years ago
2.2.0
5 years ago
2.0.0-21
5 years ago
2.1.0
5 years ago
2.0.0
5 years ago
2.0.0-20
5 years ago
2.0.0-19
5 years ago
2.0.0-18
5 years ago
2.0.0-17
6 years ago
2.0.0-16
6 years ago
2.0.0-15
6 years ago
2.0.0-14
6 years ago
2.0.0-13
6 years ago
2.0.0-12
6 years ago
2.0.0-11
6 years ago
2.0.0-10
6 years ago
2.0.0-9
6 years ago
2.0.0-8
6 years ago
1.0.4
7 years ago
2.0.0-7
7 years ago
2.0.0-6
7 years ago
2.0.0-5
7 years ago
2.0.0-4
7 years ago
2.0.0-3
7 years ago
2.0.0-2
7 years ago
2.0.0-1
7 years ago
2.0.0-0
7 years ago
1.0.3
7 years ago
1.0.2
7 years ago
1.0.1
7 years ago
1.0.0
7 years ago