192 lines
12 KiB
HTML
192 lines
12 KiB
HTML
<!doctype html>
|
||
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
||
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
||
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||
<title>Configure Home Assistant - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions to get Home Assistant configured.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/getting-started/configuration/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Configure Home Assistant">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/getting-started/configuration/">
|
||
<meta property="og:type" content="website">
|
||
<meta property="og:description" content="Instructions to get Home Assistant configured.">
|
||
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
|
||
<meta name="twitter:card" content="summary_large_image">
|
||
<meta name="twitter:site" content="@home_assistant">
|
||
<meta name="twitter:title" content="Configure Home Assistant">
|
||
<meta name="twitter:description" content="Instructions to get Home Assistant configured.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
|
||
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
||
<link rel='shortcut icon' href='/images/favicon.ico' />
|
||
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
||
</head>
|
||
<body >
|
||
<header class='site-header'>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
||
<a href="/" class="site-title">
|
||
<img width='40' src='/demo/favicon-192x192.png'>
|
||
<span>Home Assistant</span>
|
||
</a>
|
||
</div>
|
||
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
||
<nav>
|
||
<input type="checkbox" id="toggle">
|
||
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
||
<ul class="menu pull-right">
|
||
<li><a href="/getting-started/">Getting started</a></li>
|
||
<li><a href="/components/">Components</a></li>
|
||
<li><a href="/docs/">Docs</a></li>
|
||
<li><a href="/cookbook/">Examples</a></li>
|
||
<li><a href="/developers/">Developers</a></li>
|
||
<li><a href="/blog/">Blog</a></li>
|
||
<li><a href="/help/">Need help?</a></li>
|
||
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
||
</ul>
|
||
</nav>
|
||
<div class='search-container' style='display: none'>
|
||
<div class='search'>
|
||
<i class="icon-search"></i>
|
||
<input id='search' placeholder='Search the docs…'>
|
||
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
<div class="grid-wrapper">
|
||
<div class="grid grid-center">
|
||
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
|
||
<article class="page">
|
||
<header>
|
||
<h1 class="title indent">
|
||
Configure Home Assistant
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p class="Note">
|
||
This guide applies only if you’ve installed Home Assistant via Hass.io. If you’ve used any other install method then <a href="/docs/configuration/">see here</a> instead.
|
||
</p>
|
||
<p>If you made it here, awesome! That means that you got Home Assistant up and running. It might have already found some of your networked devices. This is going to be fun!</p>
|
||
<p>Home Assistant stores its configuration in a file called <code class="highlighter-rouge">configuration.yaml</code>. A default one is created when Home Assistant is started for the first time. Some of the things in the configuration file can be edited via the user interface, other parts require you to edit the configuration file directly.</p>
|
||
<p>There are two common approaches to edit your configuration: via Samba/Windows Networking and via the HASS Configurator. Both of these are <a href="/addons/">official add-ons for Hass.io</a>.</p>
|
||
<h2><a class="title-link" name="installing-hassio-add-ons" href="#installing-hassio-add-ons"></a> Installing Hass.io add-ons</h2>
|
||
<p>Hass.io add-ons are installed from the add-on store embedded in the Hass.io panel:</p>
|
||
<ul>
|
||
<li>Open Home Assistant by navigating to <a href="http://hassio.local:8123">http://hassio.local:8123</a>.</li>
|
||
<li>Click on the menu icon in the top left and select Hass.io in the sidebar.</li>
|
||
<li>The Hass.io panel opens, now open the add-on store by clicking the shopping bag.</li>
|
||
</ul>
|
||
<p class="img">
|
||
<img src="/images/hassio/screenshots/main_panel_store_icon.png" />
|
||
From the Hass.io main panel open the add-on store.
|
||
</p>
|
||
<h3><a class="title-link" name="editing-config-via-hass-configurator" href="#editing-config-via-hass-configurator"></a> Editing config via HASS Configurator</h3>
|
||
<p>The first add-on we should install is the HASS Configurator. With the HASS Configurator you’ll be able to edit your Home Assistant configuration from the web interface.</p>
|
||
<p>Go to the add-on store (see previous step), click on Configurator and click on INSTALL. When installation is complete the UI will go to the add-on details page for the configurator. Here you will be able to change settings, start and stop the add-on.</p>
|
||
<ul>
|
||
<li>Change the settings to set a password and click on save</li>
|
||
<li>Start the add-on</li>
|
||
<li>You will be able to click the “WEB UI” link to open the Web UI</li>
|
||
</ul>
|
||
<p>Time for the first practice with the configurator. Add the following to <code class="highlighter-rouge">configuration.yaml</code> file to add a link to the Configurator in the sidebar:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">panel_iframe</span><span class="pi">:</span>
|
||
<span class="s">configurator</span><span class="pi">:</span>
|
||
<span class="s">title</span><span class="pi">:</span> <span class="s">Configurator</span>
|
||
<span class="s">icon</span><span class="pi">:</span> <span class="s">mdi:wrench</span>
|
||
<span class="s">url</span><span class="pi">:</span> <span class="s">http://hassio.local:3218</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Now restart Home Assistant for the changes to the configuration to take effect. You can do this by going to the config panel (Configuration in the sidebar) -> General -> Restart Home Assistant.</p>
|
||
<h3><a class="title-link" name="editing-config-via-sambawindows-networking" href="#editing-config-via-sambawindows-networking"></a> Editing config via Samba/Windows Networking</h3>
|
||
<p>Maybe you are not a big fan of our web editor and want to use a text editor on your computer instead. This is possible by sharing the configuration over the network using the Samba add-on, which can be installed from the Hass.io add-on store.</p>
|
||
<p>After you have installed it, click on START. Hass.io should now be available in the networking tab on your computer. Use a text editor like the free <a href="https://code.visualstudio.com/">Visual Studio Code</a> to edit <code class="highlighter-rouge">configuration.yaml</code>.</p>
|
||
<h2><a class="title-link" name="configuring-integrations" href="#configuring-integrations"></a> Configuring integrations</h2>
|
||
<p>Now that you are able to edit the configuration, it’s time to set up some of your devices and services. Each service and device will have its own instructions on how to be integrated. Find your devices and services on the <a href="/components/">components overview page</a>.</p>
|
||
<p class="note">YAML can be a little daunting at first. A lot is possible! <a href="/docs/configuration/devices/">Here is some more info.</a></p>
|
||
<p>For a sensor that is showing <a href="/components/sensor.random/">random values</a>, the entry would look like the sample below:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">sensor</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">random</span>
|
||
</code></pre>
|
||
</div>
|
||
<h3><a href="/getting-started/automation/">Next step: Automate Home Assistant »</a></h3>
|
||
</article>
|
||
</div>
|
||
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
|
||
<div class="grid">
|
||
<section class="aside-module grid__item one-whole lap-one-half">
|
||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/getting-started/configuration.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Getting Started Guide</h1>
|
||
<ul class='divided sidebar-menu'>
|
||
<li><a href='/getting-started/'>Installation </a>
|
||
<li><a class='active' href='/getting-started/configuration/'>Configuration </a></li>
|
||
<li><a href='/getting-started/automation/'>Automation </a></li>
|
||
<li><a href='/getting-started/automation-2/'>Automation 2 </a></li>
|
||
<li><a href='/getting-started/presence-detection/'>Presence detection </a></li>
|
||
<li><a href='/getting-started/use/'>Use it! </a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</aside>
|
||
</div>
|
||
</div>
|
||
<footer>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item">
|
||
<div class="copyright">
|
||
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
||
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
|
||
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
|
||
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
||
<div class="credit">
|
||
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
|
||
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
||
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
||
</div>
|
||
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
<script>
|
||
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
||
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
||
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
||
s.parentNode.insertBefore(g,s)}(document,'script'));
|
||
</script>
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
||
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
||
<script type="text/javascript">
|
||
docsearch({
|
||
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
||
indexName: 'home-assistant',
|
||
inputSelector: '#search',
|
||
debug: false // Set debug to true if you want to inspect the dropdown
|
||
});
|
||
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'none';
|
||
});
|
||
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'block';
|
||
document.getElementById('toggle').checked = false;
|
||
document.querySelector('.search-container input').focus();
|
||
});
|
||
</script>
|
||
</body>
|
||
</html>
|