From f689df3e689b03a1fc8a4b32a513af0ff67e28ac Mon Sep 17 00:00:00 2001
From: Miguel Dantas <biodantasgs@gmail.com>
Date: Wed, 14 Aug 2019 15:20:52 +0100
Subject: [PATCH] [RedisCache] Added README with configuration instructions

---
 plugins/RedisCache/README | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 plugins/RedisCache/README

diff --git a/plugins/RedisCache/README b/plugins/RedisCache/README
new file mode 100644
index 0000000000..793f3555db
--- /dev/null
+++ b/plugins/RedisCache/README
@@ -0,0 +1,33 @@
+Redis cache for GNU social
+
+Installation
+============
+
+Tell your `config.php` to use this plugin (replace `tcp://localhost:6379` with the address/port
+of your Redis backend server):
+
+addPlugin('RedisCache', ['server' => 'tcp://localhost:6379']);
+
+Settings
+========
+
+servers: Array of Redis servers addresses. A semicolon (`;`) should be used to separate
+the address from the port, to allow for IPv6 addresses
+
+defaultExpiry: How long before cache expires (in seconds)
+
+Example
+=======
+
+```
+    addPlugin('RedisCache', [ 'server' => 'tcp://localhost:6379',
+                              'defaultExpiry' => 86400 // 24h
+                            ]);
+```
+
+You can also use a unix socket instead of a tcp connection:
+
+```
+    addPlugin('RedisCache', ['server' => 'unix:/var/run/redis/redis.sock']);
+```
+