kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

Update ActionCable guide to better describe SubscriptionAdapter configuration.

Browse source
This commit is contained in:
Chad Ingram 2017-01-17 23:37:28 -05:00
parent 39c77eb184
commit f18d1e1e52
1 changed files with 22 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
guides/source/action_cable_overview.md
View file

@ -240,8 +240,8 @@ WebNotificationsChannel.broadcast_to(
```
The `WebNotificationsChannel.broadcast_to` call places a message in the current
subscription adapter (by default `redis` for production and `async` for development and
test environments)'s pubsub queue under a separate broadcasting name for each user.
subscription adapter (by default `redis` for production and `async` for development and
test environments)'s pubsub queue under a separate broadcasting name for each user.
For a user with an ID of 1, the broadcasting name would be `web_notifications:1`.
The channel has been instructed to stream everything that arrives at
@ -530,7 +530,7 @@ Action Cable has two required configurations: a subscription adapter and allowed
### Subscription Adapter
By default, Action Cable looks for a configuration file in `config/cable.yml`.
The file must specify an adapter and a URL for each Rails environment. See the
The file must specify an adapter for each Rails environment. See the
[Dependencies](#dependencies) section for additional information on adapters.
```yaml
@ -543,7 +543,26 @@ test:
production:
adapter: redis
url: redis://10.10.3.153:6381
channel_prefix: appname_production
```
#### Adapter Configuration
##### Async Adapter
The async adapter is intended for development/testing and should not be used in production.
##### Redis Adapter
The Redis & Evented Redis adapters require a url pointing to the Redis server. Additionally,
a channel_prefix may be provided to avoid channel name collisions when using the same Redis server.
server for multiple applications. See the [Redis PubSub documentation](https://redis.io/topics/pubsub#database-amp-scoping) for more details.
See the
[Dependencies](#dependencies) section for additional information on adapters.
##### PostgreSQL adapter
The postgres adapter will use the ActiveRecord connection pool for it's connection. This may change in the future. [#27214](https://github.com/rails/rails/issues/27214)
### Allowed Request Origins