_
__ _ ___| |__ ___ _ __ ___ _ __
/ _` |/ __| '_ \ / _ \ '__/ _ \| '_ \
| (_| | (__| | | | __/ | | (_) | | | |
\__,_|\___|_| |_|\___|_| \___/|_| |_|
Welcome to acheron
Acheron listens to an exchange[1] on RabbitMQ[2] and forwards messages to a channel on Slack[3].
Installation
Add this line to your application's Gemfile:
gem 'acheron'
And then execute:
$ bundle
Or install it yourself as:
$ gem install acheron
Usage
Run
acheron
Configuration
Acheron reads configuration options from multiple locations. The following sections list all of those locations, later superseeds the prior ones.
Defaults
Acheron comes with reasonable defaults
slack:
channel: '#acheron'
username: Acheron
icon_emoji: ':space_invader:'
rabbitmq:
exchange: acheron
Config file
The defaults above are given in YAML, which is also the format of the
config file. By default Acheron The Salcker attempts to read a config
file named acheron.yml
from the current working
directory. You can provide an alternate location either via
environment variable or with a command line argument.
Environment
All environment variables are prefixed with ACHERON
and the nesting is
reflected by an underscore separated list of names. E.g.
export ACHERON_SLACK_CHANNEL='#set_by_env'
Command line arguments
Run the following command to get a list of all arguments:
acheron --help
Use with Docker
TODO
Contributing
- Fork it
- 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 new Pull Request
Trivia
In ancient Greek mythology, Acheron was known as the "river of woe", and was one of the five rivers of the Greek underworld. In the Homeric poems the Acheron was described as a river of Hades, into which Cocytus and Phlegethon both flowed. The Roman poet Virgil called it the principal river of Tartarus, from which the Styx and Cocytus both sprang. The newly dead would be ferried across the Acheron by Charon in order to enter the Underworld. Wikipedia
References
- [1] https://www.rabbitmq.com/tutorials/tutorial-three-python.html
- [2] https://www.rabbitmq.com/
- [3] http://slack.com/ docker run -e ARCHERON_RABBITMQ_HOST=rabbitmq -e ACHERON_SLACK_TOKEN=asdf -e ACHERON_SLACK_CHANNEL=@branch14 branch14/acheron