Skip to content

Commit cc6af5b

Browse files
authored
Merge pull request redis-rs#382 from gferon/explain-tls-feature-readme
Explain TLS feature in README
2 parents c6df3e0 + 5c8d4c2 commit cc6af5b

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,31 @@ fn fetch_an_integer() -> redis::RedisResult<isize> {
4747
}
4848
```
4949

50+
## TLS Support
51+
52+
To enable TLS support, you need to use the relevant feature entry in your Cargo.toml.
53+
54+
```
55+
redis = { version = "0.17.0", default-features = false, features = ["tls"] }
56+
57+
# if you use tokio
58+
redis = { version = "0.17.0", default-features = false, features = ["tls", "tokio-tls-comp"] }
59+
60+
# if you use async-std
61+
redis = { version = "0.17.0", default-features = false, features = ["tls", "async-std-tls-comp"] }
62+
```
63+
64+
then you should be able to connect to a redis instance using the `redis://` URL scheme:
65+
66+
```rust
67+
let client = redis::Client::open("rediss://127.0.0.1/")?;
68+
```
69+
5070
## Cluster Support
5171

5272
Cluster mode can be used by specifying "cluster" as a features entry in your Cargo.toml.
5373

54-
`redis = { version = "0.16.0", features = [ "cluster"] }`
74+
`redis = { version = "0.17.0", features = [ "cluster"] }`
5575

5676
Then you can simply use the `ClusterClient` which accepts a list of available nodes.
5777

0 commit comments

Comments
 (0)