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.

Sign up for GitHub

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

Update README.md with server install instruction and full task list #320

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md with server install instruction and full task list #320

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 24 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,30 @@ Configurable options - Please ensure you check your version's branch for the ava
:sidekiq_config_files, ['sidekiq.yml', 'sidekiq-2.yml'] # you can also set it per server
```

Before running `$ bundle exec cap {stage} deploy` for the first time, install Sidekiq on the deployment server. For example, if stage=production:
```
$ bundle exec cap production sidekiq:install
```

To uninstall,
```
$ bundle exec cap production sidekiq:uninstall
```

## Full task list

```
$ cap -T sidekiq
cap sidekiq:generate_service_locally # Generate service_locally
cap sidekiq:install # Install systemd sidekiq service
cap sidekiq:quiet # Quiet Sidekiq (stop fetching new tasks from Redis)
cap sidekiq:restart # Restart Sidekiq (Quiet, Wait till workers finish or 30 seconds, Stop, Start)
cap sidekiq:start # Start Sidekiq
cap sidekiq:status # Get Sidekiq Status
cap sidekiq:stop # Stop Sidekiq (graceful shutdown within timeout, put unfinished tasks back to Redis)
cap sidekiq:uninstall # Uninstall systemd sidekiq service
```

## Example

A sample application is provided to show how to use this gem at https://github.com/seuros/capistrano-example-app
Expand Down