Simplesamlphp Login Plugin
Installing the SimpleSAMLphp-Login plugin can be done in one of three ways: The GPM (Grav Package Manager) installation method lets you quickly install the plugin with a simple terminal command, the manual method lets you do so via a zip file, and the admin method lets you do so via the Admin plugin.
GPM Installation (Preferred)
To install the plugin via the GPM, through your system's terminal (also called the command line), navigate to the root of your Grav-installation, and enter:
bin/gpm install simplesamlphp-login
This will install the SimpleSAMLphp-Login plugin into your
/user/plugins-directory within Grav CMS. Its files can be found under
To install the plugin manually, download the zip-version of this repository and unzip it under
/your/site/grav/user/plugins. Then rename the folder to
simplesamlphp-login. You can find these files on GitHub or via GetGrav.org.
You should now have all the plugin files under
You can install the plugin directly by browsing the
Plugins menu and clicking on the
Here is the default configuration and an explanation of available options:
enabled: false - Plugin is disabled by default to allow configuration saml_autoloader_path: - Full system path to the SimpleSAMLphp autoloader file saml_auth_source: - SimpleSAMLphp Auth source saml_permissions_attribute: - The attribute returned in the SAML response used for assigning permissions permission_login: - The string contained in the attribute SAML returns to allow site login (mainly used when protecting the whole site) permission_edit: - The string contained in the attribute SAML returns to allow editing permission_admin: - The string contained in the attribute SAML returns to allow administrators permission_redirect: - The URL to redirect to if user isn't allowed to login (used when protecting the whole site) save_user: false - Allowed users who login to be saved to the /users/accounts directory full_site: false - Protects the whole Grav site not just the Admin plugin
Note that if you configure this plugin with the Admin plugin, a file with your configuration named simplesamlphp-login.yaml will be saved in the
user/config/plugins/ folder once the configuration is saved in the Admin.
Note that if you configure this plugin manually, you should copy the
user/config/plugins/simplesamlphp-login.yaml and only edit that copy.
This plugin SimpleSAMLphp-Login heavily relies on the SimpleSAMLphp library.
This is also an extension of the Login plugin.
Please report issues relating to the SimpleSAMLphp-Login plugin on the Github issue tracker. Please report issues relating to SimpleSAMLphp on their Github issue tracker. (I have no association to the SimpleSAMLphp project.