jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Minor updates

Browse source
This commit is contained in:
Fabian Affolter 2017-06-26 18:39:20 +02:00
parent 14d2c3ce93
commit 76dd3fdff5
No known key found for this signature in database
GPG key ID: DDF3D6F44AAB1336
4 changed files with 18 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

25
source/_docs/ecosystem/hadashboard/installation.markdown
View file

@ -10,13 +10,14 @@ footer: true
redirect_from: /ecosystem/hadashboard/installation/
---
Installation can be performed using Docker (Contributed by [marijngiesen](https://github.com/marijngiesen)) or manually if Docker doesn't work for you. We also have a Raspberry PI version of Docker contributed by [snizzleorg](https://community.home-assistant.io/users/snizzleorg/activity)
Installation can be performed using Docker (Contributed by [marijngiesen](https://github.com/marijngiesen)) or manually if Docker doesn't work for you. We also have a Raspberry Pi version of Docker contributed by [snizzleorg](https://community.home-assistant.io/users/snizzleorg/activity).
## {% linkable_title Using Docker (Non Raspian) %}
Assuming you already have Docker installed, installation is fairly easy.
### {% linkable_title Clone the Repository %}
Clone the **hadashboard** repository to the current local directory on your machine.
``` bash
@ -57,15 +58,13 @@ By default, the docker instance should pick up your timezone but if you want to
### {% linkable_title 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:
```bash
$ 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*
## {% linkable_title Manual Installation %}
@ -82,7 +81,7 @@ Change your working directory to the repository root. Moving forward, we will be
$ cd hadashboard
```
### {% linkable_title 2. Install Dashing and prereqs %}
### {% linkable_title 2. Install Dashing and prerequirments %}
Essentially, you want to make sure that you have Ruby installed on your local machine.
@ -98,9 +97,7 @@ 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`:
```bash
$ gem install bundler
@ -112,9 +109,7 @@ When installed run it:
$ 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`
@ -123,18 +118,18 @@ Note: Prereqs will vary across different machines. So far users have reported re
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.
## {% linkable_title 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.
```ruby
$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: