Quickstart Guide
This Quickstart Guide assumes its' reader has a basic level of competence with the Liferay portal. As such it will not cover Liferay management topics such as how to create pages or add or remove portlet applications to a page.
Installation
The MyPlaces User Hook comes in the form of a Web Application Archive. It may be installed by copying to the <liferay-install-path>/deploy folder or via Control Panel > Plugins Installation > Install More Portlets > Upload File.
Configuration
The MyPlaces User Hook has three configuration attributes. These attribute needs to be placed in the description of the community(ies) the portal administrator whishes new users to be auto-enrolled in to.
| Attribute Name | Description | Default Value |
|---|---|---|
| myplaces.user.membership.auto-enroll | If set to 'true', flags a community as one which new users will be auto-enrolled in to | 'false' |
| myplaces.user.membership.auto-enroll.notify-owners | If set to 'true', a email will be sent to community owners and community administrators informing them of a new user's enrollment in their community | 'false' |
| myplaces.user.membership.auto-enroll.notify-owners.email.from | The address the above notification email will appear to be sent from eg. noreplay@liferay.com. If not defined, the email will be addressed as being "from" one of the community's owner. | Nil |
If signed in as an administrator, the community description can be accessed by:
- Opening the 'Manage' menu from the administration toolbar
- Choosing the 'Control Panel' menu item
- Clicking the 'Communities' option in the 'Portal' subsection of the left hand side of the Control Panel
- Clicking the 'Actions' button corresponding to the community in to which users should be auto-enrolled and choosing the 'Edit' option from the context menu which appears.
- Add the attribute "myplaces.user.membership.auto-enroll=true" (and optionally the other two attributes) to the 'Description' text area (below the community name input field).
Licence Information
The MyPlaces User Hook licence information can be reviewed on the page http://<servername>/myplaces-user-hook/license