This repository has been archived by the owner on Oct 30, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 98
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rewrite and restructure of documentation.
- Loading branch information
Showing
17 changed files
with
407 additions
and
218 deletions.
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 [email protected]` | ||
Stop service: `sudo systemctl stop [email protected]` | ||
Restart service: `sudo systemctl restart [email protected]` | ||
Service status: `sudo systemctl status [email protected]` | ||
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,38 @@ | ||
## 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* *flag(optional)* | ||
``` | ||
where command is one of: | ||
- `install` Use this to install an suite. | ||
- `upgrade` Use this to upgrade an installed suite. | ||
- `show` This will show you all available suites. | ||
- `log` This will show you the log of last hassbian-config operation. | ||
- `share-log` This will generate an hastebin link of the last hassbian-config operation. | ||
- `-V` This will show you the installed version of `hassbian-config`. | ||
|
||
Optional flags: | ||
- `-y` This will accept defaults on scripts that allow this. | ||
- `-f` This will force run an script. This is useful if you need to reinstall a package. | ||
|
||
## Installation | ||
This package is pre-installed on the [HASSbian image](https://github.com/home-assistant/pi-gen/releases). | ||
This package can be used with Raspbian lite but it's not recommended. | ||
``` | ||
$ 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 - | ||
$ 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 [email protected]` | ||
Stop service: `sudo systemctl stop [email protected]` | ||
Restart service: `sudo systemctl restart [email protected]` | ||
Service status: `sudo systemctl status [email protected]` | ||
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.