This repository has been archived by the owner on Oct 30, 2019. It is now read-only.
Documentation #88
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| ## Description | ||
| This Installs AppDaemon in a separate Venv onto this system. | ||
| For more information about AppDaemon see the [documentation.](http://appdaemon.readthedocs.io/en/latest/) | ||
|
|
||
| ## Installation | ||
| ``` | ||
| $ sudo hassbian-config install appdaemon | ||
| ``` | ||
|
|
||
| ## Upgrade | ||
| ``` | ||
| $ sudo hassbian-config upgrade appdaemon | ||
| ``` | ||
|
|
||
| ## Additional info | ||
| Running as: `homeassistant` | ||
| Configuration dir: `/home/homeassistant/appdaemon/` | ||
| Start service: `sudo systemctl start appdaemon@homeassistant.service` | ||
| Stop service: `sudo systemctl stop appdaemon@homeassistant.service` | ||
| Restart service: `sudo systemctl restart appdaemon@homeassistant.service` | ||
| Service status: `sudo systemctl status appdaemon@homeassistant.service` | ||
| Enter the virtual environment where AppDaemon is installed as `homeassistant`: | ||
| ``` | ||
| sudo su -s /bin/bash homeassistant | ||
| source /srv/homeassistant/bin/activate | ||
| ``` | ||
| When you are done, type `exit` to return to the `pi` user. | ||
|
|
||
| *** | ||
| The installation script was originally contributed by [@Landrash](https://github.com/landrash). | ||
| The upgrade script was originally contributed by [@Ludeeus](https://github.com/ludeeus). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| ## Description | ||
| This script adds an cron job to auto update you the WAN IP address for the defined domain. | ||
| Before running this script you should already have an Duck DNS account, during the installation you will be asked to supply your domain name and the token for your account. | ||
|
|
||
| ## Installation | ||
| ``` | ||
| $ sudo hassbian-config install duckdns | ||
| ``` | ||
|
|
||
| ## Additional info | ||
| Running as: `homeassistant` | ||
|
|
||
| If you choose to aslo generate SSL certificates with this you would need to add this under `http:` to your `configuration.yaml` | ||
| ``` | ||
| ssl_certificate: /home/homeassistant/dehydrated/certs/YOURDOMAIN.duckdns.org/fullchain.pem | ||
| ssl_key: /home/homeassistant/dehydrated/certs/YOURDOMAIN.duckdns.org/privkey.pem | ||
| base_url: YOURDOMAIN.duckdns.org:PORTNUMBER | ||
| ``` | ||
|
|
||
| *** | ||
| This script was originally contributed by [@Ludeeus](https://github.com/ludeeus). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| ## Description | ||
| This script will update the base OS on the system. | ||
|
|
||
| ## Upgrade | ||
| ``` | ||
| $ sudo hassbian-config upgrade hassbian | ||
| ``` | ||
|
|
||
| ## Additional info | ||
| Default username: `pi` | ||
| Default password: `raspberry` | ||
| Hostname: `hassbian` | ||
| SSH enabled: `true` | ||
|
|
||
| *** | ||
| This script was originally contributed by [@Landrash](https://github.com/Landrash). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| ## Description | ||
| This command is a package handler for the Hassbian scripts. All interactions for installing software should be handled through this command. Running the individual scripts to install software will no longer work as expected. | ||
|
|
||
| #### Usage | ||
| The hassbian-config command is invoked with: | ||
| ```bash | ||
| hassbian-config *command* *suite* | ||
| ``` | ||
| where command is one of: | ||
| - `install` | ||
|
There was a problem hiding this comment. Documentation about each command could be extended. |
||
| - `upgrade` | ||
| - `show` | ||
| - `log` | ||
| - `share-log` | ||
|
|
||
| ## Installation | ||
| ``` | ||
| $ curl https://api.github.com/repos/home-assistant/hassbian-scripts/releases/latest | grep "browser_download_url.*deb" | cut -d : -f 2,3 | tr -d \" | wget -qi - | ||
|
There was a problem hiding this comment. This should be rewritten to recommend installing the image instead to reflect that it exists. The command line option could be left as an alternative but have a warning that if it's used with anything else than Raspbian or Hassbian it might not function as intended. |
||
| $ sudo apt install -y ./hassbian* | ||
| ``` | ||
|
|
||
|
|
||
| ## Upgrade | ||
| ``` | ||
| $ sudo hassbian-config upgrade hassbian-script | ||
| ``` | ||
|
|
||
| ## Upgrade to dev branch | ||
| ``` | ||
| $ sudo hassbian-config upgrade hassbian-script-dev | ||
| ``` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| ## Description | ||
| This is a copy of the installation script run during first boot of your Raspberry Pi with the [Hassbian image](https://github.com/home-assistant/pi-gen/releases/latest) | ||
| And an easy way to upgrade Home Assistant to the newest version. | ||
|
|
||
| ## Installation | ||
| _**NB!: This is installed by Hassbian, and should not be run additionally**_ | ||
| ``` | ||
| $ sudo hassbian-config install homeassistant | ||
| ``` | ||
|
|
||
| ## Upgrade | ||
| ``` | ||
| $ sudo hassbian-config upgrade home-assistant | ||
| ``` | ||
|
|
||
| ## Additional info | ||
| Running as: `homeassistant` | ||
| Configuration dir: `/home/homeassistant/.homeassistant/` | ||
| Start service: `sudo systemctl start home-assistant@homeassistant.service` | ||
| Stop service: `sudo systemctl stop home-assistant@homeassistant.service` | ||
| Restart service: `sudo systemctl restart home-assistant@homeassistant.service` | ||
| Service status: `sudo systemctl status home-assistant@homeassistant.service` | ||
| Enter the virtual environment where Home Assistant is installed as `homeassistant`: | ||
| ``` | ||
| sudo su -s /bin/bash homeassistant | ||
| source /srv/homeassistant/bin/activate | ||
| ``` | ||
| When you are done, type `exit` to return to the `pi` user. | ||
|
|
||
| *** | ||
| The installation script was originally contributed by [@Landrash](https://github.com/landrash). | ||
| The upgrade scripts was originally contributed by [@Ludeeus](https://github.com/ludeeus). |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be extended a bit.
Documentation about the flags like
-y&-tare missing.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When this PR was created, those flags did not exist :)
They are added now :)