Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 76dd3fd

Browse files
committed
Minor updates
1 parent 14d2c3c commit 76dd3fd

File tree

4 files changed

+18
-23
lines changed

4 files changed

+18
-23
lines changed

source/_docs/ecosystem/hadashboard/hapush.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ $ sudo pip3 install --upgrade requests
4343

4444
## {% linkable_title Configuring hapush (all installation methods) %}
4545

46-
When you have all the prereqs in place, copy the hapush.cfg.example file to hapush.cfg then edit it to reflect your environment:
46+
When you have all the prereqs in place, copy the `hapush.cfg.example` file to `hapush.cfg` then edit it to reflect your environment:
4747

4848
```
4949
ha_url = "http://192.168.1.10:8123"
@@ -61,13 +61,13 @@ logfile = "/etc/hapush/hapush.log"
6161

6262
## {% linkable_title Running hapush %}
6363

64-
For a manual installation you can then run hapush from the command line as follows:
64+
For a manual installation you can then run `hapush` from the command-line as follows:
6565

6666
```bash
6767
$ ./hapush.py hapush.cfg
6868
```
6969

70-
For docker installs, hapush will be started automatically when you run the startup command.
70+
For Docker installs, hapush will be started automatically when you run the startup command.
7171

7272
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`.
7373

source/_docs/ecosystem/hadashboard/installation.markdown

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,14 @@ footer: true
1010
redirect_from: /ecosystem/hadashboard/installation/
1111
---
1212

13-
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)
13+
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).
1414

1515
## {% linkable_title Using Docker (Non Raspian) %}
1616

1717
Assuming you already have Docker installed, installation is fairly easy.
1818

1919
### {% linkable_title Clone the Repository %}
20+
2021
Clone the **hadashboard** repository to the current local directory on your machine.
2122

2223
``` bash
@@ -57,15 +58,13 @@ By default, the docker instance should pick up your timezone but if you want to
5758

5859
### {% linkable_title Docker on Raspberry Pi %}
5960

60-
Raspberry pi needs to use a different docker build file so the build command is slightly different:
61+
Raspberry Pi needs to use a different Docker build file so the build command is slightly different:
6162

6263
```bash
6364
$ sudo docker build -f Docker-raspi/Dockerfile -t hadashboard .
6465
```
6566

66-
Apart from that the other steps are identical.
67-
68-
*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*
67+
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*
6968

7069
## {% linkable_title Manual Installation %}
7170

@@ -82,7 +81,7 @@ Change your working directory to the repository root. Moving forward, we will be
8281
$ cd hadashboard
8382
```
8483

85-
### {% linkable_title 2. Install Dashing and prereqs %}
84+
### {% linkable_title 2. Install Dashing and prerequirments %}
8685

8786
Essentially, you want to make sure that you have Ruby installed on your local machine.
8887

@@ -98,9 +97,7 @@ Then, install the Dashing gem:
9897
$ gem install dashing
9998
```
10099

101-
From your repository root, make sure that all dependencies are available.
102-
103-
Note: on some systems you may also need to install bundler:
100+
From your repository root, make sure that all dependencies are available. On some systems you may also need to install `bundler`:
104101

105102
```bash
106103
$ gem install bundler
@@ -112,9 +109,7 @@ When installed run it:
112109
$ bundle
113110
```
114111

115-
Bundle will now install all the ruby prereqs for running dashing.
116-
117-
Note: Prereqs will vary across different machines. So far users have reported requirements for some additional installs to allow the bundle to complete succesfully:
112+
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:
118113

119114
- ruby-dev - `sudo apt-get install ruby-dev`
120115
- node-js - `sudo apt-get install nodejs`
@@ -123,18 +118,18 @@ Note: Prereqs will vary across different machines. So far users have reported re
123118

124119
You will need to research what works on your particular architecture and also bear in mind that version numbers may change over time.
125120

126-
Note: This is currently running on various versions of Ruby and there are no strong dependencies however your mileage may vary.
121+
This is currently running on various versions of Ruby and there are no strong dependencies however your mileage may vary.
127122

128123
## {% linkable_title Updating configuration (Manual and Docker) %}
129124

130-
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.
125+
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.
131126

132127
```ruby
133128
$ha_url = "http://192.168.1.10:8123"
134129
$ha_apikey = "your key"
135130
```
136131

137-
- `$ha_url` is a reference to your home assistant installation and must include the correct port number and scheme (`http://` or `https://` as appropriate)
132+
- `$ha_url` is a reference to your Home Assistant installation and must include the correct port number and scheme (`http://` or `https://` as appropriate)
138133
- `$ha_apikey` should be set to your key if you have one, otherwise it can remain blank.
139134

140135
The file also contains example newsfeeds for the News widget:

source/_docs/ecosystem/hadashboard/reboot.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ footer: true
1010
redirect_from: /ecosystem/hadashboard/reboot/
1111
---
1212

13-
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.
13+
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.
1414

15-
Instructions for automatically starting a docker install can be found [here](https://docs.docker.com/engine/admin/host_integration/).
15+
Instructions for automatically starting a Docker installation can be found [here](https://docs.docker.com/engine/admin/host_integration/).
1616

17-
For docker you may also want to use docker-compose - there is a sample compose file in the `./init` directory.
17+
For Docker you may also want to use `docker-compose` - there is a sample compose file in the `./init` directory.

source/_docs/ecosystem/hadashboard/updating.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ To update the dashboard after new code has been released, just run the following
1616
$ git pull origin
1717
```
1818

19-
For some releases you may also need to rerun the bundle command:
19+
For some releases you may also need to rerun the `bundle` command:
2020

2121
``` bash
2222
$ bundle
2323
```
2424

25-
For docker users, you will also need to rerun the docker build process.
25+
For Docker users, you will also need to rerun the Docker build process.

0 commit comments

Comments
 (0)