mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-17 06:16:50 +00:00
Changes to Hassbian documentation (#4992)
* Changes to Hassbian documentation * Added info about suite to Let's Encrypt docs
This commit is contained in:
Joakim Sørensen
Franck Nijhof
parent
cdda3de320
commit
8c71e26851
@ -10,7 +10,7 @@ footer: true
|
||||
---
|
||||
|
||||
<p class='note'>
|
||||
If you are using Hass.io, do not use this guide. Instead, use the [DuckDNS add-on](/addons/duckdns/) to automatically maintain a subdomain including HTTPS certificates via Let's Encrypt.
|
||||
If you are using Hass.io or Hassbian, do not use this guide. Instead, use the [DuckDNS add-on](/addons/duckdns/) for Hass.io or the [DuckDNS suite](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/duckdns.md) for Hassbian to automatically maintain a subdomain including HTTPS certificates via Let's Encrypt.
|
||||
</p>
|
||||
|
||||
<p class=' note warning'>
|
||||
|
||||
@ -11,7 +11,7 @@ redirect_from: /docs/hassbian/common-tasks/
|
||||
---
|
||||
|
||||
### {% linkable_title Login to the Raspberry Pi %}
|
||||
To login to your Raspberry Pi running HASSbian you're going to be using a ssh client. Depending on your platform there are several alternatives for doing this. Linux and Max OS generally have a ssh client installed. Windows users are recommended to download and install the ssh client [Putty][ssh-putty].
|
||||
To login to your Raspberry Pi running Hassbian you're going to be using a ssh client. Depending on your platform there are several alternatives for doing this. Linux and Max OS generally have a ssh client installed. Windows users are recommended to download and install the ssh client [Putty][ssh-putty].
|
||||
|
||||
Connect to the Raspberry Pi over ssh. Default user name is `pi` and password is `raspberry`.
|
||||
Linux and Mac OS users execute the following command in a terminal.
|
||||
@ -53,12 +53,12 @@ $ sudo systemctl start home-assistant@homeassistant.service
|
||||
|
||||
This will in order do the following:
|
||||
|
||||
- Stop the Home Assistant service running on HASSbian
|
||||
- Stop the Home Assistant service running on Hassbian
|
||||
- Open a shell as the `homeassistant` user running the Homeassistant service and that has ownership over the Home Assistant installation.
|
||||
- Change into the virtual Python environment at `/srv/homeassistant/` containing the Home Assistant installation.
|
||||
- Upgrade the Home Assistant installation to the latest release.
|
||||
- Exit the shell and return to the `pi` user.
|
||||
- Restart the Home Assistant service.
|
||||
- Start the Home Assistant service.
|
||||
|
||||
### {% linkable_title Manually launch Home Assistant %}
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Customization"
|
||||
description: "Instructions to flash the Home Assistant HASSbian image on a Raspberry Pi."
|
||||
description: "Instructions to flash the Home Assistant Hassbian image on a Raspberry Pi."
|
||||
date: 2016-09-26 21:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
@ -10,26 +10,34 @@ footer: true
|
||||
redirect_from: /docs/hassbian/customization/
|
||||
---
|
||||
|
||||
To allow you to customize your installation further, we have included a tool called `hassbian-config`. This tool comes with a set of packages that can easily be installed or upgraded for easier customization of your Home Assistant installation.
|
||||
To allow you to customize your installation further, we have included a tool called `hassbian-config`. This tool comes with a set of suites that can easily be installed or upgraded for easier customization of your Home Assistant installation.
|
||||
The tool is available by running `hassbian-config`.
|
||||
|
||||
### Install scripts
|
||||
To view the available packages run `hassbian-config show` and `sudo hassbian-config install PACKAGENAME`.
|
||||
- Install Hue. Configures the Python executable to allow usage of low numbered ports for use with Emulated Hue component that's used with Amazon Echo, Google Home and Mycroft.ai.
|
||||
- Install MariaDB. 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.
|
||||
- Install Mosquitto MQTT server. Installs the latest Mosquitto package and client tools from the Mosquitto projects official repository. Now includes websocket support.
|
||||
- Install Libcec. Adds local [HDMI CEC support][cec]. *This scipt is currently brooken upstream since it currently doesn't build properly for Python >3.4*
|
||||
- Install Samba. Allows anyone on your network to edit your configuration from any computer. This share is unsecured and it's usage is not recommended if you share your network with others.
|
||||
- Install Tradfri. Installs dependencies for using IKEA Trådfri.
|
||||
- Install Duck DNS auto renewal. This script adds a cron job to auto update 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.
|
||||
- Install a web terminal for easy access to ssh in any web browser. This script installs a web terminal called 'shellinabox' on your system that gives you SSH access in your web browser.
|
||||
To view the available suites run `hassbian-config show` or have a look at the [hassbian-scripts repository][hassbian-repo].
|
||||
These are some of the available suites:
|
||||
- [AppDaemon](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/appdaemon.md)
|
||||
- [Duck DNS](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/duckdns.md) _This can also be configured to generate Let's Encrypt SSL certificates_
|
||||
- [Homebridge](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/homebridge.md)
|
||||
- [Mosquitto](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/mosquitto.md)
|
||||
- [Samba](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/samba.md)
|
||||
- [Webterminal](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/webterminal.md)
|
||||
- Various database engines.
|
||||
- [MariaDB](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/mariadb.md)
|
||||
- [PostgreSQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/postgresql.md)
|
||||
- [MS SQL](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/mssql.md)
|
||||
|
||||
#### Upgrade scripts
|
||||
To view the available packages run `hassbian-config show` and `sudo hassbian-config upgrade PACKAGENAME`.
|
||||
- Upgrade your Home Assistant installation.
|
||||
- Upgrade your HASSbian installation.
|
||||
- Upgrade HASSbian-scripts.
|
||||
- Upgrade HASSbian-scripts from dev branch.
|
||||
To install any of them simply run `sudo hassbian-config install SUITE`.
|
||||
|
||||
### Upgrade scripts
|
||||
To view the available suites run `hassbian-config show` or have a look at the [hassbian-scripts repository][hassbian-repo].
|
||||
These are some of the available suites:
|
||||
- [AppDaemon](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/appdaemon.md)
|
||||
- [Hassbian](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/hassbian.md)
|
||||
- [Home Assistant](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/homeassistant.md)
|
||||
- [hassbian-config (hassbian-sctipts)](https://github.com/home-assistant/hassbian-scripts/blob/master/docs/hassbian_config.md)
|
||||
|
||||
To upgrade any of them simply run `sudo hassbian-config upgrade SUITE`.
|
||||
|
||||
For more information about this tool have a look at the [hassbian-scripts repository][hassbian-repo].
|
||||
|
||||
|
||||
@ -14,18 +14,19 @@ One of the easiest ways to install Home Assistant on your Raspberry Pi Zero, 2 ,
|
||||
|
||||
1. [Download the Hassbian image][image-download]
|
||||
2. Use [Etcher][etcher] to flash the image to your SD card
|
||||
3. Ensure your Raspberry Pi has wired access to the internet for the entire process or configure your wireless network settings **before proceeding to step 4**.
|
||||
4. Insert SD card to Raspberry Pi and turn it on. Initial installation of Home Assistant will take about 5 minutes.
|
||||
3. Ensure your Raspberry Pi has wired access to the internet for the entire process or configure your [wireless network settings](#wireless-network) **before proceeding to step 4**.
|
||||
4. Insert SD card to Raspberry Pi and turn it on. Initial installation of Home Assistant will take about 10 minutes.
|
||||
|
||||
<p class='note'>
|
||||
Please remember to ensure you're using an [appropriate power supply](https://www.raspberrypi.org/help/faqs/#powerReqs) with your Pi. Mobile chargers may not be suitable, since some are designed to only provide the full power with that manufacturer's handsets.
|
||||
</p>
|
||||
|
||||
These instructions are also available as a [video](https://www.youtube.com/watch?v=iIz6XqDwHEk). Additional information is available in this [video](https://www.youtube.com/watch?v=tCGlQSsQ-Mc).
|
||||
These instructions are also available as a [video](https://www.youtube.com/watch?v=iIz6XqDwHEk).
|
||||
Additional information is available in this [video](https://www.youtube.com/watch?v=tCGlQSsQ-Mc).
|
||||
|
||||
After initial boot an installer will run in the background and takes around 15 minutes to complete, after it has finished, you will be prompted to login: `hassbian login:`. Installation is complete at this point. The default username is `pi` and the password is `raspberry`.
|
||||
After initial boot an installer will run in the background, this will download and install the newest version of [hassbian-config](https://github.com/home-assistant/hassbian-scripts) and Home-Assistant, this takes around 10 minutes to complete, after it has finished, you will be prompted to login: `hassbian login:`. Installation is complete at this point. The default username is `pi` and the password is `raspberry`.
|
||||
|
||||
Open a browser on a device that's connected to the same WiFi network as your Raspberry Pi and point it to Home Assistant at [http://hassbian.local:8123]. If you want to login via SSH, the default username is `pi` and password is `raspberry` (please change this by running `passwd`). The Home Assistant configuration is located at `/home/homeassistant/.homeassistant/`.
|
||||
Open a browser on a device that's connected to the same network as your Raspberry Pi and point it to Home Assistant at [http://hassbian.local:8123]. If you want to login via SSH, the default username is `pi` and password is `raspberry` (please change this by running `passwd`). The Home Assistant configuration is located at `/home/homeassistant/.homeassistant/`.
|
||||
|
||||
If you find that the web page is not reachable after 30 minutes or so, check that you have files in `/home/homeassistant/.homeassistant/`, if there are no files in this location then run the installer manually using this command: `sudo systemctl start install_homeassistant.service`.
|
||||
|
||||
@ -35,7 +36,7 @@ The following extras are included on the image:
|
||||
- GPIO pins are ready to use.
|
||||
- Bluetooth is ready to use (supported models only, no Bluetooth LE).
|
||||
- SSH server is enabled.
|
||||
- A tool called [`hassbian-config`](https://github.com/home-assistant/hassbian-scripts#hassbian-config-hassbian-config).
|
||||
- A tool called [`hassbian-config`](https://github.com/home-assistant/hassbian-scripts#hassbian-scripts).
|
||||
|
||||
### {% linkable_title Wireless Network %}
|
||||
|
||||
@ -63,4 +64,3 @@ You may need to adjust the country code depending upon where you are. A list of
|
||||
[etcher]: https://etcher.io/
|
||||
[http://hassbian.local:8123]: http://hassbian.local:8123
|
||||
[wifi-setup]: https://www.raspberrypi.org/documentation/configuration/wireless/wireless-cli.md
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ footer: true
|
||||
redirect_from: /docs/hassbian/upgrading/
|
||||
---
|
||||
|
||||
HASSbian is based on Raspbian and uses the same repositories. Any changes to Raspbian will be reflected in HASSbian. To update and upgrade system packages and installed software (excluding Home Assistant) do the following.
|
||||
Hassbian is based on Raspbian and uses the same repositories. Any changes to Raspbian will be reflected in Hassbian. To update and upgrade system packages and installed software (excluding Home Assistant) do the following.
|
||||
Log in as the `pi` account and execute the following commands:
|
||||
|
||||
```bash
|
||||
@ -18,10 +18,9 @@ $ sudo apt-get update
|
||||
$ sudo apt-get -y upgrade
|
||||
```
|
||||
|
||||
|
||||
#### {% linkable_title Updating Home Assistant %}
|
||||
<p class='note'>
|
||||
You can also use `hassbian-config` to automate the process by running `sudo hassbian-config upgrade home-assistant`
|
||||
You can use `hassbian-config` to automate the process by running `sudo hassbian-config upgrade homeassistant`
|
||||
</p>
|
||||
|
||||
To update the Home Assistant installation execute the following command as the `pi` user.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user