README

!Huginn

-----

 Coverage 

 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

 Scrape websites and receive an email when they change
 Watch RSS feeds, IMAP mailboxes, webhooks, and MQTT topics, and act on what arrives
 Track the weather and get an email when it's going to rain (or snow) tomorrow ("Don't forget your umbrella!")
 Watch for air travel or shopping deals
 Detect peaks and gaps in a stream of events and send a message within moments when something unusual happens
 Send digest emails with the things you care about at specific times of the day
 Post to Slack, Telegram, Threads, Tumblr, Twitter, Weibo, Pushover, Pushbullet, and Jabber, or send SMS and phone calls with Twilio
 Summarize, classify, and translate text, or generate images and speech, with OpenAI-compatible APIs
 Fetch, transform, and store files on Dropbox, S3, FTP, and the local filesystem
 Write custom logic in JavaScript, Liquid templates, or jq
 Publish your own feeds and JSON endpoints from the events your Agents collect
 Track your location over time
 Send and receive webhooks to connect Huginn with anything else

Ask questions and share your ideas in GitHub Discussions.

 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".  See CONTRIBUTING.md to get started.

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

Here are some example screenshots.  Below them are instructions to get you started.

!Example list of agents

!Event flow diagram

!Detecting peaks in a stream of events

!Browsing the Events your Agents created

!Logging your location over time

!Making a new agent

 Getting Started

 Try it with Docker

The quickest way to check out Huginn is the official Docker image, which runs everything in one container:

bash
docker run -it -p 3000:3000 ghcr.io/huginn/huginn


Open http://localhost:3000/ and log in as admin with the password printed once in the container log.  See the Docker documentation for persistent storage, an external database, and the multi-container image.

 Local development

If you want to hack on Huginn, fork this repository and then:

 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 

Top issues

Discussions

Latest release

This security release upgrades Rails from 8.1.4 to 8.1.4.1 and updates its HTML sanitization dependencies.  We recommend upgrading all installations.

 Security fixes

Rails 8.1.4.1 addresses 21 security issues, including XSS, IP spoofing, denial of service, session handling, and Active Storage file processing vulnerabilities.  Exposure depends on the features and deployment configuration in use.  See the Rails security release announcement for details.

The update also includes rails-html-sanitizer 1.7.2, Loofah 2.25.3, and Nokogiri 1.19.7.

 Upgrade notes

No database migration is required.