When you have all the prereqs in place, copy the hapush.cfg.example file to hapush.cfg then edit it to reflect your environment:
+When you have all the prereqs in place, copy the hapush.cfg.example file to hapush.cfg then edit it to reflect your environment:
ha_url = "http://192.168.1.10:8123"
ha_key = api_key
dash_host = "192.168.1.10:3030"
@@ -113,11 +113,11 @@ logfile = "/etc/hapush/hapush.log"
logfile is the path to where you want hapush to keep its logs. When run from the command line this is not used - log messages come out on the terminal. When running as a daemon this is where the log information will go. In the example above I created a directory specifically for hapush to run from, although there is no reason you can’t keep it in the hapush subdirectory of the cloned repository. For Docker installs this should be set to /app/hapush/hapush.log Running hapush
-For a manual installation you can then run hapush from the command line as follows:
+For a manual installation you can then run hapush from the command-line as follows:
$ ./hapush.py hapush.cfg
-For docker installs, hapush will be started automatically when you run the startup command.
+For Docker installs, hapush will be started automatically when you run the startup command.
If all is well, you should start to see hapush responding to events as they occur. For a docker installation you should see these messages in hapush/hapush.log.
2016-06-19 10:05:59,693 INFO Reading dashboard: /srv/hass/src/hadashboard/dashboards/main.erb
2016-06-19 10:06:12,362 INFO switch.wendy_bedside -> state = on, brightness = 50
diff --git a/docs/ecosystem/hadashboard/installation/index.html b/docs/ecosystem/hadashboard/installation/index.html
index 799ad3ee08..1c38cf6523 100644
--- a/docs/ecosystem/hadashboard/installation/index.html
+++ b/docs/ecosystem/hadashboard/installation/index.html
@@ -75,7 +75,7 @@
- Installation can be performed using Docker (Contributed by marijngiesen) or manually if Docker doesn’t work for you. We also have a Raspberry PI version of Docker contributed by snizzleorg
+ Installation can be performed using Docker (Contributed by marijngiesen) or manually if Docker doesn’t work for you. We also have a Raspberry Pi version of Docker contributed by snizzleorg.
Using Docker (Non Raspian)
Assuming you already have Docker installed, installation is fairly easy.
Clone the Repository
@@ -105,12 +105,11 @@
Docker on Raspberry Pi
-Raspberry pi needs to use a different docker build file so the build command is slightly different:
+Raspberry Pi needs to use a different Docker build file so the build command is slightly different:
$ sudo docker build -f Docker-raspi/Dockerfile -t hadashboard .
-Apart from that the other steps are identical.
-Note - this is pretty slow even on a PI3, be prepared for it to take an hour or two to build all of the extensions and install everything
+Apart from that the other steps are identical. Running Docker is pretty slow even on a PI3, be prepared for it to take an hour or two to build all of the extensions and install everything*
Manual Installation
Clone the Repository
Clone the hadashboard repository to the current local directory on your machine.
@@ -121,13 +120,17 @@
$ cd hadashboard
- 2. Install Dashing and prereqs
-Essentially, you want to make sure that you have Ruby installed on your local machine. Then, install the Dashing gem:
+ 2. Install Dashing and prerequirments
+Essentially, you want to make sure that you have Ruby installed on your local machine.
+For Debian based distribution do:
+$ sudo apt-get install rubygems
+
+
+Then, install the Dashing gem:
$ gem install dashing
-From your repository root, make sure that all dependencies are available.
-Note: on some systems you may also need to install bundler:
+From your repository root, make sure that all dependencies are available. On some systems you may also need to install bundler:
$ gem install bundler
@@ -135,8 +138,7 @@
$ bundle
-Bundle will now install all the ruby prereqs for running dashing.
-Note: Prereqs will vary across different machines. So far users have reported requirements for some additional installs to allow the bundle to complete succesfully:
+Bundle will now install all the ruby prerequirements for running dashing. Prerequirements will vary across different machines. So far users have reported requirements for some additional installs to allow the bundle to complete succesfully:
- ruby-dev -
sudo apt-get install ruby-dev
- node-js -
sudo apt-get install nodejs
@@ -144,15 +146,15 @@
- execjs gem -
gem install execjs
You will need to research what works on your particular architecture and also bear in mind that version numbers may change over time.
-Note: This is currently running on various versions of Ruby and there are no strong dependencies however your mileage may vary.
+This is currently running on various versions of Ruby and there are no strong dependencies however your mileage may vary.
Updating configuration (Manual and Docker)
-Next, in the ./lib directory, copy the ha_conf.rb.example file to ha_conf.rb and edit its settings to reflect your installation, pointing to the machine Home Assistant is running on and adding your api_key.
+Next, in the ./lib directory, copy the ha_conf.rb.example file to ha_conf.rb and edit its settings to reflect your installation, pointing to the machine Home Assistant is running on and adding your API key.
$ha_url = "http://192.168.1.10:8123"
$ha_apikey = "your key"
- $ha_url is a reference to your home assistant installation and must include the correct port number and scheme (http:// or https:// as appropriate)$ha_url is a reference to your Home Assistant installation and must include the correct port number and scheme (http:// or https:// as appropriate)$ha_apikey should be set to your key if you have one, otherwise it can remain blank.
The file also contains example newsfeeds for the News widget:
diff --git a/docs/ecosystem/hadashboard/reboot/index.html b/docs/ecosystem/hadashboard/reboot/index.html
index c5ace62cf9..563b58f640 100644
--- a/docs/ecosystem/hadashboard/reboot/index.html
+++ b/docs/ecosystem/hadashboard/reboot/index.html
@@ -75,9 +75,9 @@
- To run Dashing and hapush at reboot, I have provided sample init scripts in the ./init directory. These have been tested on a Raspberry Pi - your mileage may vary on other systems.
-Instructions for automatically starting a docker install can be found here.
-For docker you may also want to use docker-compose - there is a sample compose file in the ./init directory.
+ To run Dashing and hapush at reboot, checkout out the sample init scripts in the ./init directory. These have been tested on a Raspberry Pi - your mileage may vary on other systems.
+Instructions for automatically starting a Docker installation can be found here.
+For Docker you may also want to use docker-compose - there is a sample compose file in the ./init directory.