diff options
author | Michael Carroll <michael@carroll.io> | 2015-11-20 08:50:33 -0500 |
---|---|---|
committer | Michael Carroll <michael@carroll.io> | 2015-11-20 08:50:33 -0500 |
commit | e17b65e46b725d222032473dddbb308565790f45 (patch) | |
tree | a4503e50b832899caa423deafc0b6cdb69f356e4 | |
parent | 6be2604aa719713c602b8a873337d328196f8f57 (diff) | |
download | rails-e17b65e46b725d222032473dddbb308565790f45.tar.gz rails-e17b65e46b725d222032473dddbb308565790f45.tar.bz2 rails-e17b65e46b725d222032473dddbb308565790f45.zip |
Add README.md instructions on configuring ActionCable.server.config.allowed_request_origins
-rw-r--r-- | README.md | 27 |
1 files changed, 24 insertions, 3 deletions
@@ -274,8 +274,11 @@ See the [rails/actioncable-examples](http://github.com/rails/actioncable-example ## Configuration -The only must-configure part of Action Cable is the Redis connection. By default, `ActionCable::Server::Base` will look for a configuration -file in `Rails.root.join('config/redis/cable.yml')`. The file must follow the following format: +Action Cable has two required configurations: the Redis connection and specifying allowed request origins. + +### Redis + +By default, `ActionCable::Server::Base` will look for a configuration file in `Rails.root.join('config/redis/cable.yml')`. The file must follow the following format: ```yaml production: &production @@ -299,6 +302,24 @@ a Rails initializer with something like: ActionCable.server.config.redis_path = Rails.root('somewhere/else/cable.yml') ``` +### Allowed Request Origins + +Action Cable will only accepting requests from specified origins, which are passed to the server config as an array: + +```ruby +ActionCable.server.config.allowed_request_origins = %w( http://rubyonrails.com ) +``` + +To disable and allow requests from any origin: + +```ruby +ActionCable.server.config.disable_request_forgery_protection = true +``` + +By default, Action Cable allows all requests from localhost:3000 when running in the development environment. + +### Other Configurations + The other common option to configure is the log tags applied to the per-connection logger. Here's close to what we're using in Basecamp: ```ruby @@ -416,4 +437,4 @@ Action Cable is released under the MIT license: Bug reports can be filed for the alpha development project here: -* https://github.com/rails/actioncable/issues +* https://github.com/rails/actioncable/issues
\ No newline at end of file |