README
Sidekiq Relay
Allows piping of Sidekiq jobs to remote Sidekiq configurations (i.e. non-local Redis) to reduce delays compared to directly enqueuing to remote Redis instances. Supports Redis Sentinel.
Ruby gem coming soon to use in conjunction (e.g. for enqueuing from Rails applications).
Installation
-
Add the dependency to your
shard.yml:dependencies: sk_relay: github: pgeraghty/sidekiq_relay -
Run
shards install
Usage
require "sidekiq_relay"Given the environment established via the example Redis 4 Docker Compose file, tests should complete successfully.
TODO: Write further usage instructions here
TODO: example.cr that just needs Redis config
TODO: allow loading remote Redis config from YAML alongside a Docker image containing a statically-linked binary.
Development
Testing and development require a functional Redis Sentinel configuration; I have provided Docker Compose files to establish these for Redis 4. Both set up a separate static network so that IP addresses are pre-established.
TODO: Write development instructions here
Contributing
- Fork it (https://github.com/pgeraghty/sidekiq_relay_crystal/fork)
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
Contributors
- Paul Geraghty - creator and maintainer