-
Notifications
You must be signed in to change notification settings - Fork 5
Home
To get started with the Members Area on OS X (having installed node from homebrew):
npm install -g members-area
mkdir demo
cd demo
members quickstart
The Members Area has a growing number of Plugins available; there's also a page for [Plugin ideas](Plugin ideas).
A non-exhaustive list of current features (with all listed plugins installed):
- Register
- Optional approval of registrations via Roles
- Login (with email/password, GitHub, Facebook, Twitter; simple to add more)
- Permissions (via Roles)
- Subscriptions via standing order, bank giro credit, GoCardless and soon to be more
- View subscription status (view your own, plus admins can view others)
- Use Members Area login for external services (Wordpress and MediaWiki)
- Generate a Register of Members for compliance with UK Law if you're a Company Limited by Guarantee.
Roles are at he heart of the Members Area - they control who can do what, but they're also available as external signals/badges that can be given to people.
The Members Area comes with two default roles: Registered (1) and Owner (2). These two are special - role 2 (Owner) can do anything (they're like root in Unix). No-one can log in to the members area unless they have role 1 (Registered). By default these roles have no requirements, so anyone can register and request the roles and they will be granted instantly. The first thing you should do is add a requirement to the Owner role, for example that it requires 1 vote from an Owner to become an Owner. Optionally you can add a requirement to Registered so that people have to be approved before they can log in.
Registered users can request roles (assuming they pass the prerequisites) by going to the Apply page. Role applications are visible to all members.
Roles can have a wide variety of requirements, some automatic, some manual. Members with certain roles can approve applications for the same or other roles, and each role requirement might have a different number of required approvals. Via plugins more types of requirements can be added - the system is very flexible.