https://github.com/flowdock/oulu

Flowdock IRC Gateway
https://github.com/flowdock/oulu

Last synced: 24 days ago
JSON representation

Flowdock IRC Gateway

• Host: GitHub
• URL: https://github.com/flowdock/oulu
• Owner: flowdock
• License: mit
• Created: 2012-03-27T03:53:40.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2024-03-19T03:13:21.000Z (9 months ago)
• Last Synced: 2024-08-04T04:05:46.955Z (4 months ago)
• Language: Ruby
• Homepage:
• Size: 404 KB
• Stars: 77
• Watchers: 53
• Forks: 16
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

• starred-awesome - oulu - Flowdock IRC Gateway (Ruby)

README

        
[![Stories in Ready](https://badge.waffle.io/flowdock/oulu.png)](http://waffle.io/flowdock/oulu)

# Oulu: The Flowdock IRC Gateway [![Build Status](https://travis-ci.org/flowdock/oulu.png?branch=master)](https://travis-ci.org/flowdock/oulu)

This component acts as an IRC server, and bridges the messages between clients and Flowdock.

If you're looking to simply use this IRC gateway, check out the [help page](https://www.flowdock.com/help/irc).

## Prerequisites

Oulu uses bundler, so simply run `bundle install` before running tests. No

database is needed.

## Running tests

Use: `bundle exec rspec`

# Running acceptance tests

Use: `TEST_USER="[email protected]" TEST_PASSWORD="..." TEST_FLOW="mytest/main" bundle exec rspec spec/acceptance_tests.rb`

## Running the server

Use: `foreman start`

Possible environment configuration:

* *FLOWDOCK_DOMAIN* - where's your Flowdock at? (optional, default value: flowdock.com)

* *FLOWDOCK_UNSECURE_HTTP* - use http instead of https. This makes

  testing on your local machine much nicer.

There is a `sample.env` file which should suffice for local testing so you can just

    ln -s sample.env .env

Define port using command line parameter `--port` (optional, defaults to foreman's default port)

## Deploying to Flowdock's server environments

There's a separate repository with deployment scripts and instructions.