README.md 1.96 KB
Newer Older
Francois Gannaz's avatar
Francois Gannaz committed
1
# LabNbook
Francois Gannaz's avatar
Francois Gannaz committed
2

Francois Gannaz's avatar
Francois Gannaz committed
3
This Moodle plugin provides access to LabNbook through a Moodle activity.
Francois Gannaz's avatar
Francois Gannaz committed
4

Francois Gannaz's avatar
Francois Gannaz committed
5 6 7 8
After installation, this plugin must be configured to exchange with a LabnBook instance.
Then the editing teacher will have access to a new activity type: "LabNbook".
The students that enter such an activity will work on the Labnbook site,
without the need to authenticate separately.
Francois Gannaz's avatar
Francois Gannaz committed
9 10


Francois Gannaz's avatar
Francois Gannaz committed
11 12
## Install

Francois Gannaz's avatar
Francois Gannaz committed
13 14 15
LabNbook must be installed separately.
You must have an *admin access to LabNbook*,
in order to create an institution that will be linked to this Moodle instance.
Francois Gannaz's avatar
Francois Gannaz committed
16 17

Install this module like any Moodle activity.
18
If deploying from Git, use [composer](https://getcomposer.org/download/) to install the PHP dependencies.
Francois Gannaz's avatar
Francois Gannaz committed
19 20 21 22

```
cd /path/to/moodle
git clone https://gricad-gitlab.univ-grenoble-alpes.fr/labnbook/moodle-labnbook mod/labnbook
23
(cd mod/labnbook && composer install --no-dev)
Francois Gannaz's avatar
Francois Gannaz committed
24 25 26
php admin/cli/upgrade.php
```

Francois Gannaz's avatar
Francois Gannaz committed
27 28
Then login into Moodle with an admin account.
You will be prompted for the new plugin configuration.
Francois Gannaz's avatar
Francois Gannaz committed
29
Input the URL of the LabNbook web API and other settings displayed in the LnB admin view.
Francois Gannaz's avatar
Francois Gannaz committed
30 31


32 33 34 35 36 37 38 39 40 41
## Upgrade

Like any Moodle plugin:

1. update the source code in `mod/labnbook/`
2. apply the migration,
   through CLI with `php admin/cli/upgrade.php`,
   or through web by connecting as as an admin on the "Administration" page.


Francois Gannaz's avatar
Francois Gannaz committed
42 43 44 45 46
## License

Copyright 2019 Université Grenoble Alpes

License GPLv3
Francois Gannaz's avatar
Francois Gannaz committed
47 48 49 50 51 52 53 54 55 56 57 58

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program.  If not, see <http://www.gnu.org/licenses/>.