Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Merge pull request #497 from chakrit/master

README for unix domain socket connection.
  • Loading branch information...
commit 7bb015a08072a0b19725d3913afef20ca6491e17 2 parents ebf4635 + 8c394c1
@brycebaril brycebaril authored
Showing with 19 additions and 0 deletions.
  1. +19 −0 README.md
View
19 README.md
@@ -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
Please sign in to comment.
Something went wrong with that request. Please try again.