|
3 | 3 | A Ruby client that tries to match [Redis][redis-home]' API one-to-one, while still
|
4 | 4 | providing an idiomatic interface.
|
5 | 5 |
|
| 6 | +See [RubyDoc.info][rubydoc] for the API docs of the latest published gem. |
6 | 7 |
|
7 | 8 | ## Getting started
|
8 | 9 |
|
@@ -34,6 +35,9 @@ You can also specify connection options as a [`redis://` URL][redis-url]:
|
34 | 35 | redis = Redis. new( url: "redis://:[email protected]:6380/15")
|
35 | 36 | ```
|
36 | 37 |
|
| 38 | +The client expects passwords with special chracters to be URL-encoded (i.e. |
| 39 | +`CGI.escape(password)`). |
| 40 | + |
37 | 41 | By default, the client will try to read the `REDIS_URL` environment variable
|
38 | 42 | and use that as URL to connect to. The above statement is therefore equivalent
|
39 | 43 | to setting this environment variable and calling `Redis.new` without arguments.
|
@@ -147,8 +151,8 @@ redis.mget('{key}1', '{key}2')
|
147 | 151 |
|
148 | 152 | ## Storing objects
|
149 | 153 |
|
150 |
| -Redis only stores strings as values. If you want to store an object, you |
151 |
| -can use a serialization mechanism such as JSON: |
| 154 | +Redis "string" types can be used to store serialized Ruby objects, for |
| 155 | +example with JSON: |
152 | 156 |
|
153 | 157 | ```ruby
|
154 | 158 | require "json"
|
@@ -322,7 +326,7 @@ This library supports natively terminating client side SSL/TLS connections
|
322 | 326 | when talking to Redis via a server-side proxy such as [stunnel], [hitch],
|
323 | 327 | or [ghostunnel].
|
324 | 328 |
|
325 |
| -To enable SSL support, pass the `:ssl => :true` option when configuring the |
| 329 | +To enable SSL support, pass the `:ssl => true` option when configuring the |
326 | 330 | Redis client, or pass in `:url => "rediss://..."` (like HTTPS for Redis).
|
327 | 331 | You will also need to pass in an `:ssl_params => { ... }` hash used to
|
328 | 332 | configure the `OpenSSL::SSL::SSLContext` object used for the connection:
|
|
0 commit comments