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.
Merge pull request #185 from ludeeus/documentation
Documentation cleanup
- Loading branch information
Showing
18 changed files
with
387 additions
and
191 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
|
|
||
| <!--- When adding stuff here, please keep it alphabetical ---> | ||
| * [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 | ||
| ``` | ||
|
|
||
| <!--- Links ---> | ||
| [changelog]: https://github.com/home-assistant/hassbian-scripts/releases | ||
| [hassbian]: https://github.com/home-assistant/pi-gen |
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 |
|---|---|---|
| @@ -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 [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`: | ||
|
|
||
| ```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]. | ||
|
|
||
| <!--- Links ---> | ||
| [appdaemon-docs]: http://appdaemon.readthedocs.io/en/latest/ | ||
| [landrash]: https://github.com/landrash | ||
| [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 |
|---|---|---|
| @@ -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 [email protected]` | |
| Stop service: | `sudo systemctl stop [email protected]` | ||
| Restart service: | `sudo systemctl restart [email protected]` | ||
| Service status: | `sudo systemctl status [email protected]` | ||
| | | ||
|
|
||
| *** | ||
| This script was originally contributed by [@Ludeeus](https://github.com/ludeeus). | ||
|
|
||
| This script was originally contributed by [@Ludeeus][ludeeus]. | ||
|
|
||
| <!--- Links ---> | ||
| [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
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 |
|---|---|---|
| @@ -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]. | ||
|
|
||
| <!--- Links ---> | ||
| [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
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 |
|---|---|---|
| @@ -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]. | ||
|
|
||
| <!--- Links ---> | ||
| [landrash]: https://github.com/landrash |
Oops, something went wrong.