Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phoenixframework/phoenix_pubsub_redis
The Redis PubSub adapter for the Phoenix framework
https://github.com/phoenixframework/phoenix_pubsub_redis
Last synced: 8 days ago
JSON representation
The Redis PubSub adapter for the Phoenix framework
- Host: GitHub
- URL: https://github.com/phoenixframework/phoenix_pubsub_redis
- Owner: phoenixframework
- Created: 2015-05-21T03:00:32.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-03-20T15:04:43.000Z (8 months ago)
- Last Synced: 2024-09-01T02:38:40.414Z (2 months ago)
- Language: Elixir
- Size: 93.8 KB
- Stars: 175
- Watchers: 13
- Forks: 66
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - The Redis PubSub adapter for the Phoenix framework. (Framework Components)
- fucking-awesome-elixir - phoenix_pubsub_redis - The Redis PubSub adapter for the Phoenix framework. (Framework Components)
- awesome-elixir - phoenix_pubsub_redis - The Redis PubSub adapter for the Phoenix framework. (Framework Components)
README
## Phoenix.PubSub.Redis
> A Redis PubSub adapter for the Phoenix framework
See the [docs](https://hexdocs.pm/phoenix_pubsub_redis/) for more information.
## Usage
To use Redis as your PubSub adapter, simply add it to your deps and Application's Supervisor tree:
```elixir
# mix.exs
defp deps do
[{:phoenix_pubsub_redis, "~> 3.0.0"}],
end
# application.ex
children = [
# ...,
{Phoenix.PubSub,
adapter: Phoenix.PubSub.Redis,
host: "192.168.1.100",
node_name: System.get_env("NODE")}
```
Config Options
Option | Description | Default |
:-----------------------| :------------------------------------------------------------------------ | :------------- |
`:name` | The required name to register the PubSub processes, ie: `MyApp.PubSub` | |
`:node_name` | The required and unique name of the node, ie: `System.get_env("NODE")` | |
`:url` | The redis-server URL, ie: `redis://username:password@host:port` | |
`:host` | The redis-server host IP | `"127.0.0.1"` |
`:port` | The redis-server port | `6379` |
`:password` | The redis-server password | `""` |
`:compression_level` | Compression level applied to serialized terms (`0` - none, `9` - highest) | `0` |
`:socket_opts` | The redis-server network layer options | `[]` |
And also add `:phoenix_pubsub_redis` to your list of applications:
```elixir
# mix.exs
def application do
[mod: {MyApp, []},
applications: [..., :phoenix, :phoenix_pubsub_redis]]
end
```
## License
Copyright (c) 2014 Chris McCord
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.