From 812448339ee4c53ab3d9cff169e64b05c28be15e Mon Sep 17 00:00:00 2001 From: Valentin Popov Date: Fri, 15 Dec 2017 11:40:07 +0400 Subject: Added user manual --- docs/getting-started.md | 23 +++++++++++++++++++++++ docs/screenshots/manageauths.jpg | Bin 0 -> 198023 bytes 2 files changed, 23 insertions(+) create mode 100644 docs/screenshots/manageauths.jpg diff --git a/docs/getting-started.md b/docs/getting-started.md index 17b82d5..f74949d 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -29,3 +29,26 @@ cd ./moodle-auth_token ``` ## User's Manual + +An authentication plug-in is a method of handling user authentication to Moodle when users log into your site. +You can have one or more methods as the same time enabled on your site, but each user can only use one method of authentication at a time. + +You must enable and configure the method, as you need for your users in `Site administration` > `Plugins` > `Authentication` > `Manage authentication`. +Note that the order of processing on this page does matter and after `manual` and `nologin`, you should next put the method that most users will have. + +![Manage authentication](screenshots/manageauths.jpg) + +The authentication plug-in has no configuration. +This means that the third-party plug-in is responsible for setting the keys. + +**Note**: +Users will not receive any error or other message when they try to log in but it simply will not allow them in. + +To authenticate a user, create a link for it: + +```Text +/login/index.php?token=secret +``` + +The authentication plug-in does not add graphical forms to the user. +This means that custom forms are created by developers for a particular task. \ No newline at end of file diff --git a/docs/screenshots/manageauths.jpg b/docs/screenshots/manageauths.jpg new file mode 100644 index 0000000..d380b5c Binary files /dev/null and b/docs/screenshots/manageauths.jpg differ -- cgit v1.2.3