https://github.com/meltingice/campfire-notifier

A self-hosted Campfire push notification service
https://github.com/meltingice/campfire-notifier

Last synced: 24 days ago
JSON representation

A self-hosted Campfire push notification service

• Host: GitHub
• URL: https://github.com/meltingice/campfire-notifier
• Owner: meltingice
• License: mit
• Created: 2014-03-14T16:26:01.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-03-17T21:59:26.000Z (over 10 years ago)
• Last Synced: 2024-04-13T01:54:12.207Z (7 months ago)
• Language: Ruby
• Homepage:
• Size: 274 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Campfire Notifier

Provides notifications based on configurable triggers for your Campfire rooms. Notifications can be sent using:

* Twilio

* Pushover

## Installation

1. Clone this repository to the computer/server where you want to run this service.

2. Run `bundle install`

3. Create your configuration (instructions below).

## Configuration

All configuration is done in `config/config.yml`. If needed, you can change the configuration file location by overriding it with the `CAMPFIRE_NOTIFIER_CONFIG` environment variable.

The config file looks like this:

``` yaml

# How often we should check the campfire rooms for updates

schedule: 1m

# The default notification service. Can be overriden per user.

notification_service: Twilio

# The campfire credentials

campfire:

  subdomain: awesome-co

  api_token: 02ed8f207b2935fo37bnasf17b7c479408fb37687

# Twilio credentials (if applicable)

twilio:

  account_sid: ACe40lN63sb0d5273ef8ej1a98ad0159ff

  auth_token: 69d9KnYT5b539aa1a7eVB4S6f0e835f3

  phone_number: +1 123-456-7890

# Pushover credentials (if applicable)

pushover:

  title: My Company Chat

  api_token: aX0pL7Hb5rBPC8W5fPfqkVjHYix6H2

# People we want to notify

people:

  Ryan:

    notification_service: Pushover

    pushover_token: eadz98FTGzPZJI87HbzX8RuXz9EP9h

    triggers:

      - RL

      - Ryan

      - LeFevre

  Kelly:

    phone: +1 890-123-4567

    triggers:

      - KS

      - Kelly

      - Sutton

```

## Running

To start listening in your Campfire rooms, simply run:

``` shell

bundle exec rake notifier:listen

```