Skip to content

Commit 64693ca

Browse files
authored
Merge pull request #40 from catalyst/minor_readme_fix_310
minor readme fix on 310
2 parents a7e6e35 + 55f8d7b commit 64693ca

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@
66
* [Branches](#branches)
77
* [Installation](#installation)
88
* [Logging out](#logging-out)
9-
* [Feedback and issues](#feedback-and-issues)
9+
* [Curl example](#curl-example)
1010
* [Master password feature](#master-password-feature)
11+
* [Feedback and issues](#feedback-and-issues)
1112

1213
What is this?
1314
========================
@@ -16,13 +17,13 @@ This is a moodle plugin which enables you to authenticate via HTTP basic auth.
1617

1718
This is more for development and backend purposes and allows easier testing with tools such as webpage test, page speed, link checkers etc which often can use basic auth out of the box, but you don't want to attempt to customize them in order to handle moodle specific authentication, or try to, where Moodle API access is inappropriate.
1819

19-
You would almost never want to use this for real human users as basic auth is a fairly terrible user expereince. It is designed to work side by side with your real moodle authentication but doesn't impact on normal authentication.
20+
You would almost never want to use this for real human users as basic auth is a fairly terrible user experience. It is designed to work side by side with your real moodle authentication but doesn't impact on normal authentication.
2021

2122
Even in production this has value for use cases such as performance regression testing using a real user and a real page which does a full bootstrap.
2223

2324
Unlike the core 'no authentication' plugin, this still requires real users and does proper password checks. It can be set to ignore the auth type against the account, eg manual, ldap, smtp so can be used side by side with other auth plugins, as long as those plugins store or cache the password, ie prevent_local_passwords() returns false for those plugins. So it can only be used with existing accounts and doesn't create accounts.
2425

25-
There is a bonus features which is a 'master password' mode. This is defintely not for production use and you have to jump through some tiny hoops to turn it on so it can't be used accidentally. But when it's set up it enables you to not only log in as anyone with the same password, but also to randomly select who to log in as well. This makes it trivial to run things like simple 1-liner load tests using Apache Bench. See below for details.
26+
There is a bonus features which is a 'master password' mode. This is definitely not for production use and you have to jump through some tiny hoops to turn it on so it can't be used accidentally. But when it's set up it enables you to not only log in as anyone with the same password, but also to randomly select who to log in as well. This makes it trivial to run things like simple 1-liner load tests using Apache Bench. See below for details.
2627

2728

2829
From a security perspective this auth plugin is exactly as secure as the manual auth plugin, so this should only be used in conjuntion with https.
@@ -43,8 +44,9 @@ Installation
4344
1. Install the plugin the same as any standard moodle plugin either via the
4445
Moodle plugin directory, or you can use git to clone it into your source:
4546

46-
git clone [email protected]:catalyst/moodle-auth_basic.git auth/basic
47-
47+
```php
48+
git clone [email protected]:catalyst/moodle-auth_basic.git auth/basic
49+
```
4850
Or install via the Moodle plugin directory:
4951

5052
https://moodle.org/plugins/auth_basic
@@ -132,4 +134,4 @@ Please raise any issues in github:
132134

133135
https://github.com/catalyst/moodle-auth_basic/issues
134136

135-
If you need anything urgently and would like to sponsor it's implemenation please email me: Brendan Heywood [email protected]
137+
If you need anything urgently and would like to sponsor its implementation please email me: Brendan Heywood [email protected]

0 commit comments

Comments
 (0)