Stream for nothub
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
lib
test
.gitignore
.jshintrc
.travis.yml
README.md
package.json
start.js
yarn.lock

README.md

NotHub Stream

Build Status

NotHub Stream is a Server of NotHub

Setup

$ git clone git://github.com/tricknotes/nothub-stream.git ./nothub-stream
$ cd nothub-stream
$ yarn install

Edit config:

$ cp ./config/stream.config.example ./config/stream.config

Write your setting to ./config/stream.config.

And run:

$ yarn start

Test

$ yarn test

Authorization

You can use github authorization, to use advanced rate limit.

Run using GITHUB_ACCESS_TOKEN as an environment variable:

$ GITHUB_ACCESS_TOKEN="Your API Token" yarn start

Using on github:enterprise

You can use nothub on GitHub Enterprise perhaps. (I have no testing environments. Sorry:-))

  1. Install nothub as a node module:
$ mkdir your_project
$ cd your_project
$ yarn add https://github.com/tricknotes/nothub-stream
  1. Copy script for running nothub:
$ cp ./node_modules/nothub-stream/start.js ./start.js
  1. And edit ./start.js to use domain name for your github:enterprise. For example:
- var NotHubStream = require('./')
+ var NotHubStream = require('nothub-stream')
  crawler = new Crawler({
    query: {
      access_token: process.env['GITHUB_ACCESS_TOKEN']
+     host: 'yourdomain.com'
    }
  });

License

(The MIT License)

Copyright (c) 2012 Ryunosuke SATO <tricknotes.rs@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.