From 4c4a6533d8aeb11ef330ae70afda9f643093e6f4 Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sun, 30 Sep 2018 23:21:49 +0200 Subject: [PATCH 01/18] =?UTF-8?q?=F0=9F=93=9A=20Cleanup=20of=20the=20main?= =?UTF-8?q?=20page=20(README.md)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 56 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 34 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 8cc77752..d7e3a702 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,46 @@ -## Hassbian-scripts -These are the scripts used in the [Hassbian](https://github.com/home-assistant/pi-gen) image. -The scripts in this repository where made to be used with the Hassbian image and the included Home Assistant instance. +# Hassbian-scripts +These are the scripts used in the [Hassbian][hassbian] image. +The scripts in this repository where made to be used with the Hassbian image +and the included Home Assistant instance. ## The included scripts -The following scripts are currently included. You can view the documentation below for usage and instructions. + +The following scripts are currently included. You can view the documentation +below for usage and instructions. + -* [hassbian-config](/docs/hassbian_config.md) - * [AppDaemon](/docs/appdaemon.md) - * [Cloud9](/docs/cloud9.md) - * [Duck DNS](/docs/duckdns.md) - * [Hassbian](/docs/hassbian.md) - * [Home Assistant](/docs/homeassistant.md) - * [HUE](/docs/hue.md) - * [LibCEC](/docs/libcec.md) - * [MariaDB](/docs/mariadb.md) - * [Mosquitto](/docs/mosquitto.md) - * [PostgreSQL](/docs/postgresql.md) - * [MS SQL](/docs/mssql.md) - * [RaZberry ](/docs/razberry.md) - * [Samba](/docs/samba.md) - * [Trådfri](/docs/tradfri.md) - * [Webterminal](/docs/webterminal.md) -* [Changelog](https://github.com/home-assistant/hassbian-scripts/releases) + +- [hassbian-config](/docs/hassbian_config.md) + - [AppDaemon](/docs/appdaemon.md) + - [Cloud9](/docs/cloud9.md) + - [Duck DNS](/docs/duckdns.md) + - [Hassbian](/docs/hassbian.md) + - [Home Assistant](/docs/homeassistant.md) + - [HUE](/docs/hue.md) + - [LibCEC](/docs/libcec.md) + - [MariaDB](/docs/mariadb.md) + - [Mosquitto](/docs/mosquitto.md) + - [PostgreSQL](/docs/postgresql.md) + - [MS SQL](/docs/mssql.md) + - [RaZberry](/docs/razberry.md) + - [Samba](/docs/samba.md) + - [Trådfri](/docs/tradfri.md) + - [Webterminal](/docs/webterminal.md) +- [Changelog][changelog] *** + ## Raspbian Jessie -If this package is used with a Debian Jessie based distribution then you need to uncomment the source repositories in `/etc/apt/sources.list` + +If this package is used with a Debian Jessie based distribution then you need +to uncomment the source repositories in `/etc/apt/sources.list` ```text # Uncomment line below then 'apt-get update' to enable 'apt-get source' deb-src http://archive.raspbian.org/raspbian/ jessie main contrib non-free rpi ``` + + +[changelog]: https://github.com/home-assistant/hassbian-scripts/releases +[hassbian]: https://github.com/home-assistant/pi-gen From f66e975bde080e2cb661ecd842dc749638d2cbae Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sun, 30 Sep 2018 23:22:40 +0200 Subject: [PATCH 02/18] =?UTF-8?q?=F0=9F=93=9AAppdaemon?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/appdaemon.md | 37 +++++++++++++++++++++++++------------ 1 file changed, 25 insertions(+), 12 deletions(-) diff --git a/docs/appdaemon.md b/docs/appdaemon.md index 776dbef6..d2d74976 100644 --- a/docs/appdaemon.md +++ b/docs/appdaemon.md @@ -1,18 +1,22 @@ -## 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/) +# AppDaemon + +This Installs AppDaemon in a separate Venv onto this system. +For more information about AppDaemon see the [documentation.][appdaemon-docs] ## Installation + ```bash -$ sudo hassbian-config install appdaemon +sudo hassbian-config install appdaemon ``` ## Upgrade + ```bash -$ sudo hassbian-config upgrade appdaemon +sudo hassbian-config upgrade appdaemon ``` ## Additional info + Description | Command/value :--- | :--- Running as: | homeassistant @@ -21,20 +25,29 @@ 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`: + ```bash -$ sudo su -s /bin/bash homeassistant -$ source /srv/appdaemon/bin/activate +sudo su -s /bin/bash homeassistant +source /srv/appdaemon/bin/activate ``` + When you are done, type `exit` to return to the `pi` user. -To manually start AppDaemon, enter the AppDaemon virtual environment as described above, and then type this to start it: +To manually start AppDaemon, enter the AppDaemon virtual environment as +described above, and then type this to start it: + ```bash -$ appdaemon -c /home/homeassistant/appdaemon/ +appdaemon -c /home/homeassistant/appdaemon/ ``` *** -The installation script was originally contributed by [@Landrash](https://github.com/landrash). -The upgrade script was originally contributed by [@Ludeeus](https://github.com/ludeeus). + +The installation script was originally contributed by [@Landrash][landrash]. +The upgrade script was originally contributed by [@Ludeeus][ludeeus]. + + +[appdaemon-docs]: http://appdaemon.readthedocs.io/en/latest/ +[landrash]: https://github.com/landrash +[ludeeus]: https://github.com/ludeeus From b64dfe309e5dc875e08fe8c9072932b5a106a02f Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sun, 30 Sep 2018 23:23:31 +0200 Subject: [PATCH 03/18] =?UTF-8?q?=F0=9F=93=9A=20Cloud9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/cloud9.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/docs/cloud9.md b/docs/cloud9.md index 62f76b4b..2f6dfc9f 100644 --- a/docs/cloud9.md +++ b/docs/cloud9.md @@ -1,24 +1,28 @@ -## Description -Cloud9 SDK is an webservice IDE that makes it easy to manage your configuration files. +# Cloud9 -*This suite can't be installed on Raspberry Pi Zero* +Cloud9 SDK is an webservice IDE that makes it easy to manage your configuration files. +**This suite can't be installed on Raspberry Pi Zero** ## Installation + ```bash -$ sudo hassbian-config install cloud9 +sudo hassbian-config install cloud9 ``` ## Upgrade + ```bash -$ sudo hassbian-config upgrade cloud9 +sudo hassbian-config upgrade cloud9 ``` ## Remove + ```bash -$ sudo hassbian-config remove cloud9 +sudo hassbian-config remove cloud9 ``` ## Additional info + Description | Command/value :--- | :--- Running as: | homeassistant @@ -28,7 +32,10 @@ Start service: | `sudo systemctl start cloud9@homeassistant.service` Stop service: | `sudo systemctl stop cloud9@homeassistant.service` Restart service: | `sudo systemctl restart cloud9@homeassistant.service` Service status: | `sudo systemctl status cloud9@homeassistant.service` -| *** -This script was originally contributed by [@Ludeeus](https://github.com/ludeeus). + +This script was originally contributed by [@Ludeeus][ludeeus]. + + +[ludeeus]: https://github.com/ludeeus From eea176d8dfcd303ec069039bfe136ffabc082850 Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sun, 30 Sep 2018 23:26:26 +0200 Subject: [PATCH 04/18] =?UTF-8?q?=F0=9F=93=9ADuck=20DNS?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/duckdns.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/docs/duckdns.md b/docs/duckdns.md index 8d29ae06..94c4532a 100644 --- a/docs/duckdns.md +++ b/docs/duckdns.md @@ -1,21 +1,34 @@ -## 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. +# Duck DNS + +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][duckdns], during the installation you will be asked to +supply your domain name and the token for your account. ## Installation -``` -$ sudo hassbian-config install duckdns + +```bash +sudo hassbian-config install duckdns ``` ## Additional info + Running as: `homeassistant` -If you choose to also generate SSL certificates with this you would need to add this under `http:` to your `configuration.yaml` -``` +If you choose to also generate SSL certificates with this you would need to +add this under `http:` to your `configuration.yaml` + +```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 script was originally contributed by [@Ludeeus][ludeeus]. + + +[duckdns]: http://www.duckdns.org +[ludeeus]: https://github.com/ludeeus From a3cfcc74a02163bc2a27e013b71befe9378a4284 Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sun, 30 Sep 2018 23:29:50 +0200 Subject: [PATCH 05/18] =?UTF-8?q?=F0=9F=93=9Ahassbian-config?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/hassbian_config.md | 49 +++++++++++++++++++++++++---------------- 1 file changed, 30 insertions(+), 19 deletions(-) diff --git a/docs/hassbian_config.md b/docs/hassbian_config.md index 3f92f3ca..6a86882a 100644 --- a/docs/hassbian_config.md +++ b/docs/hassbian_config.md @@ -1,13 +1,20 @@ -## 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._ +# hassbian-config + +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 -#### Usage The hassbian-config command is invoked with: + ```bash hassbian-config *command* *suite* *flag(optional)* ``` -where command is one of: + +where `*command*` is one of: Command | Description :--- | :--- `install` | Use this to install an suite. @@ -16,9 +23,8 @@ Command | Description `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. `show-installed` | Generates a list of installed suites. -| -Optional flags: +**Optional flags:** Flag | Alt. flag | Description :--- | :--- | :--- `--accept` | `-Y` | This will accept defaults on scripts that allow this. @@ -26,29 +32,34 @@ Flag | Alt. flag | Description `--debug` | `-D` | This will output every comand to the console. `--beta` |`-B` | This will install the current beta version if implemented. `--dev` | | This will install the current development version if implemented. -| -Other available commands: +**Other available commands:** Command | Alt. command | Description :--- | :--- | :--- `--version` | - `-V` | This will show you the installed version of `hassbian-config`. `--help` | - `-H` | Shows help for the tool, with all available commands. ## 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* -``` +This package is pre-installed on the [Hassbian image][hassbian-image]. +This package *can* be used with Raspbian lite but it's not recommended. -## Upgrade +```bash +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* ``` -$ sudo hassbian-config upgrade hassbian-script + +## Upgrade + +```bash +sudo hassbian-config upgrade hassbian-script ``` ## Upgrade to dev branch + +```bash +sudo hassbian-config upgrade hassbian-script --dev ``` -$ sudo hassbian-config upgrade hassbian-script --dev -``` + + +[hassbian-image]: https://github.com/home-assistant/pi-gen/releases From 9373671776e5ebe72359fd41b097dd87ff5b63a5 Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sun, 30 Sep 2018 23:32:10 +0200 Subject: [PATCH 06/18] :books: hassbian --- docs/hassbian.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/hassbian.md b/docs/hassbian.md index 040bcb84..92dde8fc 100644 --- a/docs/hassbian.md +++ b/docs/hassbian.md @@ -1,19 +1,25 @@ -## Description +# Hassbian + This script will update the base OS on the system. ## Upgrade -``` -$ sudo hassbian-config upgrade hassbian + +```bash +sudo hassbian-config upgrade hassbian ``` ## Additional info + Description | Command/value :--- | :--- Running as: | pi Default password: | raspberry Hostname: | hassbian SSH enabled: | true -| *** -This script was originally contributed by [@Landrash](https://github.com/Landrash). + +The installation script was originally contributed by [@Landrash][landrash]. + + +[landrash]: https://github.com/landrash From 6fd31acbe08cf2a30174e87f37aac271806deefe Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sun, 30 Sep 2018 23:36:13 +0200 Subject: [PATCH 07/18] :books: Homeassistant --- docs/homeassistant.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/homeassistant.md b/docs/homeassistant.md index c5ffeea7..a0910e7b 100644 --- a/docs/homeassistant.md +++ b/docs/homeassistant.md @@ -1,6 +1,7 @@ -## Description +# Home Assistant -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)\ +This is a copy of the installation script run during first +boot of your Raspberry Pi with the [Hassbian image][hassbian-image] And an easy way to upgrade Home Assistant to the newest version. ## Installation @@ -36,6 +37,7 @@ sudo hassbian-config upgrade homeassistant=0.65.6 ``` ## Additional info + Description | Command/value :--- | :--- Running as: | homeassistant @@ -75,5 +77,11 @@ hacheckconf | `source /srv/homeassistant/bin/activate;hass --script check_config hapyshell | `source /srv/homeassistant/bin/activate;cd ~/.homeassistant` *** -The installation script was originally contributed by [@Landrash](https://github.com/landrash). -The upgrade scripts was originally contributed by [@Ludeeus](https://github.com/ludeeus). \ No newline at end of file + +The installation script was originally contributed by [@Landrash][landrash]. +The upgrade script was originally contributed by [@Ludeeus][ludeeus]. + + +[hassbian-image]: https://github.com/home-assistant/pi-gen/releases/latest +[landrash]: https://github.com/landrash +[ludeeus]: https://github.com/ludeeus From 9cc67207ce92fce059efb9ec2ce9944968881428 Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sun, 30 Sep 2018 23:37:17 +0200 Subject: [PATCH 08/18] :books: Hue --- docs/hue.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/hue.md b/docs/hue.md index b7b00f09..45ecbec2 100644 --- a/docs/hue.md +++ b/docs/hue.md @@ -1,10 +1,17 @@ -## Description -Configures the Python executable to allow usage of low numbered port numbers for use with Amazon Echo, Google Home and Mycroft.ai. +# Hue + +Configures the Python executable to allow usage of low numbered port numbers +for use with Amazon Echo, Google Home and Mycroft.ai. ## Installation -``` -$ sudo hassbian-config install hue + +```bash +sudo hassbian-config install hue ``` *** -This script was originally contributed by [@Landrash](https://github.com/Landrash). + +The installation script was originally contributed by [@Landrash][landrash]. + + +[landrash]: https://github.com/landrash From 2db5d60bcc4e44ef0c90d2c1bcf8d3716a52a5bd Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sun, 30 Sep 2018 23:39:20 +0200 Subject: [PATCH 09/18] :books: LibCEC --- docs/libcec.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/docs/libcec.md b/docs/libcec.md index e06e0c4f..9fe3aeb2 100644 --- a/docs/libcec.md +++ b/docs/libcec.md @@ -1,20 +1,30 @@ -## Description +# LibCEC + **This script is currently broken upstream since it currently doesn't build properly for Python >3.4** This script installs libcec and it dependencies. Further more this script symlinks the system wide packages to the Home Assistant venv so they can be used with Home Assistant. ## Installation -``` -$ sudo hassbian-config install libcec + +```bash +sudo hassbian-config install libcec ``` ## Upgrade -No script available, maybe you could write one?\ -If so, add an PR here when you are done:\ -[homeassistant/hassbian-scripts](https://github.com/home-assistant/hassbian-scripts/pulls) + +No script available, maybe you could write one? +If so, add an PR here when you are done: +[homeassistant/hassbian-scripts][repo] ## Additional info + Running as: `homeassistant` -For more information about this, se the [component page](https://home-assistant.io/components/hdmi_cec/) +For more information about this, se the [component page][component] *** -This script was originally contributed by [@Landrash](https://github.com/Landrash). + +The installation script was originally contributed by [@Landrash][landrash]. + + +[component]: https://home-assistant.io/components/hdmi_cec/ +[landrash]: https://github.com/landrash +[repo]: https://github.com/home-assistant/hassbian-scripts/pulls From 14511f2d5391fd7bf0fafa3b4ff645151df29b6b Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sun, 30 Sep 2018 23:41:25 +0200 Subject: [PATCH 10/18] :books: MariaDB --- docs/mariadb.md | 43 ++++++++++++++++++++++++++++--------------- 1 file changed, 28 insertions(+), 15 deletions(-) diff --git a/docs/mariadb.md b/docs/mariadb.md index c3133585..f2515a42 100644 --- a/docs/mariadb.md +++ b/docs/mariadb.md @@ -1,26 +1,39 @@ -## Description -This script installs MariaDB and it's dependencies for use with the recorder component in Home Assistant. No database or database user is created during this setup and will need to be created manually. +# MariaDB + +This script installs MariaDB and it's dependencies for use with the +[recorder][recorder] component in Home Assistant. No database or database user +is created during this setup and will need to be created manually. ## Installation -``` -$ sudo hassbian-config install mariadb + +```bash +sudo hassbian-config install mariadb ``` ## Upgrade -No script available, maybe you could write one?\ -If so, add an PR here when you are done:\ -[homeassistant/hassbian-scripts](https://github.com/home-assistant/hassbian-scripts/pulls) + +No script available, maybe you could write one? +If so, add an PR here when you are done: +[homeassistant/hassbian-scripts][repo] ## Additional info + Example for creating database: -``` -$ sudo mysql -u root -p -$ CREATE DATABASE homeassistant; -$ CREATE USER 'homeassistantuser' IDENTIFIED BY 'password'; -$ GRANT ALL PRIVILEGES ON homeassistant.* TO 'homeassistantuser'; -$ FLUSH PRIVILEGES; -$ exit + +```sql +sudo mysql -u root -p +CREATE DATABASE homeassistant; +CREATE USER 'homeassistantuser' IDENTIFIED BY 'password'; +GRANT ALL PRIVILEGES ON homeassistant.* TO 'homeassistantuser'; +FLUSH PRIVILEGES; +exit ``` *** -This script was originally contributed by [@Landrash](https://github.com/Landrash). + +The installation script was originally contributed by [@Landrash][landrash]. + + +[landrash]: https://github.com/landrash +[recorder]: https://www.home-assistant.io/components/recorder +[repo]: https://github.com/home-assistant/hassbian-scripts/pulls From 33fe5cb503289ac16e27a0cd16a21d40a2020bf2 Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sun, 30 Sep 2018 23:43:51 +0200 Subject: [PATCH 11/18] :books: Mosquitto --- docs/mosquitto.md | 30 +++++++++++++++++++++--------- 1 file changed, 21 insertions(+), 9 deletions(-) diff --git a/docs/mosquitto.md b/docs/mosquitto.md index e635635e..42a2b202 100644 --- a/docs/mosquitto.md +++ b/docs/mosquitto.md @@ -1,19 +1,25 @@ -## Description -This script installs the MQTT Mosquitto server. Repository from the Mosquitto project is added to package system and the official packages for Debian are installed. Additionally, this script helps you create your first MQTT user that can be used with Home Assistant. +# Mosquitto +This script installs the MQTT Mosquitto server. Repository from the Mosquitto +project is added to package system and the official packages for Debian are +installed. Additionally, this script helps you create your first MQTT user +that can be used with Home Assistant. *This suite can't be installed on Raspberry Pi Zero* ## Installation -``` -$ sudo hassbian-config install mosquitto + +```bash +sudo hassbian-config install mosquitto ``` ## Upgrade -No script available, maybe you could write one?\ -If so, add an PR here when you are done:\ -[homeassistant/hassbian-scripts](https://github.com/home-assistant/hassbian-scripts/pulls) + +No script available, maybe you could write one? +If so, add an PR here when you are done: +[homeassistant/hassbian-scripts][repo] ## Additional info + Description | Command/value :--- | :--- Running as: | root @@ -25,7 +31,13 @@ Start service: | `sudo systemctl start mosquitto.service` Stop service: | `sudo systemctl stop mosquitto.service` Restart service: | `sudo systemctl restart mosquitto.service` Service status: | `sudo systemctl status mosquitto.service` -| *** -This script was originally contributed by [@dale3h](https://github.com/dale3h) and has been modified by [@Landrash](https://github.com/Landrash). + +This script was originally contributed by [@dale3h][dale3h] and has been +modified by [@Landrash][landrash]. + + +[dale3h]: https://github.com/dale3h +[landrash]: https://github.com/landrash +[repo]: https://github.com/home-assistant/hassbian-scripts/pulls From e0b93ad6da5a51cfe653c8b6f1102752bfc383fe Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sun, 30 Sep 2018 23:46:21 +0200 Subject: [PATCH 12/18] :books: MS SQL --- docs/mosquitto.md | 2 +- docs/mssql.md | 42 ++++++++++++++++++++++++++++-------------- 2 files changed, 29 insertions(+), 15 deletions(-) diff --git a/docs/mosquitto.md b/docs/mosquitto.md index 42a2b202..ef2551b4 100644 --- a/docs/mosquitto.md +++ b/docs/mosquitto.md @@ -22,7 +22,7 @@ If so, add an PR here when you are done: Description | Command/value :--- | :--- -Running as: | root +Running as: | root Default username: | pi Default password: | raspberry Default port: | 1883 diff --git a/docs/mssql.md b/docs/mssql.md index 65f2793a..b8766e22 100644 --- a/docs/mssql.md +++ b/docs/mssql.md @@ -1,26 +1,40 @@ -## Description -This script installs the tools needed to connect to a MS SQL database and it's dependencies for use with the recorder component in Home Assistant. No database or database user is created during this setup and will need to be created manually. +# MS SQL + +This script installs the tools needed to connect to a MS SQL database +and it's dependencies for use with the [recorder][recorder] component in +Home Assistant. No database or database user is created during this setup and +will need to be created manually. ## Installation -``` -$ sudo hassbian-config install mssql + +```bash +sudo hassbian-config install mssql ``` ## Upgrade + No script available, maybe you could write one? -If so, add an PR here when you are done:\ -[homeassistant/hassbian-scripts](https://github.com/home-assistant/hassbian-scripts/pulls) +If so, add an PR here when you are done: +[homeassistant/hassbian-scripts][repo] ## Additional info + Example for creating database: -``` -$ sudo mysql -u root -p -$ CREATE DATABASE homeassistant; -$ CREATE USER 'homeassistantuser' IDENTIFIED BY 'password'; -$ GRANT ALL PRIVILEGES ON homeassistant.* TO 'homeassistantuser'; -$ FLUSH PRIVILEGES; -$ exit + +```sql +sudo mysql -u root -p +CREATE DATABASE homeassistant; +CREATE USER 'homeassistantuser' IDENTIFIED BY 'password'; +GRANT ALL PRIVILEGES ON homeassistant.* TO 'homeassistantuser'; +FLUSH PRIVILEGES; +exit ``` *** -This script was originally contributed by [@Landrash](https://github.com/Landrash). + +The installation script was originally contributed by [@Landrash][landrash]. + + +[landrash]: https://github.com/landrash +[recorder]: https://www.home-assistant.io/components/recorder +[repo]: https://github.com/home-assistant/hassbian-scripts/pulls From c45e9f510a140d43f59a2609a48b1236a531c143 Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sun, 30 Sep 2018 23:47:42 +0200 Subject: [PATCH 13/18] :books: PostgreSQL --- docs/postgresql.md | 43 ++++++++++++++++++++++++++++--------------- 1 file changed, 28 insertions(+), 15 deletions(-) diff --git a/docs/postgresql.md b/docs/postgresql.md index 60f70e0e..fcd809d9 100644 --- a/docs/postgresql.md +++ b/docs/postgresql.md @@ -1,26 +1,39 @@ -## Description -This script installs PostgreSQL and it's dependencies for use with the recorder component in Home Assistant. No database or database user is created during this setup and will need to be created manually. +# PostgreSQL + +This script installs PostgreSQL and it's dependencies for use with the +[recorder][recorder] component in Home Assistant. No database or database user +is created during this setup and will need to be created manually. ## Installation -``` -$ sudo hassbian-config install postgresql + +```bash +sudo hassbian-config install postgresql ``` ## Upgrade -No script available, maybe you could write one?\ -If so, add an PR here when you are done:\ -[homeassistant/hassbian-scripts](https://github.com/home-assistant/hassbian-scripts/pulls) + +No script available, maybe you could write one? +If so, add an PR here when you are done: +[homeassistant/hassbian-scripts][repo] ## Additional info + Example for creating database: -``` -$ sudo mysql -u root -p -$ CREATE DATABASE homeassistant; -$ CREATE USER 'homeassistantuser' IDENTIFIED BY 'password'; -$ GRANT ALL PRIVILEGES ON homeassistant.* TO 'homeassistantuser'; -$ FLUSH PRIVILEGES; -$ exit + +```sql +sudo mysql -u root -p +CREATE DATABASE homeassistant; +CREATE USER 'homeassistantuser' IDENTIFIED BY 'password'; +GRANT ALL PRIVILEGES ON homeassistant.* TO 'homeassistantuser'; +FLUSH PRIVILEGES; +exit ``` *** -This script was originally contributed by [@Landrash](https://github.com/Landrash). + +The installation script was originally contributed by [@Landrash][landrash]. + + +[landrash]: https://github.com/landrash +[recorder]: https://www.home-assistant.io/components/recorder +[repo]: https://github.com/home-assistant/hassbian-scripts/pulls From 7b6b95e1ca79a02534711d02f55ac1da1dbfbde1 Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sun, 30 Sep 2018 23:51:50 +0200 Subject: [PATCH 14/18] :books: Python --- docs/python.md | 31 +++++++++++++++++++++---------- 1 file changed, 21 insertions(+), 10 deletions(-) diff --git a/docs/python.md b/docs/python.md index a2cbeb33..ba198998 100644 --- a/docs/python.md +++ b/docs/python.md @@ -1,19 +1,30 @@ -## Description -It is not recomended running this script.\ -**It is recomended to download and install the newest [Hassbian image](https://github.com/home-assistant/pi-gen/releases/latest) instead of running this.**\ +# Pyhton + +It is not recomended running this script. +**It is recomended to download and install the newest +[Hassbian image][hassbian-image] instead of running this.** + This script will upgrade Python to the latest stable version.\ It will also create a new virtual environment to be used for Home Assistant.\ -_This upgrade takes long time to finish._\ -_This prosess takes about a hour on an Raspberry Pi 3_ +_This upgrade takes long time to finish, on an Raspberry Pi 3 +this took about 1 hour._ ## Upgrade -``` -$ sudo hassbian-config upgrade python + +```bash +sudo hassbian-config upgrade python ``` ## Additional info -If you have installed additional components directly to `/srv/homeassistant/` like `libcec` thoese will need to be reinstalled. + +If you have installed additional components directly to `/srv/homeassistant/` +like `libcec` thoese will need to be reinstalled. *** -This script was originally contributed by [@Ludeeus](https://github.com/ludeeus). -With inspiration from: [blog.ceard.tech](https://blog.ceard.tech/2017/12/upgrading-python-virtual-environment.html) +This script was originally contributed by [@Ludeeus][ludeeus]. +With inspiration from [blog.ceard.tech][blog]. + + +[blog]: https://blog.ceard.tech/2017/12/upgrading-python-virtual-environment.html +[hassbian-image]: https://github.com/home-assistant/pi-gen/releases/latest +[ludeeus]: https://github.com/ludeeus From 55f89a9654455478cf762815091cef1b84d1836c Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sun, 30 Sep 2018 23:55:12 +0200 Subject: [PATCH 15/18] :books: RaZberry --- docs/razberry.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/docs/razberry.md b/docs/razberry.md index 3718a1f5..29665c0c 100644 --- a/docs/razberry.md +++ b/docs/razberry.md @@ -1,16 +1,27 @@ -## Description -This script disables Bluetooth for the use of a RaZberry with Hassbian. Code is adapted from the Razberry install script found at http://razberry.z-wave.me/install. This will disable the use of Bluetooth and Bluetooth Low Energy devices. +# RaZberry + +This script disables Bluetooth for the use of a RaZberry with Hassbian. +Code is adapted from the Razberry install script found at +[razberry.z-wave.me][razberry]. This will disable the use of Bluetooth and +Bluetooth Low Energy devices. ## Installation -``` -$ sudo hassbian-config install razberry + +```bash +sudo hassbian-config install razberry ``` ## Upgrade -No script available, maybe you could write one?\ -If so, add an PR here when you are done:\ -[homeassistant/hassbian-scripts](https://github.com/home-assistant/hassbian-scripts/pulls) +No script available, maybe you could write one? +If so, add an PR here when you are done: +[homeassistant/hassbian-scripts][repo] *** -This script was originally contributed by [@Landrash](https://github.com/Landrash). + +This script was originally contributed by [@Landrash][landrash]. + + +[landrash]: https://github.com/Landrash +[razberry]: http://razberry.z-wave.me/install +[repo]: https://github.com/home-assistant/hassbian-scripts/pulls From e807e4a5373914c405b170634c1f87561badc327 Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sun, 30 Sep 2018 23:56:52 +0200 Subject: [PATCH 16/18] :books: Samba --- docs/samba.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/docs/samba.md b/docs/samba.md index 6afd7240..16f54faf 100644 --- a/docs/samba.md +++ b/docs/samba.md @@ -1,17 +1,23 @@ -## Description -After this script has been run, the configuration directory used by Home Assistant is available over Samba and can be accessed from example Windows to edit with your favorite editor. +## Samba + +After this script has been run, the configuration directory used by +Home Assistant is available over Samba and can be accessed from example +Windows to edit with your favorite editor. ## Installation -``` -$ sudo hassbian-config install samba + +```bash +sudo hassbian-config install samba ``` ## Upgrade -No script available, maybe you could write one?\ -If so, add an PR here when you are done:\ -[homeassistant/hassbian-scripts](https://github.com/home-assistant/hassbian-scripts/pulls) + +No script available, maybe you could write one? +If so, add an PR here when you are done: +[homeassistant/hassbian-scripts][repo] ## Additional info + Description | Command/value :--- | :--- Running as: | root @@ -20,6 +26,10 @@ Start service: | `sudo systemctl start smbd.service` Stop service: | `sudo systemctl stop smbd.service` Restart service: | `sudo systemctl restart smbd.service` Service status: | `sudo systemctl status smbd.service` -| + *** -This script was originally contributed by [@Landrash](https://github.com/Landrash). + +This script was originally contributed by [@Landrash][landrash]. + + +[landrash]: https://github.com/Landrash From b6c383c438acc475d8e00569a9f07d3665f32b2f Mon Sep 17 00:00:00 2001 From: ludeeus Date: Sun, 30 Sep 2018 23:58:10 +0200 Subject: [PATCH 17/18] =?UTF-8?q?:books:=20Tr=C3=A5dfri?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/tradfri.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/docs/tradfri.md b/docs/tradfri.md index 4e0df2f7..094c11a1 100644 --- a/docs/tradfri.md +++ b/docs/tradfri.md @@ -1,16 +1,24 @@ -## Description -This script installs the dependencies for discovering and using a IKEA Trådfri Gateway with Home Assistant. It's recommended to restart your Trådfri Gateway after this install has been done. +# Trådfri + +This script installs the dependencies for discovering and using a +IKEA Trådfri Gateway with Home Assistant. It's recommended to restart your +Trådfri Gateway after this install has been done. ## Installation -``` -$ sudo hassbian-config install tradfri + +```bash +sudo hassbian-config install tradfri ``` ## Upgrade -No script available, maybe you could write one?\ -If so, add an PR here when you are done:\ -[homeassistant/hassbian-scripts](https://github.com/home-assistant/hassbian-scripts/pulls) +No script available, maybe you could write one? +If so, add an PR here when you are done: +[homeassistant/hassbian-scripts][repo] *** -This script was originally contributed by [@Landrash](https://github.com/Landrash). +This script was originally contributed by [@Landrash][landrash]. + + +[landrash]: https://github.com/Landrash +[repo]: https://github.com/home-assistant/hassbian-scripts/pulls From d34f4207846101d77159670d2633ed4152a632e3 Mon Sep 17 00:00:00 2001 From: ludeeus Date: Mon, 1 Oct 2018 00:00:20 +0200 Subject: [PATCH 18/18] :books: Webterminal --- docs/python.md | 1 + docs/samba.md | 3 ++- docs/webterminal.md | 37 ++++++++++++++++++++++++++----------- 3 files changed, 29 insertions(+), 12 deletions(-) diff --git a/docs/python.md b/docs/python.md index ba198998..31bcae64 100644 --- a/docs/python.md +++ b/docs/python.md @@ -21,6 +21,7 @@ If you have installed additional components directly to `/srv/homeassistant/` like `libcec` thoese will need to be reinstalled. *** + This script was originally contributed by [@Ludeeus][ludeeus]. With inspiration from [blog.ceard.tech][blog]. diff --git a/docs/samba.md b/docs/samba.md index 16f54faf..0b851a8c 100644 --- a/docs/samba.md +++ b/docs/samba.md @@ -1,4 +1,4 @@ -## Samba +# Samba After this script has been run, the configuration directory used by Home Assistant is available over Samba and can be accessed from example @@ -33,3 +33,4 @@ This script was originally contributed by [@Landrash][landrash]. [landrash]: https://github.com/Landrash +[repo]: https://github.com/home-assistant/hassbian-scripts/pulls diff --git a/docs/webterminal.md b/docs/webterminal.md index a826b26f..d0557145 100644 --- a/docs/webterminal.md +++ b/docs/webterminal.md @@ -1,17 +1,22 @@ -## Description -This script installs an web terminal called 'shellinabox' to your system that give you SSH access in your web browser. +# Webterminal + +This script installs an web terminal called 'shellinabox' to your system that +give you SSH access in your web browser. ## Installation -``` -$ sudo hassbian-config install webterminal + +```bash +sudo hassbian-config install webterminal ``` ## Upgrade + No script available, maybe you could write one? -If so, add an PR here when you are done:\ -[homeassistant/hassbian-scripts](https://github.com/home-assistant/hassbian-scripts/pulls) +If so, add an PR here when you are done: +[homeassistant/hassbian-scripts][repo] ## Additional info + Description | Command/value :--- | :--- Running as: | root @@ -21,9 +26,9 @@ Start service: | `sudo systemctl start shellinabox.service` Stop service: | `sudo systemctl stop shellinabox.service` Restart service: |`sudo systemctl restart shellinabox.service` Service status: |`sudo systemctl status shellinabox.service` -| Example config for Home-Assistant: + ```yaml panel_iframe: web_terminal: @@ -32,10 +37,14 @@ panel_iframe: url: 'http://192.168.1.2:4200' ``` -#### Notes for SSL -If you enable the use of existing Let's Encrypt certificates you need to open ports in your firewall to use them. +### Notes for SSL + +If you enable the use of existing Let's Encrypt certificates you need to open +ports in your firewall to use them. + +If SSL is used the panel_iframe has to use the same domain name as the one +issued with your certificate. -If SSL is used the panel_iframe has to use the same domain name as the one issued with your certificate. ```yaml panel_iframe: web_terminal: @@ -43,5 +52,11 @@ panel_iframe: icon: mdi:console url: 'https://yourdomain.duckdns.org:4200' ``` + *** -This script was originally contributed by [@Ludeeus](https://github.com/ludeeus). + +This script was originally contributed by [@Ludeeus][ludeeus]. + + +[ludeeus]: https://github.com/ludeeus +[repo]: https://github.com/home-assistant/hassbian-scripts/pulls