# `Phoenix.PubSub.Redis`
[🔗](https://github.com/phoenixframework/phoenix_pubsub_redis/blob/v3.1.1/lib/phoenix_pubsub_redis/redis.ex#L1)

Phoenix PubSub adapter based on Redis.

To start it, list it in your supervision tree as:

    {Phoenix.PubSub,
     adapter: Phoenix.PubSub.Redis,
     redis_opts: "redis://localhost:6379",
     node_name: System.get_env("NODE")}

## Options

  * `:name` - The required name to register the PubSub processes, e.g. `MyApp.PubSub`.
  * `:node_name` - The name of the node, used to filter out messages broadcast by the same node. Defaults to `node()`. Must be unique.
  * `:redis_pool_size` - The size of the Redis connection pool. Defaults to `5`.
  * `:compression_level` - Compression level applied to serialized terms - `0` (none) to `9` (highest). Defaults to `0`.
  * `:redis_opts` - Redix connection options - either a Redis URL string or a keyword list. See `Redix.start_link/1` for more information.

# `child_spec`

Returns a specification to start this module under a supervisor.

See `Supervisor`.

---

*Consult [api-reference.md](api-reference.md) for complete listing*