Create agents that monitor and act on your behalf. Your agents are standing by!
Huginn is a system for building agents that perform automated tasks for you online. Huginn's Agents create and consume events, propagating them along a directed graph.

Akinori MUSHA 0460cb339b Give separate example command lines for development and production 9 лет назад
.openshift 3f64c7f4e8 do not depend on .env.example any more 10 лет назад
app b1030a5d7f Declare the site icons in various sizes 9 лет назад
bin ea1fb447ca Merge remote-tracking branch 'origin/master' into js_agent_can_be_dryrun 9 лет назад
config 5ab17bab3d Introduce gem groups for group-based opt-out 9 лет назад
data 5d63df8d18 Added JSONPath 11 лет назад
db da77a8a333 Merge pull request #711 from dsander/pushbullet-unification 9 лет назад
deployment 1f8ecc29d1 add SEND_EMAIL_IN_DEVELOPMENT option to .env.example 9 лет назад
doc 002436fcb0 Change deprecated `File.exists?` to `File.exist?`. 10 лет назад
docker d8434803f3 Adding 0.0.0.0 as the interface to bind, as it seems rails 4.2 changed the default behavior 9 лет назад
lib b1030a5d7f Declare the site icons in various sizes 9 лет назад
media 4889533fe0 Adding square icon and iOS assets 9 лет назад
public b1030a5d7f Declare the site icons in various sizes 9 лет назад
script e4ec657537 Use travi-ci's new docker infrastructure + caching 10 лет назад
spec 84ebfa18cb add a validation that warns the user if they have not provided a path when using JSONPath 9 лет назад
tmp 1201c18c1c ensuring the tmp folder is created in the source tree 10 лет назад
vendor 4eabcca235 Added spec for the FormConfigurableAgentPresenter 10 лет назад
.buildpacks f180f26f1d Update .buildpacks 9 лет назад
.env.example 3e085512ff Make delayed_job sleep_delay and max_run_time .env configurable 9 лет назад
.gitignore 0c9c08168c Huginn cloudfoudnry compatible 9 лет назад
.graphviz e3f9ac50a9 Enable Graphviz on Heroku. 10 лет назад
.travis.yml 7c43c6efa0 Ruby 1.9.3 and add ruby 2.2.0 support 9 лет назад
CHANGES.md 2018dbc0d1 update CHANGES.md 10 лет назад
Capfile 620acffa5a initial commit 11 лет назад
Gemfile 0460cb339b Give separate example command lines for development and production 9 лет назад
Gemfile.lock 5ab17bab3d Introduce gem groups for group-based opt-out 9 лет назад
Guardfile c1f336d04e FormConfigurable improvements 10 лет назад
LICENSE f371431922 Clarify license 11 лет назад
Procfile 8781fd16b5 try again 10 лет назад
Procfile.CF 0c9c08168c Huginn cloudfoudnry compatible 9 лет назад
README.md 5b716ede80 update README.md 9 лет назад
Rakefile c5fb643832 remove rails_admin - let users install it if they want it 11 лет назад
VERSION 48a024845a update VERSION, README, and CHANGES 11 лет назад
app.json e5ca2d3835 update app.json 9 лет назад
config.ru f27b6c5c21 Just keep the most recent 100 failed jobs + small improvements 10 лет назад
manifest.yml.sample 7cbd714ad4 Added comment to manifestfile 9 лет назад

README.md

Huginn


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 them along a directed graph. Think of it as a hackable Yahoo! Pipes plus IFTTT on your own server. You always know who has your data. You do.

the origin of the name

Here are some of the things that you can do with Huginn:

  • Track the weather and get an email when it's going to rain (or snow) tomorrow ("Don't forget your umbrella!")
  • List terms that you care about and receive emails when their occurrence on Twitter changes. (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 spike in discussion.)
  • Watch for air travel or shopping deals
  • Follow your project names on Twitter and get updates when people mention them
  • Scrape websites and receive emails when they change
  • Connect to Adioso, HipChat, Basecamp, Growl, FTP, IMAP, Jabber, JIRA, MQTT, nextbus, Pushbullet, Pushover, RSS, Bash, Slack, StubHub, translation APIs, Twilio, Twitter, Wunderground, and Weibo, to name a few.
  • Send digest emails with things that you care about at specific times during the day
  • Track counts of high frequency events and send an SMS within moments when they spike, such as the term "san francisco emergency"
  • Send and receive WebHooks
  • Run custom JavaScript or CoffeeScript functions
  • Track your location over time
  • Create Amazon Mechanical Turk workflows as the inputs, or outputs, of agents (the Amazon Turk Agent is called the "HumanTaskAgent"). For example: "Once a day, ask 5 people for a funny cat photo; send the results to 5 more people to be rated; send the top-rated photo to 5 people for a funny caption; send to 5 final people to rate for funniest caption; finally, post the best captioned photo on my blog."

Gitter

Join us in our Gitter room to discuss the project and follow @tectonic for updates as Huginn evolves.

Join us!

Want to help with Huginn? All contributions are encouraged! You could make UI improvements, add new Agents, write documentation and tutorials, or try tackling issues tagged with #help-wanted. Please fork, add specs, and send pull requests!

Really want a fix or feature? Want to solve some community issues and earn some extra coffee money? Take a look at the current bounties on Bountysource.

Have an awesome idea but not feeling quite up to contributing yet? Head over to our Official 'suggest an agent' thread and tell us!

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 fork this repository, then perform the following steps:

  • Run git remote add upstream https://github.com/cantino/huginn.git to add the main repository as a remote for your fork.
  • Copy .env.example to .env (cp .env.example .env) and edit .env, at least updating the APP_SECRET_TOKEN variable.
  • Run bundle to install dependencies
  • Run bundle exec rake db:create, bundle exec rake db:migrate, and then bundle exec rake db:seed to create a development MySQL database with some example Agents.
  • Run bundle exec foreman start, visit http://localhost:3000/, and login with the username of admin and the password of password.
  • Setup some Agents!
  • Read the wiki for usage examples and to get started making new Agents.
  • Periodically run git fetch upstream and then git checkout master && git merge upstream/master to merge in the newest version of Huginn.

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, set SEND_EMAIL_IN_DEVELOPMENT to true in your .env file.

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

Develop

All agents have specs! Test all specs with bundle exec rspec, or test a specific spec with bundle exec rspec path/to/specific/spec.rb. Read more about rspec for rails here.

Deployment

Deploy (Takes a few minutes to setup. Be sure to click 'View it' after launch!)

Huginn can run on Heroku for free! Please see the Huginn Wiki for detailed deployment strategies for different providers.

Optional Setup

Setup for private development

See private development instructions on the wiki.

Enable the WeatherAgent

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

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.

Build Status Coverage Status Bitdeli Badge Dependency Status Bountysource