From 2c8247abaf72fbeae9e46d2f7859a08cc3003acf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Svensson?= Date: Wed, 25 Sep 2024 14:28:34 +0200 Subject: [PATCH] Update docs and migration guide MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Björn Svensson --- .github/wordlist.txt | 1 - README.md | 2 +- docs/migration-guide.md | 2 ++ docs/standalone.md | 10 +++++----- 4 files changed, 8 insertions(+), 7 deletions(-) diff --git a/.github/wordlist.txt b/.github/wordlist.txt index e9182855..c62a2332 100644 --- a/.github/wordlist.txt +++ b/.github/wordlist.txt @@ -86,7 +86,6 @@ Sanfilippo SHA sharding SONAME -SSL struct structs stunnel diff --git a/README.md b/README.md index ba3d2301..f9d49407 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Libvalkey is the official C client for the [Valkey](https://valkey.io) database. - Commands are executed in a generic way, with printf-like invocation. - Supports both `RESP2` and `RESP3` protocol versions. - Supports both synchronous and asynchronous operation. -- Optional support for `SSL` and `RDMA` connections. +- Optional support for `TLS` and `RDMA` connections. - Asynchronous API with several event libraries to choose from. - Supports both standalone and cluster mode operation. - Can be compiled with either `make` or `CMake`. diff --git a/docs/migration-guide.md b/docs/migration-guide.md index 25e61833..748d76e9 100644 --- a/docs/migration-guide.md +++ b/docs/migration-guide.md @@ -6,8 +6,10 @@ This guide highlights which APIs that have changed and what you need to do when The general actions needed are: * Replace the prefix `redis` with `valkey` in API usages. +* Replace the term `SSL` with `TLS` in API usages for secure communication. * Update include paths depending on your previous installation. All `libvalkey` headers are now found under `include/valkey/`. +* Update used build options, e.g. `USE_TLS` replaces `USE_SSL`. ## Migrating from `hiredis` v1.2.0 diff --git a/docs/standalone.md b/docs/standalone.md index bf73cffe..c6e87b8c 100644 --- a/docs/standalone.md +++ b/docs/standalone.md @@ -23,7 +23,7 @@ This document describes using `libvalkey` in standalone (non-cluster) mode, incl - [Connecting](#connecting-1) - [Executing commands](#executing-commands-1) - [Disconnecting/cleanup](#disconnecting-cleanup-1) -- [SSL/TLS support](#ssl-tls-support) +- [TLS support](#tls-support) ## Synchronous API @@ -367,9 +367,9 @@ To terminate the connection forcefully use `valkeyAsyncFree` which also will blo There will be no more data sent on the socket and all pending callbacks will be called with a `NULL` reply. After this, the disconnection callback is called with the `VALKEY_OK` status, and the context object is freed. -## SSL/TLS support +## TLS support -SSL/TLS support is not enabled by default and requires an explicit build flag as described in [`README.md`](../README.md#building). +TLS support is not enabled by default and requires an explicit build flag as described in [`README.md`](../README.md#building). -Libvalkey implements SSL/TLS on top of its `valkeyContext` and `valkeyAsyncContext`, so you will need to establish a connection first and then initiate an SSL/TLS handshake. -See the [examples](../examples) directory for how to create the SSL/TLS context and initiate the handshake. +Libvalkey implements TLS on top of its `valkeyContext` and `valkeyAsyncContext`, so you will need to establish a connection first and then initiate a TLS handshake. +See the [examples](../examples) directory for how to create the TLS context and initiate the handshake.