Skip to content

Commit 8c44e69

Browse files
author
Mr Bot
committed
Automatic merge from release/3.9+2 -> master
* commit 'f2192cf7adaf0c196f57a5fca1288b2a7fec0f57': INT-16836: Create or update Readme files for Open LMS plugins
2 parents f4d5904 + 3675627 commit 8c44e69

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
1-
# Redis lock
1+
# Redis lock Local plugin
2+
Provides a Moodle lock factory class for locking with Redis.
23

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.
57

68
## Requirements
79
* Moodle 2.9 or greater
810
* Redis
911
* PHP Redis extension
1012

1113
## 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+
1316
Set:
1417
* `$CFG->local_redislock_redis_server` with your Redis server's connection string.
1518
- It can be the `hostname` or IP address of the Redis server.
@@ -18,9 +21,23 @@ Set:
1821
* `$CFG->local_redislock_auth` with your Redis server's password string.
1922

2023
## Flags
21-
2224
* Logging is only available in the CLI environment with debugging enabled on `DEBUG_NORMAL` level at least.
2325
Use the boolean flag `$CFG->local_redislock_logging` to control whether verbose
2426
logging should be emitted. If not set, logging is automatically-enabled.
2527
* Use the boolean flag `$CFG->local_redislock_disable_shared_connection` to force creation
2628
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

Comments
 (0)