Repository files navigation

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 version of IFTTT or Zapier on your own server. You always know who has your data. You do.

• 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 email 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 email when they change
• Connect to Adioso, HipChat, FTP, IMAP, Jabber, JIRA, MQTT, nextbus, Pushbullet, Pushover, RSS, Bash, Slack, StubHub, translation APIs, Twilio, Twitter, and Weibo, to name a few.
• Send digest email 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."

Join us in ourGitter room to discuss the project.

Want to help with Huginn? All contributions are encouraged! You could make UI improvements,add new Agents, writedocumentation and tutorials, or try tacklingissues 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 thecurrent bounties on Bountysource.

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

Please checkout theHuginn Introductory Screencast!

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

The quickest and easiest way to check out Huginn is to use the official Docker image. Have a look at thedocumentation.

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

• Rungit remote add upstream https://github.com/huginn/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 theAPP_SECRET_TOKEN variable.
• Make sure that you have MySQL or PostgreSQL installed. (On a Mac, the easiest way is withHomebrew. If you're going to use PostgreSQL, you'll need to prepend all commands below withDATABASE_ADAPTER=postgresql.)
• Runbundle to install dependencies
• Runbundle exec rake db:create,bundle exec rake db:migrate, and thenbundle exec rake db:seed to create a development database with some example Agents.
• Runbundle exec foreman start, visithttp://localhost:3000/, and login with the username ofadmin and the password ofpassword.
• Setup some Agents!
• Read thewiki for usage examples and to get started making new Agents.
• Periodically rungit fetch upstream and thengit checkout master && git merge upstream/master to merge in the newest version of Huginn.

Note: By default, email messages are intercepted in thedevelopment Rails environment, which is what you just setup. You can viewthem athttp://localhost:3000/letter_opener. If you'd like to send real email via SMTP when playingwith Huginn locally, setSEND_EMAIL_IN_DEVELOPMENT totrue in your.env file.

If you need more detailed instructions, see theNovice setup guide.

All agents have specs! And there's also acceptance tests that simulate running Huginn in a headless browser.

• Install PhantomJS 2.1.1 or greater:
  • UsingNode Package Manager:npm install phantomjs
  • UsingHomebrew on OSXbrew install phantomjs
• Run all specs withbundle exec rspec
• Run a specific spec withbundle exec rspec path/to/specific/test_spec.rb.
• Read more about rspec for railshere.

Huginn Agents can now be written as external gems and be added to your Huginn installation with theADDITIONAL_GEMS environment variable. See theAdditional Agent gems section of.env.example for more information.

If you'd like to write your own Huginn Agent Gem, please seehuginn_agent.

Our general intention is to encourage complex and specific Agents to be written as Gems, while continuing to add new general-purpose Agents to the core Huginn repository.

Please seethe Huginn Wiki for detailed deployment strategies for different providers.

Try Huginn on Heroku: (Takes a few minutes to setup. Read thedocumentation while you are waiting and be sure to click 'View it' after launch!) Huginn launches only on a paid subscription plan for Heroku. For non-experimental use, we strongly recommend Heroku's 1GB paid plan or our Docker container.

Try Huginn on OpenShift Online

Create a new app with eithermysql orpostgres:

oc new-app -f https://raw.githubusercontent.com/huginn/huginn/master/openshift/templates/huginn-mysql.json

or

oc new-app -f https://raw.githubusercontent.com/huginn/huginn/master/openshift/templates/huginn-postgresql.json

Note: You can also use the web console to import either json file by going to "Add to Project" -> "Import YAML/JSON".

If you are on the Starter plan, make sure to follow theguide to remove any existing application.

The templates should work on a v3 installation or the current v4 online.

Have a look at theinstallation guide.

Seeprivate development instructions on the wiki.

In order to use the WeatherAgent you need anWeather Data API key from Pirate Weather. Sign up for one and then change the value ofapi_key: your-key in your seeded WeatherAgent.

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 editconfig/initializers/devise.rb and modify the line containingconfig.rememberable_options = { :secure => true }. You will also need to editconfig/environments/production.rb and modify the value ofconfig.force_ssl.

Huginn is provided under the MIT License.

Huginn was originally created by@cantino in 2013. Since then, many people's dedicated contributions have made it what it is today.