Skip to content

Commit 853b4fd

Browse files
yossigojschmieg
authored andcommitted
TLS: Update documentation.
1 parent 927e7b1 commit 853b4fd

File tree

2 files changed

+32
-31
lines changed

2 files changed

+32
-31
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ It is as simple as:
3535

3636
% make
3737

38+
To build with TLS support, you'll need OpenSSL development libraries (e.g.
39+
libssl-dev on Debian/Ubuntu) and run:
40+
41+
% make BUILD_TLS=yes
42+
3843
You can run a 32 bit Redis binary using:
3944

4045
% make 32bit
@@ -43,6 +48,13 @@ After building Redis, it is a good idea to test it using:
4348

4449
% make test
4550

51+
If TLS is built, running the tests with TLS enabled (you will need `tcl-tls`
52+
installed):
53+
54+
% ./utils/gen-test-certs.sh
55+
% ./runtest --tls
56+
57+
4658
Fixing build problems with dependencies or cached build options
4759
---------
4860

@@ -129,6 +141,12 @@ as options using the command line. Examples:
129141
All the options in redis.conf are also supported as options using the command
130142
line, with exactly the same name.
131143

144+
Running Redis with TLS:
145+
------------------
146+
147+
Please consult the [TLS.md](TLS.md) file for more information on
148+
how to use Redis with TLS.
149+
132150
Playing with Redis
133151
------------------
134152

TLS.md

+14-31
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
1-
TLS Support -- Work In Progress
2-
===============================
3-
4-
This is a brief note to capture current thoughts/ideas and track pending action
5-
items.
1+
TLS Support
2+
===========
63

74
Getting Started
85
---------------
@@ -69,37 +66,23 @@ probably not be so hard. For cluster keys migration it might be more difficult,
6966
but there are probably other good reasons to improve that part anyway.
7067

7168
To-Do List
72-
==========
73-
74-
Additional TLS Features
75-
-----------------------
76-
77-
1. Add metrics to INFO?
78-
2. Add session caching support. Check if/how it's handled by clients to assess
79-
how useful/important it is.
80-
81-
redis-benchmark
82-
---------------
83-
84-
The current implementation is a mix of using hiredis for parsing and basic
85-
networking (establishing connections), but directly manipulating sockets for
86-
most actions.
87-
88-
This will need to be cleaned up for proper TLS support. The best approach is
89-
probably to migrate to hiredis async mode.
90-
91-
redis-cli
92-
---------
69+
----------
9370

94-
1. Add support for TLS in --slave and --rdb modes.
71+
- [ ] Add session caching support. Check if/how it's handled by clients to
72+
assess how useful/important it is.
73+
- [ ] redis-benchmark support. The current implementation is a mix of using
74+
hiredis for parsing and basic networking (establishing connections), but
75+
directly manipulating sockets for most actions. This will need to be cleaned
76+
up for proper TLS support. The best approach is probably to migrate to hiredis
77+
async mode.
78+
- [ ] redis-cli `--slave` and `--rdb` support.
9579

96-
Others
97-
------
80+
Multi-port
81+
----------
9882

9983
Consider the implications of allowing TLS to be configured on a separate port,
100-
making Redis listening on multiple ports.
84+
making Redis listening on multiple ports:
10185

102-
This impacts many things, like
10386
1. Startup banner port notification
10487
2. Proctitle
10588
3. How slaves announce themselves

0 commit comments

Comments
 (0)