jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-28 03:37:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update configuration getting started page

Browse Source
This commit is contained in:
Paulus Schoutsen 2016-08-14 12:28:58 -07:00
parent ce6fad1337
commit 2b63bde9d9
1 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
source/getting-started/configuration.markdown
View File

@ -9,20 +9,28 @@ sharing: true
footer: true
---
Home Assistant will create a configuration folder when it is run for the first time. The location of the folder differs between operating systems: on OS X and Linux it's `~/.homeassistant` and on Windows it's `%APPDATA%/.homeassistant`. If you want to use a different folder for configuration, run `hass --config path/to/config`.
Inside your configuration folder is the file `configuration.yaml`. This is the main file that contains which components will be loaded and what their configuration is. This file contains YAML code, which is explained briefly below. [An example configuration file is located here](https://github.com/home-assistant/home-assistant/blob/master/config/configuration.yaml.example).
When launched for the first time, Home Assistant will write a default configuration file enabling the web interface and device discovery. It can take up to a minute for your devices to be discovered and show up in the user interface.
If you run into trouble while configuring Home Assistant, have a look at [the configuration troubleshooting page](/getting-started/troubleshooting-configuration/).
The location of the folder differs between operating systems:
<p class='note tip'>
Install colorlog (`$ pip install colorlog`) to make the console output easier to read, hence also easier to catch errors and warnings.
</p>
| OS | Path |
| -- | ---- |
| OS X | `~/.homeassistant` |
| Linux | `~/.homeassistant` |
| Windows | `%APPDATA%/.homeassistant` |
If you want to use a different folder for configuration, use the config command line parameter: `hass --config path/to/config`.
Inside your configuration folder is the file `configuration.yaml`. This is the main file that contains which components will be loaded and what their configuration is. Throughout the documentation you will find snippets that you can add to your configuration file to enable that functionality.
If you run into trouble while configuring Home Assistant, have a look at [the configuration troubleshooting page](/getting-started/troubleshooting-configuration/) and at the [configuration.yaml examples](/cookbook/#example-configurationyaml).
<p class='note'>
You will have to restart Home Assistant each time you make changes in `configuration.yaml` in order for these to take effect.
You will have to restart Home Assistant for changes to `configuration.yaml` take effect.
</p>
<p class='note tip'>
Install colorlog (`$ pip3 install colorlog`) to make the console output easier to read, hence also easier to catch errors and warnings.
</p>
### [Next step: Get familiar with YAML &raquo;](/getting-started/yaml/)