Skip to content

Commit

Permalink
Update docs and migration guide
Browse files Browse the repository at this point in the history
Signed-off-by: Björn Svensson <[email protected]>
  • Loading branch information
bjosv committed Sep 25, 2024
1 parent bfcd0f9 commit 2c8247a
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 7 deletions.
1 change: 0 additions & 1 deletion .github/wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@ Sanfilippo
SHA
sharding
SONAME
SSL
struct
structs
stunnel
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
2 changes: 2 additions & 0 deletions docs/migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 5 additions & 5 deletions docs/standalone.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.

0 comments on commit 2c8247a

Please sign in to comment.