Skip to content

Commit

Permalink
README for unix domain socket connection.
Browse files Browse the repository at this point in the history
  • Loading branch information
Chakrit Wichian committed Oct 11, 2013
1 parent ebf4635 commit 8c394c1
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Expand Up @@ -231,6 +231,25 @@ limits total amount of reconnects.

`createClient()` returns a `RedisClient` object that is named `client` in all of the examples here.

### Unix Domain Socket

You can also create a connection to Redis server via the unix domain socket if the server
has it enabled:

```js
var redis = require("redis");
var client = redis.createClient("/tmp/redis.sock");
```

Sample `redis.conf` configuration to enable unix domain socket listening:

```conf
unixsocket /tmp/redis.sock
unixsocketperm 755
```

See [issue #204](https://github.com/mranney/node_redis/issues/204) for more information.

## client.auth(password, callback)

When connecting to Redis servers that require authentication, the `AUTH` command must be sent as the
Expand Down

0 comments on commit 8c394c1

Please sign in to comment.