summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYossi Gottlieb <yossigo@gmail.com>2020-02-05 21:13:21 +0200
committerYossi Gottlieb <yossigo@gmail.com>2020-02-05 21:19:03 +0200
commitbb3d45a38683fc97c0b9b06ff7725fa1eca5d80c (patch)
tree5da178d1c1c06debbdcbfaa9c9b3c92016032bb3 /README.md
parentedfe1b2f8b6ff2c93c5a1db007ea033dd710d98a (diff)
downloadredis-bb3d45a38683fc97c0b9b06ff7725fa1eca5d80c.tar.gz
TLS: Update documentation.
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3442659e6..c08013416 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,11 @@ It is as simple as:
% make
+To build with TLS support, you'll need OpenSSL development libraries (e.g.
+libssl-dev on Debian/Ubuntu) and run:
+
+ % make BUILD_TLS=yes
+
You can run a 32 bit Redis binary using:
% make 32bit
@@ -43,6 +48,13 @@ After building Redis, it is a good idea to test it using:
% make test
+If TLS is built, running the tests with TLS enabled (you will need `tcl-tls`
+installed):
+
+ % ./utils/gen-test-certs.sh
+ % ./runtest --tls
+
+
Fixing build problems with dependencies or cached build options
---------
@@ -125,6 +137,12 @@ as options using the command line. Examples:
All the options in redis.conf are also supported as options using the command
line, with exactly the same name.
+Running Redis with TLS:
+------------------
+
+Please consult the [TLS.md](TLS.md) file for more information on
+how to use Redis with TLS.
+
Playing with Redis
------------------