Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend risks in using YAMLLint and alternative #3543

Merged
merged 6 commits into from
Oct 7, 2017
Merged

Extend risks in using YAMLLint and alternative #3543

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
83c9039
Extends reasoning on YAMLLint
jhoepken Oct 7, 2017
0a3a595
Removes obsolete whitespace
jhoepken Oct 7, 2017
3323716
Merge branch 'next' of https://github.com/home-assistant/home-assista…
jhoepken Oct 7, 2017
975e1d5
Fix whitespace
jhoepken Oct 7, 2017
b67eeb1
Adds reference to inclusion of env-vars in YAML
jhoepken Oct 7, 2017
6698b5c
Add links
fabaff Oct 7, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions source/_docs/configuration/yaml.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ The basics of YAML syntax are block collections and mappings containing key-valu

Note that indentation (just like in Python) is an important part of specifying relationships using YAML. Things that are indented are nested "inside" things that are one level higher. So in the above example, `platform: pushbullet` is a property of (nested inside) the `notify` component.
Getting the right indentation can be tricky if you're not using an editor with a fixed width font. Tabs are not allowed to be used for indentation. Convention is to use 2 spaces for each level of indentation.
You can use [YAMLLint](http://www.yamllint.com/) to check if your YAML-syntax is correct before loading it into Home Assistant which will save you some time.
*Please pay attention on not putting in private data, as it is a 3rd-party website not maintained by Home Assistant.*
You can use the online service [YAMLLint](http://www.yamllint.com/) to check if your YAML syntax is correct before loading it into Home Assistant which will save you some time. If you do so, be aware that this is a third-party service and is not maintained by the Home Assistant community. *Please pay attention on not storing private data (passwords, api-keys, etc.) directly in that file.*
Private data can be stored in a [seperate file](/docs/configuration/secrets/) or in [environmental variables](/docs/configuration/yaml/#using-environment-variables), which circumvents this problem of security.

Text following a `#` are comments and are ignored by the system.

Expand Down