OpenEnergyMonitor User Guide
HTML CSS JavaScript Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.


OpenEnergyMonitor Guide Website

Build Status

A clean responsive user guide website for OpenEnergyMonitor.

Using all the shiny new toys: powered by Jekyll and the Oscalite theme. Hosted by GitHub and served over SSL/TSL by CloudFlare.

Edit site using Prose editor

Preview Jekyll website locally

Command Action
rake generate preview Generate & Preview site on http://localhost:4001
rake generate Generates static html in /public
rake deploy Deploys site to gh-pages branch
rake deploy rsync Deploys site via rsync over SSH

Edit sidebar nav menu



Install Ruby

Jekyll requires Ruby 2.x and bundler installed. Ubuntu 14.04 only includes 1.9.3 in it's packages. Solution use RVM (Ruby version manager), install with:

$ gpg --keyserver hkp:// --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
$ \curl -sSL | bash -s stable

Perform any further tasks recomended by rvm installer then restart shell session to re-load bash profile.

$ rvm install 2.3

Install required Ruby Gems

$ gem install bundler
$ git clone --recursive
$ cd guide
$ bundle

Preview site locally

$ rake generate
$ rake generate preview


Full Ruby installation instructions

Deploy to GitHub Pages

This website is hosted using GitHub Project pages. Github will serve the site from the gh-pages branch.

If this is the first time we publishing this site we neeed to create the gh-pages branch:

git checkout --orphan gh-pages

Once Octopress and rake Jekyll as been setup as described to generate the html and deploy site to gh-pages run

$ rake generate

$ rake deploy

In a few moments site will be live:

We then use CloudFlare as the DNS which serves the pages via secure HTTPS. On our domain (see custom domain below)

Auto deploy on commit trigger

In the deploy example above the site is generated locally then pushed to github pages. It's possible to automate this build to make everything happen (by magic!) in the cloud:

Travis CI with rake-jekyll can be used to automate a deployment of the website (build + push commit to gh-pages) afer a git push or pull reqest merge to master

To Setup

  • Create account & turn on Travis CI for the repo in the travis dashboard
  • Generate Github personal token or use
    • curl -u 'your_github_name' -d '{ "scopes": [ "public_repo"], "note": "Travis access"}'
    • Install Travis command line gem install travis
    • Encypt token and add to travis.yaml by running the following in website dir: $ travis encrypt GH_TOKEN=XXXXXX --add

Example travis.yaml to generate the site using rake generate then if generation is succesful deploy to gh pages branch with rake deploy:

language: ruby
sudo: false
cache: bundler
script: bundle exec rake generate
after_success: bundle exec rake deploy
    secure:  <encrypted GH token>

Use custom URL's

Add CNAME file with custom domain and point CNAME DNS to


Thanks to @balloob from for providing Octopress example. Home-assistant is an awesome open-sopurce Python3 home automation platform. See blog post for how to integrate with OpenEnergyMonitor emonPi