Browse Source

Adding a nice README

Brendan Abolivier 2 years ago
parent
commit
aa8a7d1d51
1 changed files with 34 additions and 0 deletions
  1. 34
    0
      README.md

+ 34
- 0
README.md View File

@@ -0,0 +1,34 @@
1
+# Macaroons authentication plugin for Moodle
2
+
3
+This plugin is part of a proof of concept on Macaroons I made [here](https://github.com/babolivier/das). It should be, however, totally usable.
4
+
5
+The PHP implementation of Macaroons used in this plugin (which includes everything in `Macaroons`) has been developped by [immense](https://github.com/immense/php-macaroons).
6
+
7
+## Install
8
+
9
+Drop all the files in this repository to the `auth` directory (at the root of your Moodle setup), in a directory named `macaroons`.
10
+
11
+In short, you can `cd` to Moodle's `auth` directory then run
12
+
13
+```bash
14
+git clone https://github.com/babolivier/moodle_macaroons macaroons
15
+```
16
+
17
+You may then need to rebuild Moodle's cache. To do so, run
18
+
19
+```bash
20
+php [your Moodle setup]/admin/cli/purge_caches.php
21
+```
22
+
23
+## Configuration
24
+
25
+You'll then see a "Macaroons" line popping in the authentication management page in Moodle's admin panel. If you're not much familiar with this page, please head over [here](https://docs.moodle.org/32/en/Managing_authentication#Setting_the_authentication_method.28s.29).
26
+
27
+Please give a look at the plugin's settings before using it. Mandatory settings are:
28
+
29
+* Cookie name
30
+* Secret
31
+* Identifier format
32
+* E-mail template
33
+
34
+All are described on the plugin's settings page.