flowpack / neos-frontendlogin
Neos plugin demonstrating a simple frontend login
Installs: 214 375
Dependents: 3
Suggesters: 0
Security: 0
Stars: 22
Watchers: 12
Forks: 18
Open Issues: 4
Language:HTML
Type:neos-plugin
Requires
- neos/neos: ^5.0 || ^7.0 || ^8.0 || dev-master
README
Neos plugin demonstrating a simple "frontend login"
DISCLAIMER
This package mainly serves for demonstration purpose. You should be fine using it in productive applications, but if you need any custom behavior/style it's probably the easiest to create your own login form plugin. It's just a few files.
Setup & Use
- Install the package to
Packages/Plugin/Flowpack.Neos.FrontendLogin
(e.g. viacomposer require flowpack/neos-frontendlogin
) - Login to the Neos backend and create a new page "Login" (e.g. at
/login
) - On that page insert the new plugin
Frontend login form
- (Optionally) create a page (and subpages) for a "Members area" (e.g. at
/members
) and protect it as documented below - Publish all changes
- Create a new Frontend User using the UI (in "Management > Frontend Users")
- Alternatively you can use the
neos.neos:user:create
command (e.g../flow user:create --authentication-provider "Flowpack.Neos.FrontendLogin:Frontend" --roles "Flowpack.Neos.FrontendLogin:User"
)
Now you should be able to test the frontend login by navigating to /login.html
Protected Member Area
If you want to create a "Member Area" that is only visible to authenticated frontend users, add the following Policy.yaml
to your site package:
privilegeTargets: 'Neos\ContentRepository\Security\Authorization\Privilege\Node\ReadNodePrivilege': 'Acme.YourPackage:MembersArea': # Replace <NodeIdentifier> with the node's identifier to be targeted (you can see the identifier in the "Additional info" # group in the Property Inspector of the Neos Backend) matcher: 'isDescendantNodeOf("<NodeIdentifier>")' roles: 'Flowpack.Neos.FrontendLogin:User': privileges: - # Grant "frontend users" access to the "Member area" privilegeTarget: 'Acme.YourPackage:MembersArea' permission: GRANT 'Neos.Neos:Editor': privileges: - # Grant "backend users" to access the "Member area" - Otherwise those pages would be hidden in the backend, too! privilegeTarget: 'Acme.YourPackage:MembersArea' permission: GRANT
The specified node and all its child-nodes will be hidden from anonymous users!
Note: Replace "Acme.YourPackage" with the package key of your site package and replace "<NodeIdentifier>" with the node identifier of the "member area" node (as described).
Rewriting the template path to your package
You might want to modify the template(s) according to your needs. Create a Views.yaml
file and
add the following configuration there:
- requestFilter: 'isPackage("Flowpack.Neos.FrontendLogin") && isController("Authentication") && isAction("index")' options: templatePathAndFilename: 'resource://Acme.YourPackage/Private/Templates/Authenticate/Index.html'
Adjust the actual value in templatePathAndFilename
to your needs and copy the original template
to that location in order to adjust it at will.
Redirect after login/logout
It is possible to specify pages the user will be redirected to after login and/or logout (since version 2.1.) in the login form properties.
Hint: In order to redirect to an external URL you can create a Shortcut node pointing to that URL and specify it as target for the redirect options.
User management UI
The user management UI is available to administrators and everyone else having the role Flowpack.Neos.FrontendLogin.Ui:UserAdministrator
.
It allows to manage users with the Flowpack.Neos.FrontendLogin:Frontend
authentication provider exclusively.
Remove expired users
The CLI command user:deleteexpired
can be used to remove expired users.
It will delete all users having exactly one account with the Flowpack.Neos.FrontendLogin:Frontend
authentication provider.