|
1 | | -# Redis lock |
| 1 | +# Redis lock Local plugin |
| 2 | +Provides a Moodle lock factory class for locking with Redis. |
2 | 3 |
|
3 | | -## About |
4 | | -Provides a Moodle lock factory class for locking with Redis. This plugin was contributed by the Open LMS Product Development team. Open LMS is an education technology company dedicated to bringing excellent online teaching to institutions across the globe. We serve colleges and universities, schools and organizations by supporting the software that educators use to manage and deliver instructional content to learners in virtual classrooms. |
| 4 | +This plugin was contributed by the Open LMS Product Development team. |
| 5 | +Open LMS is an education technology company dedicated to bringing excellent online teaching to institutions across the globe. |
| 6 | +We serve colleges and universities, schools and organizations by supporting the software that educators use to manage and deliver instructional content to learners in virtual classrooms. |
5 | 7 |
|
6 | 8 | ## Requirements |
7 | 9 | * Moodle 2.9 or greater |
8 | 10 | * Redis |
9 | 11 | * PHP Redis extension |
10 | 12 |
|
11 | 13 | ## Installation |
12 | | -Clone the repository or download and extract the code into the local directory of your Moodle install (e.g. $CFG->wwwroot/local/redislock) and run the site's upgrade script. |
| 14 | +Extract the contents of the plugin into _/wwwroot/local_ then visit `admin/upgrade.php` or use the CLI script to upgrade your site. |
| 15 | + |
13 | 16 | Set: |
14 | 17 | * `$CFG->local_redislock_redis_server` with your Redis server's connection string. |
15 | 18 | - It can be the `hostname` or IP address of the Redis server. |
|
18 | 21 | * `$CFG->local_redislock_auth` with your Redis server's password string. |
19 | 22 |
|
20 | 23 | ## Flags |
21 | | - |
22 | 24 | * Logging is only available in the CLI environment with debugging enabled on `DEBUG_NORMAL` level at least. |
23 | 25 | Use the boolean flag `$CFG->local_redislock_logging` to control whether verbose |
24 | 26 | logging should be emitted. If not set, logging is automatically-enabled. |
25 | 27 | * Use the boolean flag `$CFG->local_redislock_disable_shared_connection` to force creation |
26 | 28 | of the redis connection for each factory instance. |
| 29 | + |
| 30 | +## License |
| 31 | +Copyright (c) 2021 Open LMS (https://www.openlms.net) |
| 32 | + |
| 33 | +This program is free software: you can redistribute it and/or modify it under |
| 34 | +the terms of the GNU General Public License as published by the Free Software |
| 35 | +Foundation, either version 3 of the License, or (at your option) any later |
| 36 | +version. |
| 37 | + |
| 38 | +This program is distributed in the hope that it will be useful, but WITHOUT ANY |
| 39 | +WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A |
| 40 | +PARTICULAR PURPOSE. See the GNU General Public License for more details. |
| 41 | + |
| 42 | +You should have received a copy of the GNU General Public License along with |
| 43 | +this program. If not, see <http://www.gnu.org/licenses/>. |
0 commit comments