Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support per-process options & better per-role options #141

Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add undocumented options to README
...and group options based on whether they're passed as options to sidekiq vs whether they're used to configure how capistrano behaves
  • Loading branch information
metavida committed Jan 27, 2016
commit 1d5b4a0758be07de705780cbed86356f5f25e945
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,28 +31,36 @@ require 'capistrano/sidekiq/monit' #to require monit tasks # Only for capistrano
Configurable options, shown here with defaults:

```ruby
:sidekiq_default_hooks => true
# Sidekiq options
:sidekiq_config => nil # if you have a config/sidekiq.yml, do not forget to set this.
:sidekiq_pid => File.join(shared_path, 'tmp', 'pids', 'sidekiq-0.pid') # if you specify a pidfile in your sidekiq_config file that value will be used as the default.
:sidekiq_env => fetch(:rack_env, fetch(:rails_env, fetch(:stage)))
:sidekiq_log => File.join(shared_path, 'log', 'sidekiq.log')
:sidekiq_options => nil
:sidekiq_require => nil
:sidekiq_tag => nil
:sidekiq_config => nil # if you have a config/sidekiq.yml, do not forget to set this.
:sidekiq_queue => nil
:sidekiq_timeout => 10
:sidekiq_concurrency => nil
:sidekiq_options => nil

:sidekiq_timeout => 10 # Used when stopping sidekiq

# Capistrano options
:sidekiq_default_hooks => true
:sidekiq_role => :app
:sidekiq_processes => 1
:sidekiq_concurrency => nil
:sidekiq_user => nil #user to run sidekiq as
:start_sidekiq_in_background => false
:stop_sidekiq_in_background => false
:sidekiq_run_in_background => false # like setting both :start_ and :stop_sidekiq_in_background to true
:sidekiq_use_signals => false # if :stop_sidekiq_in_background is true, use signals for quite & stop
:sidekiq_monit_templates_path => 'config/deploy/templates'
:sidekiq_monit_use_sudo => true
:sidekiq_user => nil #user to run sidekiq as

# Options only for Capistrano 2.5
:sidekiq_cmd => "#{fetch(:bundle_cmd, "bundle")} exec sidekiq"
:sidekiqctl_cmd => "#{fetch(:bundle_cmd, "bundle")} exec sidekiqctl"

# Deprecated options
# Deprecated Sidekiq options
:sidekiq_options_per_process => nil
```

Expand Down