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.

Dominik Sander 9ef1df36a4 Not not initialize bootsnap when running as root 6 лет назад
.s2i 15c294cc66 Update to OpenShift v3 quickstart templates 7 лет назад
app 61b33bf37c Merge pull request #2266 from dsander/rails52 6 лет назад
bin 8054945593 Merge pull request #2112 from baip/master 7 лет назад
config 9ef1df36a4 Not not initialize bootsnap when running as root 6 лет назад
data 91105347d6 Fix default scenario links 7 лет назад
db d76ea3dea5 Replace some other occurrences of the references to the old URL 7 лет назад
deployment f11aa1972a Update huginn-ssl 8 лет назад
doc e23498ebbd Update ruby to 2.5 in manual installation guide and in docker containers 6 лет назад
docker e23498ebbd Update ruby to 2.5 in manual installation guide and in docker containers 6 лет назад
lib 0339a23e45 Support the `AtomYoutube` feed format of Feedjira 7 лет назад
media 4889533fe0 Adding square icon and iOS assets 9 лет назад
openshift 15c294cc66 Update to OpenShift v3 quickstart templates 7 лет назад
public 8ea677607a Regenerate site icon files 9 лет назад
script e4ec657537 Use travi-ci's new docker infrastructure + caching 10 лет назад
spec 61b33bf37c Merge pull request #2266 from dsander/rails52 6 лет назад
tmp 1201c18c1c ensuring the tmp folder is created in the source tree 10 лет назад
vendor ea2a5e3456 Upgrade jquery.jsoneditor to handle null values 7 лет назад
.buildpacks 99b2d75a12 Switch back to the upstream heroku-buildpack-graphviz 7 лет назад
.dockerignore 085473263f Remove additional nitrous files (#1791) 8 лет назад
.env.example c7350f2c3c Clarifying no authentication scenario 7 лет назад
.gitignore 201b784562 Fix specs and deprecation warnings 6 лет назад
.graphviz e3f9ac50a9 Enable Graphviz on Heroku. 10 лет назад
.travis.yml ea8f14895a Add ruby 2.5 to travis ci build matrix and update other rubies 6 лет назад
CHANGES.md 6987360811 Add a CHANGES entry 7 лет назад
Capfile a16fb09fa6 Add capistrano 3 and documentation 9 лет назад
Gemfile 3c1bffcb38 Add bootsnap 6 лет назад
Gemfile.lock 3c1bffcb38 Add bootsnap 6 лет назад
Guardfile 36ece6cd3b Fix running specs with guard and spring 7 лет назад
LICENSE f371431922 Clarify license 11 лет назад
Procfile d76ea3dea5 Replace some other occurrences of the references to the old URL 7 лет назад
Procfile.CF 0c9c08168c Huginn cloudfoudnry compatible 9 лет назад
README.md 14c60c5997 Add link for darksky api key since wunderground no longer free 6 лет назад
Rakefile 5fbeb105b2 Update gems and configs to Rails5 8 лет назад
VERSION 48a024845a update VERSION, README, and CHANGES 11 лет назад
app.json 30a4a67a0f Replace references to https://github.com/cantino/huginn with huginn/huginn 7 лет назад
build_docker_image.sh 600b06c192 Fix docker hub login on CI 7 лет назад
config.ru 5fbeb105b2 Update gems and configs to Rails5 8 лет назад
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 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 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.

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, emails 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 emails 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 Online (v3)

Try Huginn on OpenShift Online (v3): 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. 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.

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