From 7069fcc695e6c4fa550b15fcfbc030a1d3fd7f02 Mon Sep 17 00:00:00 2001 From: John Sully Date: Sat, 29 May 2021 07:08:01 +0000 Subject: [PATCH] Fix branding Former-commit-id: b20803b7669b10804fb0f355e302898ddaa19906 --- TLS.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/TLS.md b/TLS.md index 1afa2e8fa..6373ff871 100644 --- a/TLS.md +++ b/TLS.md @@ -13,13 +13,13 @@ Run `make BUILD_TLS=yes`. ### Tests -To run Redis test suite with TLS, you'll need TLS support for TCL (i.e. +To run KeyDB test suite with TLS, you'll need TLS support for TCL (i.e. `tcl-tls` package on Debian/Ubuntu). 1. Run `./utils/gen-test-certs.sh` to generate a root CA and a server certificate. -2. Run `./runtest --tls` or `./runtest-cluster --tls` to run Redis and Redis +2. Run `./runtest --tls` or `./runtest-cluster --tls` to run KeyDB and KeyDB Cluster tests in TLS mode. ### Running manually @@ -27,23 +27,23 @@ To run Redis test suite with TLS, you'll need TLS support for TCL (i.e. To manually run a Redis server with TLS mode (assuming `gen-test-certs.sh` was invoked so sample certificates/keys are available): - ./src/redis-server --tls-port 6379 --port 0 \ - --tls-cert-file ./tests/tls/redis.crt \ - --tls-key-file ./tests/tls/redis.key \ + ./src/keydb-server --tls-port 6379 --port 0 \ + --tls-cert-file ./tests/tls/keydb.crt \ + --tls-key-file ./tests/tls/keydb.key \ --tls-ca-cert-file ./tests/tls/ca.crt -To connect to this Redis server with `redis-cli`: +To connect to this Redis server with `keydb-cli`: - ./src/redis-cli --tls \ - --cert ./tests/tls/redis.crt \ - --key ./tests/tls/redis.key \ + ./src/keydb-cli --tls \ + --cert ./tests/tls/keydb.crt \ + --key ./tests/tls/keydb.key \ --cacert ./tests/tls/ca.crt This will disable TCP and enable TLS on port 6379. It's also possible to have both TCP and TLS available, but you'll need to assign different ports. To make a Replica connect to the master using TLS, use `--tls-replication yes`, -and to make Redis Cluster use TLS across nodes use `--tls-cluster yes`. +and to make KeyDB Cluster use TLS across nodes use `--tls-cluster yes`. Connections ----------- @@ -56,18 +56,18 @@ Note that unlike Redis, KeyDB fully supports multithreading of TLS connections. To-Do List ---------- -- [ ] redis-benchmark support. The current implementation is a mix of using +- [ ] keydb-benchmark support. The current implementation is a mix of using hiredis for parsing and basic networking (establishing connections), but directly manipulating sockets for most actions. This will need to be cleaned up for proper TLS support. The best approach is probably to migrate to hiredis async mode. -- [ ] redis-cli `--slave` and `--rdb` support. +- [ ] keydb-cli `--slave` and `--rdb` support. Multi-port ---------- Consider the implications of allowing TLS to be configured on a separate port, -making Redis listening on multiple ports: +making KeyDB listening on multiple ports: 1. Startup banner port notification 2. Proctitle