Umar M. Sheikh: f7f10656d0 finally working version after fixing hash access issues 10 years ago
app f7f10656d0 finally working version after fixing hash access issues 10 years ago
bin d7d2bfe7d2 add documentation 10 years ago
config 77882908c4 in order to avoid leaking memory, remove all symbolization 10 years ago
data 5d63df8d18 Added JSONPath 11 years ago
db 9c48338347 fix specs 10 years ago
deployment c5fb643832 remove rails_admin - let users install it if they want it 11 years ago
doc 041c57b7d0 update example 10 years ago
lib 3d8393357e Merge pull request #116 from cantino/do_not_symbolize 10 years ago
public ada81674e0 move favicon 11 years ago
script 620acffa5a initial commit 11 years ago
spec f7f10656d0 finally working version after fixing hash access issues 10 years ago
vendor a5321938e7 comment on touchstart.dropdown e.stopPropagation 10 years ago
.env.example 0481c17dac updated based on comments from cantino 10 years ago
.gitignore 0ecc8e2860 we cannot ignore the bin folder (don't use the --binstubs flag) 11 years ago
.ruby-gemset d8529374b5 switch to .ruby-version and .ruby-gemset 11 years ago
.ruby-version c2ecac2e1e bump ruby version to avoid cve-2013-4164 10 years ago
.travis.yml 010236fdbb add travis to IRC 10 years ago
CHANGES.md 580ce8a083 Merge remote-tracking branch 'origin/master' into add_keep_events_for_to_agents 10 years ago
Capfile 620acffa5a initial commit 11 years ago
Gemfile 77c623b28e use typhoeus instead of patron 10 years ago
Gemfile.lock 77c623b28e use typhoeus instead of patron 10 years ago
LICENSE f371431922 Clarify license 11 years ago
Procfile d5164ad56b work in progress 11 years ago
README.md 04774fa682 add note about emails 10 years ago
Rakefile c5fb643832 remove rails_admin - let users install it if they want it 11 years ago
VERSION 48a024845a update VERSION, README, and CHANGES 10 years ago
config.ru 620acffa5a initial commit 11 years ago

README.md

Huginn. Your agents are standing by.

What is Huginn?

Huginn is a system for building agents that perform automated tasks for you online. They can read the web, watch for events, and take actions on your behalf. Huginn's Agents create and consume events, propagating events along a directed event flow graph. Think of it as Yahoo! Pipes plus IFTTT on your own server. You always know who has your data. You do.

the origin of the name

This is just getting started, but here are some of the things that you can do right now with Huginn:

  • Watch for air travel deals
  • List terms you care about and receive emails when their occurrence on Twitter changes drastically. (For example, want to know when something interesting has happened in the world of Machine Learning? Huginn will watch the term "machine learning" on Twitter and tell you when there is a large spike.)
  • Track the weather and get an email when it's going to rain (or snow) tomorrow
  • Follow your project names on Twitter and get updates when people mention them
  • Scrape websites and receive emails when they change
  • Compose digest emails about things you care about to be sent at specific times of the day
  • Track counts of high frequency events and SMS on changes, such as the term "san francisco emergency"
  • Track your location over time
  • Create Amazon Mechanical Turk tasks as the input, or output, of events

Follow @tectonic for updates as Huginn evolves, and join us in our IRC channel (#huginn on Freenode) to discuss the project.

Examples

Please checkout the Huginn Introductory Screencast!

And now, some example screenshots. Below them are instructions to get you started.

Example list of agents

Event flow diagram

Detecting peaks in Twitter

Logging your location over time

Making a new agent

Getting Started

Quick Start

If you just want to play around, you can simply clone this repository, then perform the following steps:

  • Copy .env.example to .env (cp .env.example .env) and edit .env, at least updating the APP_SECRET_TOKEN variable.
  • Run rake db:create, rake db:migrate, and then rake db:seed to create a development MySQL database with some example seed data.
  • Run foreman start, visit http://localhost:3000/, and login with the username of admin and the password of password.
  • Setup some Agents!

Note: by default, emails are not sent in the development Rails environment, which is what you just setup. If you'd like to enable emails when playing with Huginn locally, edit config.action_mailer.perform_deliveries in config/environments/development.rb.

If you need more detailed instructions, see the Novice setup guide.

Real Start

Follow these instructions if you wish to deploy your own version of Huginn or contribute back to the project. GitHub doesn't make it easy to work with private forks of public repositories, so I recommend that you follow the following steps:

  • Make a public fork of Huginn. If you can't create private Github repositories, you can skip the steps below. Just follow the Quick Start steps above and make pull requests when you want to contribute a patch.
  • Make a private, empty GitHub repository called huginn-private
  • Duplicate your public fork into your new private repository (via GitHub's instructions):

    git clone --bare git@github.com:you/huginn.git
    cd huginn.git
    git push --mirror git@github.com:you/huginn-private.git
    cd .. && rm -rf huginn.git
    
  • Checkout your new private repository.

  • Add your Huginn public fork as a remote to your new private repository (huginn-private):

    git remote add public git@github.com:you/huginn.git
    
  • Run the steps from Quick Start above to configure your copy of Huginn.

  • When you want to contribute patches, do a remote push from your private repository to your public fork of the relevant commits, then make a pull request to this repository.

Deployment

Please see the Huginn Wiki for detailed deployment strategies for different providers.

Optional Setup

Enable the WeatherAgent

In order to use the WeatherAgent you need an API key with Wunderground. Signup for one and then change value of api_key: your-key in your seeded WeatherAgent.

Logging your location to the UserLocationAgent

You can use Post Location on your iPhone to post your location to an instance of the UserLocationAgent. Make a new one to see instructions.

Enable DelayedJobWeb for handy delayed_job monitoring and control

  • Edit config.ru, uncomment the DelayedJobWeb section, and change the DelayedJobWeb username and password.
  • Uncomment match "/delayed_job" => DelayedJobWeb, :anchor => false in config/routes.rb.
  • Uncomment gem "delayed_job_web" in Gemfile and run bundle.

Disable SSL

We assume your deployment will run over SSL. This is a very good idea! However, if you wish to turn this off, you'll probably need to edit config/initializers/devise.rb and modify the line containing config.rememberable_options = { :secure => true }. You will also need to edit config/environments/production.rb and modify the value of config.force_ssl.

License

Huginn is provided under the MIT License.

Community

Huginn has its own IRC channel on freenode: #huginn. Some of us are hanging out there, come and say hello.

Contribution

Huginn is a work in progress and is hopefully just getting started. Please get involved! You can add new Agents, expand the Wiki, or help us simplify and strengthen the Agent API or core application.

Please fork, add specs, and send pull requests!

Build Status Coverage Status Bitdeli Badge