Updated README and render it in plugin config

This commit is contained in:
Andy Miller
2018-05-09 20:02:55 -06:00
parent 8c247788ed
commit 3b66acc72a
2 changed files with 178 additions and 156 deletions

View File

@@ -2,7 +2,7 @@
The **Login LDAP** Plugin for [Grav CMS](http://github.com/getgrav/grav) allows user authentication against an LDAP Server. The **Login LDAP** Plugin for [Grav CMS](http://github.com/getgrav/grav) allows user authentication against an LDAP Server.
## Installation ### Installation
Installing the Login LDAP plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file. Installing the Login LDAP plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.
@@ -91,7 +91,7 @@ default_access_levels:
> Note that if you use the admin plugin, a file with your configuration will be saved in the `user/config/plugins/login-ldap.yaml`. > Note that if you use the admin plugin, a file with your configuration will be saved in the `user/config/plugins/login-ldap.yaml`.
## Usage ### Usage
Once properly configured, the functionality of the LDAP plugin is transparent to the user. A user will be able to login via the normal login process and have access based on their account setup. Once properly configured, the functionality of the LDAP plugin is transparent to the user. A user will be able to login via the normal login process and have access based on their account setup.

View File

@@ -29,6 +29,16 @@ form:
validate: validate:
type: bool type: bool
ldap_tabs:
type: tabs
fields:
tab_1:
type: tab
title: Configuration Options
fields:
server_section: server_section:
type: section type: section
title: Server Configuration title: Server Configuration
@@ -205,3 +215,15 @@ form:
validate: validate:
type: array type: array
required: true required: true
tab_2:
type: tab
title: Instructions
fields:
ldap_instructions:
type: display
markdown: true
style: vertical
file: 'plugins://login-ldap/README.md'