diff --git a/docs/installation.md b/docs/installation.md index 548d8b757f05a35c36b0a59553c82b1e152a45e1..2aaa3f5af036d862cd9706541f21294173d8fc3f 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,29 +1,17 @@ -1. [Get the requirements](#requirements). -2. [Download the plugin](#downloading). -3. [Install the plugin](#installing). -4. [Configure the plugin](#configuring) - -## Requirements You obviously need to have [Moodle](https://moodle.org/) installed first and you need to be logged in as an Admin. -## Downloading -#### Downloading via Zip (for users) -1. [Download the plugin](https://github.com/jlowe64/moodle-logstore-xapi/blob/master/xapi.zip?raw=true). -2. Go to "http://www.example.com/admin/tool/installaddon/index.php". -3. Drag and drop your download. -4. Click "Install the plugin from the ZIP file". - -#### Downloading via Git (for developers) -1. Run `cd admin/tool/log/store/` from the root directory of Moodle. -2. Run `git clone git@github.com:jlowe64/moodle-logstore-xapi.git xapi`. - -## Installing -1. Go to "http://www.example.com/admin/index.php". -2. Follow through the upgrade and enter your LRS details when required. -3. Go to "http://www.example.com/admin/settings.php?section=managelogging". -4. Enable the "Logstore xAPI" plugin. +1. [Download the plugin](../xapi.zip?raw=true). +2. Go to "http://www.example.com/admin/tool/installaddon/index.php" (replacing “www.example.com†with your own domain). +3. Drag and drop your download from step 1. +4. Click "Install plugin from the ZIP file". +5. Click “Install plugin!â€. +6. Click “Upgrade Moodle database nowâ€. +7. Click “Continueâ€. +8. Set your “endpoint†to your LRS endpoint (e.g. “http://demo.learninglocker.net/data/xAPIâ€). +9. Set your “username†to your LRS basic auth username (e.g. “d416e6220812740d3922eb09813ebb4163e8eb3eâ€). +10. Set your “password†to your LRS basic auth password (e.g. “bc7e0a2edd5d1969b6d774e679d4eb4e7a35be13â€). +11. Click “Save changesâ€. +12. Go to "http://www.example.com/admin/settings.php?section=managelogging" (replacing “www.example.com†with your own domain). +13. Enable the "logstore_xapi" plugin. -## Configuring -1. Go to "http://www.example.com/admin/settings.php?section=logsettingxapi". -2. Modify your LRS details. -3. Click "Save changes". +*Note that the above example LRS endpoint, username, and password utilise the [demo LRS](http://demo.learninglocker.net/) provided by [Learning Locker](http://learninglocker.net/). If you're utilising the demo LRS, you can login to the website with the email “demouser@learninglocker.net†and the password “demouserâ€. Once logged in, you can view statements on the ["Statements" page for the "Demo" LRS](http://demo.learninglocker.net/lrs/554a45e98fbdd7cd406c171e/statements).*