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 125c5ce7e6 wip: Add Atom feed output support to DataOutputAgent 3 jaren geleden
.github 4588334dae Add FUNDING.yml 4 jaren geleden
.s2i 15c294cc66 Update to OpenShift v3 quickstart templates 7 jaren geleden
app 125c5ce7e6 wip: Add Atom feed output support to DataOutputAgent 3 jaren geleden
bin 2efdf4cdcb Upgrade to Rails 6 4 jaren geleden
config fbc17c0d67 Add an option to send email using `sendmail` 4 jaren geleden
data 735e4022c5 Merge branch 'master' of https://github.com/huginn/huginn 5 jaren geleden
db 8d2150f0fd Switch to the zeitwerk autoloader 4 jaren geleden
deployment 3cf248cf15 No regex matching for location 6 jaren geleden
doc afaf625602 Update installation.md with non-ambiguous --progress-bar flag for curl 4 jaren geleden
docker c7c632609a Hopefully fix ruby segfault in docker with Rails 6 4 jaren geleden
lib c9b4a27c51 Use dc:identifier as the entry ID if available 3 jaren geleden
media 4889533fe0 Adding square icon and iOS assets 9 jaren geleden
openshift a30321fd11 Some small changes to update the openshift templates so that they work, including: 4 jaren geleden
public 8ea677607a Regenerate site icon files 9 jaren geleden
script e4ec657537 Use travi-ci's new docker infrastructure + caching 10 jaren geleden
spec 125c5ce7e6 wip: Add Atom feed output support to DataOutputAgent 3 jaren geleden
tmp 1201c18c1c ensuring the tmp folder is created in the source tree 10 jaren geleden
vendor ea2a5e3456 Upgrade jquery.jsoneditor to handle null values 7 jaren geleden
.buildpacks 3cd3a234b3 Add heroku-buildpack-jq to install jq 5 jaren geleden
.dockerignore 085473263f Remove additional nitrous files (#1791) 8 jaren geleden
.env.example 9f7ff670a3 Fix `SMTP_DELIVERY_METHOD` being applied as default configuration 4 jaren geleden
.gitignore 2efdf4cdcb Upgrade to Rails 6 4 jaren geleden
.travis.yml 33715f182b Drop Ruby 2.3 and 2.4 support, run tests on Ubuntu 18.04 4 jaren geleden
CHANGES.md 7263c3b1e0 Upgrade ubuntu versions of docker images to 18.04 4 jaren geleden
Capfile a16fb09fa6 Add capistrano 3 and documentation 9 jaren geleden
Gemfile 8a8b3d9334 Upgrade rails to 6.0.3.1 4 jaren geleden
Gemfile.lock b06f77d1d7 Update nokogiri 3 jaren geleden
Guardfile 36ece6cd3b Fix running specs with guard and spring 7 jaren geleden
LICENSE f371431922 Clarify license 11 jaren geleden
Procfile d76ea3dea5 Replace some other occurrences of the references to the old URL 7 jaren geleden
Procfile.CF 0c9c08168c Huginn cloudfoudnry compatible 9 jaren geleden
README.md b4c679a963 Fix link to podcast at Changelog.com 4 jaren geleden
Rakefile 5fbeb105b2 Update gems and configs to Rails5 8 jaren geleden
VERSION 48a024845a update VERSION, README, and CHANGES 11 jaren geleden
app.json 1b50ef9289 Set Heroku stack to `heroku-18` in app.json 5 jaren geleden
build_docker_image.sh 8f98816c48 Always build the "full" docker image on TravisCI 4 jaren geleden
config.ru 5fbeb105b2 Update gems and configs to Rails5 8 jaren geleden
manifest.yml.sample 7cbd714ad4 Added comment to manifestfile 9 jaren geleden

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 version of IFTTT or Zapier 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 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, 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 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."

Gitter

Join us in our Gitter room to discuss the project.

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

Docker

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

Local Installation

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/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 the APP_SECRET_TOKEN variable.
  • Make sure that you have MySQL or PostgreSQL installed. (On a Mac, the easiest way is with Homebrew. If you're going to use PostgreSQL, you'll need to prepend all commands below with DATABASE_ADAPTER=postgresql.)
  • 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 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, email messages are intercepted in the development Rails environment, which is what you just setup. You can view them at http://localhost:3000/letter_opener. If you'd like to send real email via SMTP 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! And there's also acceptance tests that simulate running Huginn in a headless browser.

  • Install PhantomJS 2.1.1 or greater:
  • Run all specs with bundle exec rspec
  • Run a specific spec with bundle exec rspec path/to/specific/test_spec.rb.
  • Read more about rspec for rails here.

Using Huginn Agent gems

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

If you'd like to write your own Huginn Agent Gem, please see huginn_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.

Deployment

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

Heroku

Try Huginn on Heroku: Deploy (Takes a few minutes to setup. Read the documentation while you are waiting and be sure to click 'View it' after launch!)

Huginn launches on the free version of Heroku with significant limitations. For non-experimental use, we strongly recommend Heroku's 1GB paid plan or our Docker container.

OpenShift

OpenShift Online

Try Huginn on OpenShift Online

Create a new app with either mysql or postgres:

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 the guide to remove any existing application.

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

Manual installation on any server

Have a look at the installation guide.

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.

Note, Wunderground no longer offers free API keys. You can still use the WeatherAgent by setting the service key to darksky, and getting an API key from DarkSky.

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.

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

Build Status Coverage Status Dependency Status Bountysource