https://github.com/anycable/capistrano-anycable
AnyCable integration for Capistrano
https://github.com/anycable/capistrano-anycable
anycable capistrano ruby
Last synced: 7 days ago
JSON representation
AnyCable integration for Capistrano
- Host: GitHub
- URL: https://github.com/anycable/capistrano-anycable
- Owner: anycable
- License: mit
- Created: 2019-02-06T17:29:19.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-16T14:40:52.000Z (about 5 years ago)
- Last Synced: 2025-04-14T05:39:06.431Z (19 days ago)
- Topics: anycable, capistrano, ruby
- Language: Ruby
- Size: 8.79 KB
- Stars: 7
- Watchers: 6
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://rubygems.org/gems/capistrano-anycable) [](https://travis-ci.org/anycable/capistrano-anycable)
[](https://docs.anycable.io/#capistrano)
# Capistrano::Anycable
AnyCable RPC server integration for Capistrano.
# Requirements
AnyCable >= 0.6.2
## Installation
Add those lines to your application's Gemfile:
```ruby
# To run daemonized `anycabled`
gem "daemons", "~> 1.3", require: false
gem "capistrano-anycable", group: :development
```
And then execute:
```
$ bundle
```
## Usage
```ruby
# Capfile
require "capistrano/anycable"
```
## Configuration
Available configuration options (with defaults):
```ruby
# Restart AnyCable RPC server after `deploy:restart` phase
set :anycable_default_hooks, true
# Capistrano roles to start AnyCable RPC server on
set :anycable_roles, :app
# Path to the root of your application
set :anycable_path, -> { release_path }
# Command to start AnyCable RPC server
set :anycable_command, -> { [:bundle, :exec, :anycabled] }
# Sets RAILS_ENV for AnyCable RPC server process
set :anycable_env, -> { fetch(:rack_env, fetch(:rails_env, fetch(:stage))) }
# AnyCable RPC server configuration parameters passed through enviroment,
# see https://docs.anycable.io/#/ruby/configuration?id=parameters
set :anycable_environment_variables, {}
# Path to anycable.yml
set :anycable_conf, nil
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/anycable/capistrano-anycable.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).