{"id":22319384,"url":"https://github.com/rainlab/user-plugin","last_synced_at":"2025-05-15T00:11:58.482Z","repository":{"id":1146724,"uuid":"14856100","full_name":"rainlab/user-plugin","owner":"rainlab","description":"Front-end user management.","archived":false,"fork":false,"pushed_at":"2024-05-29T05:23:09.000Z","size":1365,"stargazers_count":110,"open_issues_count":0,"forks_count":148,"subscribers_count":20,"default_branch":"master","last_synced_at":"2024-05-29T18:10:57.930Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rainlab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-12-02T07:55:00.000Z","updated_at":"2024-06-01T01:23:51.737Z","dependencies_parsed_at":"2024-01-09T03:23:59.068Z","dependency_job_id":"df865bc6-047d-46a7-96fa-c95252f82a7e","html_url":"https://github.com/rainlab/user-plugin","commit_stats":{"total_commits":529,"total_committers":117,"mean_commits":4.521367521367521,"dds":0.497164461247637,"last_synced_commit":"270f8ca450e6881e4b13e1df0726ff136e626cad"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rainlab%2Fuser-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rainlab%2Fuser-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rainlab%2Fuser-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rainlab%2Fuser-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rainlab","download_url":"https://codeload.github.com/rainlab/user-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248525138,"owners_count":21118619,"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-12-04T00:08:36.240Z","updated_at":"2025-04-12T06:15:01.300Z","avatar_url":"https://github.com/rainlab.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Front-end user plugin\n\nFront-end user management for October CMS. View this plugin on the October CMS marketplace:\n\n- https://octobercms.com/plugin/rainlab-user\n\n## Requirements\n\n- October CMS 3.6 or above\n- The [AJAX Framework](https://docs.octobercms.com/3.x/cms/ajax/introduction.html) to be included in your layout/page\n\n## Installation Instructions\n\nRun the following to install this plugin:\n\n```bash\nphp artisan plugin:install RainLab.User\n```\n\nTo uninstall this plugin:\n\n```bash\nphp artisan plugin:remove RainLab.User\n```\n\n### Older Versions\n\nIf you are using **October CMS v3.0 - v3.5**, install v2.1 with the following commands:\n\n```bash\ncomposer require rainlab/user-plugin \"^2.1\"\n```\n\nIf you are using **October CMS v1.0 - v2.3**, install v1.7 with the following commands:\n\n```bash\ncomposer require rainlab/user-plugin \"^1.7\"\n```\n\n### Sample Theme\n\nWe recommend installing this plugin with the `RainLab.Vanilla` theme to demonstrate its functionality.\n\n- https://github.com/rainlab/vanilla-theme\n\nFor extra functionality, consider also installing the `RainLab.UserPlus` plugin.\n\n- https://octobercms.com/plugin/rainlab-userplus\n\n## Managing Users\n\nUsers are managed on the Users tab found in the admin panel. Each user provides minimal data fields - **First Name**, **Last Name**, **Email** and **Password**. The Name can represent either the person's first name or their full name, making the Last Name field optional, depending on the complexity of your site.\n\nBelow the **Email** field is an checkbox to block all outgoing mail sent to the user. This is a useful feature for accounts with an email address that is bouncing mail or has reported spam. When checked, no mail will ever be sent to this address, except for the mail template used for resetting the password.\n\n## Plugin Settings\n\nThis plugin creates a Settings menu item, found by navigating to **Settings \u003e Users \u003e User Settings**. This page allows the setting of common features, described in more detail below.\n\n#### Sign In\n\nBy default a User will sign in to the site using their email address as a unique identifier. You may use a unique login name instead by changing the **Login Attribute** value to Username. This will introduce a new field called **Username** for each user, allowing them to specify their own short name or alias for identification. Both the Email address and Username must be unique to the user.\n\nAs a security precaution, you may restrict users from having sessions across multiple devices at the same time. Enable the **Prevent Concurrent Sessions** setting to use this feature. When a user signs in to their account, it will automatically sign out the user for all other sessions.\n\n#### Registration\n\nRegistration to the site is allowed by default. If you are running a closed site, or need to temporarily disable registration, you may disable this feature by switching **Allow user registration** to the OFF setting.\n\n#### Notifications\n\nWhen a user is first activated, they can be sent a welcome email. To activate the welcome email, select \"Notify User\" and an email template from the **User Message Template** dropdown. The default message template used is `user:welcome_email` and you can customize this by selecting **Mail \u003e Mail Templates** from the settings menu.\n\nThe same applies for notifying the system administrators when a new user joins, with the \"Notify Administrators\" checkbox. The administrators to notify are selected using **Notify Admin Group** dropdown.\n\n## Documentation\n\n### Getting Started\n\n- [Introduction](./docs/introduction.md)\n- [Events](./docs/events.md)\n\n### Components\n\n- [Session](./docs/component-session.md)\n- [Account](./docs/component-account.md)\n- [Authentication](./docs/component-authentication.md)\n- [Registration](./docs/component-registration.md)\n- [Reset Password](./docs/component-reset-password.md)\n\n### Services\n\n- [Auth Manager](./docs/auth-manager.md)\n- [Impersonation](./docs/auth-impersonation.md)\n- [Bearer Tokens](./docs/auth-bearer-tokens.md)\n\n### License\n\nThis plugin is an official extension of the October CMS platform and is free to use if you have a platform license. See [EULA license](LICENSE.md) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frainlab%2Fuser-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frainlab%2Fuser-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frainlab%2Fuser-plugin/lists"}