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. We're just getting started, but here are some of the things you can do with Huginn right now:
Control your own data, run your own data hub. You know where the data is and who has it. Don't be afraid to log stuff because of where it is.
Make agents that serve you.
- Make a private fork of this repository on GitHub.
- In your fork, edit
config/secret_token.rb
and replaceREPLACE_ME_NOW!
with the output ofrake secret
. - Edit
app/models/user.rb
and change the invitation code(s) inINVITATION_CODES
. This controls who can signup to use your installation. - Run
rake db:create
,rake db:migrate
, and thenrake db:seed
to create a development MySQL database with some example seed data. Runrails s
, visitlocalhost:3000
, and login with the username ofadmin
and the password ofpassword
. - Make some extra Terminal windows and run
bundle exec rails runner bin/schedule.rb
andbundle exec rails runner bin/twitter_stream.rb
Deployment right now is configured with Capistrano, Unicorn, and nginx. You should feel free to deploy in a different way, however.
-
Edit
app/mailers/system_mailer.rb
and set your default from address. -
Edit
config/unicorn/production.rb
and replace instances of you with the correct username for your server. -
Edit
config/environments/production.rb
and change the value ofDOMAIN
and theconfig.action_mailer.smtp_settings
setup, which is currently setup for sending email through a Google Apps account on Gmail. -
Setup a place for Huginn to run. I recommend making a dedicated user on your server for Huginn, but this is not required. Setup nginx or Apache to proxy pass to unicorn. There is an example nginx script in
config/nginx/production.conf
. -
Setup a production MySQL database for your installation.
-
Edit
config/deploy.rb
and change all instances ofyou
andyourdomain
to the appropriate values for your server setup, then runcap deploy:setup
followed bycap deploy
. If everything goes well, this should start some unicorn workers on your server to run the Huginn web app. -
After deploying with capistrano, SSH into your server, go to the deployment directory, and run
RAILS_ENV=production bundle exec rake db:seed
to generate your admin user. Immediately login to your new Huginn installation with the username ofadmin
and the password ofpassword
and change your email and password! -
You'll need to run bin/schedule.rb and bin/twitter_stream.rb in a daemonized way. I've just been using screen sessions, but please contribute something better!
RAILS_ENV=production bundle exec rails runner bin/schedule.rb
RAILS_ENV=production bundle exec rails runner bin/twitter_stream.rb
In order to use the WeatherAgent you need an API key with Wunderground. Signup for one and then put it in app/models/agents/weather_agent.rb
in the wunderground
method.
- Edit
config.ru
, uncomment the DelayedJobWeb section, and change the DelayedJobWeb username and password. - Uncomment
match "/delayed_job" => DelayedJobWeb, :anchor => false
inconfig/routes.rb
. - Uncomment
gem "delayed_job_web"
in Gemfile and runbundle
.
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
.
Huginn is provided under the MIT License.
Please fork, add specs, and send pull requests!