James Peret: 1e0df92b79 Merged modifications with original project updates 7 years ago
.openshift 3f64c7f4e8 do not depend on .env.example any more 9 years ago
app 1e0df92b79 Merged modifications with original project updates 7 years ago
bin 5fbeb105b2 Update gems and configs to Rails5 7 years ago
config bf35a49f6c Fix delayed_job_active_record overriding defaults 7 years ago
data 98f50de06b Sets the new user up with an example set of agents 8 years ago
db 22645a9441 Merge remote-tracking branch 'origin/data_output_agent_limits_events_after_ordering' 7 years ago
deployment f11aa1972a Update huginn-ssl 8 years ago
doc b0ae9581d2 Update documentation 7 years ago
docker aceace7950 Docker: update ruby to 2.3 and use RAILS_LOG_TO_STDOUT 7 years ago
lib ba0d2ee0de Retire ar_mysql_column_charset 7 years ago
media 4889533fe0 Adding square icon and iOS assets 8 years ago
public 8ea677607a Regenerate site icon files 8 years ago
script e4ec657537 Use travi-ci's new docker infrastructure + caching 9 years ago
spec 0fcd8e285e Normalize URL in `to_uri` and `uri_expand` liquid filters 7 years ago
tmp 1201c18c1c ensuring the tmp folder is created in the source tree 10 years ago
vendor 517e42c9d2 Replace jquery.serializeObject with new implementation 7 years ago
.buildpacks f180f26f1d Update .buildpacks 9 years ago
.dockerignore cbeb269f0b Add Nitrous.io quickstart configs and update README 8 years ago
.env.example 811f9c27d1 Allow specifing Agent gem in the Gemfile 7 years ago
.gitignore 4fdc600788 Remove schema.rb from git 8 years ago
.graphviz e3f9ac50a9 Enable Graphviz on Heroku. 9 years ago
.travis.yml 5fbeb105b2 Update gems and configs to Rails5 7 years ago
CHANGES.md 0fcd8e285e Normalize URL in `to_uri` and `uri_expand` liquid filters 7 years ago
Capfile a16fb09fa6 Add capistrano 3 and documentation 8 years ago
Gemfile 1e0df92b79 Merged modifications with original project updates 7 years ago
Gemfile.lock 1e0df92b79 Merged modifications with original project updates 7 years ago
Guardfile c608294358 Allow to use spring by setting SPRING in .env 8 years ago
LICENSE f371431922 Clarify license 11 years ago
Procfile d8428e31d9 Support 12-factor configurations of dev environments 8 years ago
Procfile.CF 0c9c08168c Huginn cloudfoudnry compatible 9 years ago
README.md 4469213425 Update README.md 7 years ago
Rakefile 5fbeb105b2 Update gems and configs to Rails5 7 years ago
VERSION 48a024845a update VERSION, README, and CHANGES 10 years ago
app.json 05db573b41 Add logo to app.json 8 years ago
build_docker_image.sh 995250d3b8 Build docker image on TravisCI 8 years ago
config.ru 5fbeb105b2 Update gems and configs to Rails5 7 years ago
manifest.yml.sample 7cbd714ad4 Added comment to manifestfile 9 years ago
nitrous-post-create.sh cbeb269f0b Add Nitrous.io quickstart configs and update README 8 years ago
nitrous.json cbeb269f0b Add Nitrous.io quickstart configs and update README 8 years ago

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

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/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 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.

Nitrous Quickstart

You can quickly create a free development environment for this Huginn project in the cloud on www.nitrous.io:

Nitrous Quickstart

In the IDE, start Huginn via Run > Start Huginn and access your site via Preview > 3000.

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.

Deployment

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 works on the free version of Heroku with significant limitations. For non-experimental use, we strongly recommend Heroku's cheapest paid plan or our Docker container.

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

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.

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 Dependency Status Bountysource