{"id":19020234,"url":"https://github.com/trailsjs/sails-permissions","last_synced_at":"2025-04-05T15:08:22.549Z","repository":{"id":20178658,"uuid":"23449597","full_name":"trailsjs/sails-permissions","owner":"trailsjs","description":"Comprehensive user permissions and entitlements system for sails.js and Waterline. Supports user authentication with passport.js, role-based permissioning, object ownership, and row-level security.","archived":false,"fork":false,"pushed_at":"2018-02-28T08:04:06.000Z","size":340,"stargazers_count":418,"open_issues_count":93,"forks_count":113,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-03-29T14:11:17.125Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/trailsjs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-08-29T02:11:28.000Z","updated_at":"2024-06-15T20:59:25.000Z","dependencies_parsed_at":"2022-09-03T07:20:48.114Z","dependency_job_id":null,"html_url":"https://github.com/trailsjs/sails-permissions","commit_stats":null,"previous_names":["tjwebb/sails-permissions"],"tags_count":100,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trailsjs%2Fsails-permissions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trailsjs%2Fsails-permissions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trailsjs%2Fsails-permissions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trailsjs%2Fsails-permissions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/trailsjs","download_url":"https://codeload.github.com/trailsjs/sails-permissions/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246939210,"owners_count":20857920,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T20:16:12.585Z","updated_at":"2025-04-05T15:08:22.528Z","avatar_url":"https://github.com/trailsjs.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# sails-permissions\n\n[![Gitter][gitter-image]][gitter-url]\n[![NPM version][npm-image]][npm-url]\n[![Build status][travis-image]][travis-url]\n[![Dependency Status][daviddm-image]][daviddm-url]\n\nComprehensive sails.js user permissions and entitlements system. Supports user authentication with passport.js, role-based permissioning, object ownership, and row-level security.\n\n## Install\n```sh\n$ npm install sails-permissions sails-auth --save\n```\n\n## Quickstart\n\n**Note:** Complete documentation available in the sails-permissions wiki: https://github.com/langateam/sails-permissions/wiki\n\n### 1. configure sailsrc\n\n```json\n{\n  \"generators\": {\n    \"modules\": {\n      \"permissions-api\": \"sails-permissions/generator\"\n    }\n  }\n}\n```\n\n### 2. run generator\n\n```sh\n$ sails generate permissions-api\n```\n\n### 3. Set environment variables\n\n| variable | description | default |\n|:---|:---|:---|\n| `ADMIN_USERNAME` | admin username | `admin` |\n| `ADMIN_EMAIL` | admin user email address | `admin@example.com` |\n| `ADMIN_PASSWORD` | admin user password | `admin1234` |\n\n##### e.g in config/local.js (file is in .gitignore)\n```\nsails.config.permissions.adminUsername = 'admin'\nsails.config.permissions.adminEmail = 'admin@example.com'\nsails.config.permissions.adminPassword = 'admin1234'\n```\n#### 4. update configs\n\n#### config/policies.js\n```js\n  '*': [\n    'basicAuth',\n    'passport',\n    'sessionAuth',\n    'ModelPolicy',\n    'AuditPolicy',\n    'OwnerPolicy',\n    'PermissionPolicy',\n    'RolePolicy',\n    'CriteriaPolicy'\n  ],\n\n  AuthController: {\n    '*': [ 'passport' ]\n  }\n```\n\n#### 5. Login\nYou can now login using the aforementioned default login data or the admin settings you specified using the `/auth/local` endpoint.\n```json\n{\n    \"identifier\": \"admin@example.com\",\n    \"password\": \"admin1234\"\n}\n```\n\n## License\nMIT\n\n## Maintained By\n[\u003cimg src='http://i.imgur.com/Y03Jgmf.png' height='64px'\u003e](http://langa.io)\n\n[npm-image]: https://img.shields.io/npm/v/sails-permissions.svg?style=flat-square\n[npm-url]: https://npmjs.org/package/sails-permissions\n[travis-image]: https://img.shields.io/travis/langateam/sails-permissions.svg?style=flat-square\n[travis-url]: https://travis-ci.org/langateam/sails-permissions\n[daviddm-image]: http://img.shields.io/david/langateam/sails-permissions.svg?style=flat-square\n[daviddm-url]: https://david-dm.org/langateam/sails-permissions\n[gitter-image]: http://img.shields.io/badge/+%20GITTER-JOIN%20CHAT%20%E2%86%92-1DCE73.svg?style=flat-square\n[gitter-url]: https://gitter.im/langateam/sails-permissions\n\n[hacktober-image]: http://i.imgur.com/FM9yVCI.png\n[hacktober-url]: https://twitter.com/langateam/status/782995392212369408\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrailsjs%2Fsails-permissions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftrailsjs%2Fsails-permissions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrailsjs%2Fsails-permissions/lists"}