Site updated at 2017-02-23 10:37:02 UTC
This commit is contained in:
Travis CI
parent
ac0a1f4c4f
commit
1cc11da707
231 changed files with 47289 additions and 37 deletions
353
docs/installation/docker/index.html
Normal file
353
docs/installation/docker/index.html
Normal file
|
|
@ -0,0 +1,353 @@
|
|||
<!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>Installation on Docker - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="Instructions to install Home Assistant on a Docker.">
|
||||
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/docs/installation/docker/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="Installation on Docker">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/docs/installation/docker/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="Instructions to install Home Assistant on a Docker.">
|
||||
<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="Installation on Docker">
|
||||
<meta name="twitter:description" content="Instructions to install Home Assistant on a Docker.">
|
||||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||||
|
||||
<link href="/stylesheets/screen.css" media="screen, projection" 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>
|
||||
<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>
|
||||
</ul>
|
||||
</nav>
|
||||
</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">
|
||||
|
||||
|
||||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_docs/installation/docker.markdown'>Edit this page on GitHub</a></div>
|
||||
|
||||
|
||||
|
||||
<header>
|
||||
<h1 class="title indent">
|
||||
Installation on Docker
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
||||
|
||||
<p>Installation with Docker is straightforward. Adjust the following command so that <code class="highlighter-rouge">/path/to/your/config/</code> points at the folder where you want to store your config and run it:</p>
|
||||
|
||||
<h3><a class="title-link" name="linux" href="#linux"></a> Linux</h3>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>docker run -d --name<span class="o">=</span><span class="s2">"home-assistant"</span> -v /path/to/your/config:/config -v /etc/localtime:/etc/localtime:ro --net<span class="o">=</span>host homeassistant/home-assistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h3><a class="title-link" name="macos" href="#macos"></a> macOS</h3>
|
||||
|
||||
<p>When using <code class="highlighter-rouge">boot2docker</code> on macOS you are unable to map the local time to your Docker container. Use <code class="highlighter-rouge">-e "TZ=America/Los_Angeles"</code> instead of <code class="highlighter-rouge">-v /etc/localtime:/etc/localtime:ro</code>. Replace “America/Los_Angeles” with <a href="http://en.wikipedia.org/wiki/List_of_tz_database_time_zones">your timezone</a>.</p>
|
||||
|
||||
<p>Additionally, if your expectation is that you will be able to browse directly to <code class="highlighter-rouge">http://localhost:8123</code> on your macOS host, then you will also need to replace the <code class="highlighter-rouge">--net=host</code> switch with <code class="highlighter-rouge">-p 8123:8123</code>. This is currently the only way to forward ports on to your actual host (macOS) machine instead of the virtual machine inside <code class="highlighter-rouge">xhyve</code>. More detail on this can be found in <a href="https://forums.docker.com/t/should-docker-run-net-host-work/14215/10">the docker forums</a>.</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>docker run -d --name<span class="o">=</span><span class="s2">"home-assistant"</span> -v /path/to/your/config:/config -e <span class="s2">"TZ=America/Los_Angeles"</span> -p 8123:8123 homeassistant/home-assistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h3><a class="title-link" name="restart" href="#restart"></a> Restart</h3>
|
||||
|
||||
<p>This will launch Home Assistant and serve the web interface from port 8123 on your Docker host.</p>
|
||||
|
||||
<p>If you change the configuration you have to restart the server. To do that you have 2 options.</p>
|
||||
|
||||
<ol>
|
||||
<li>You can go to the <img src="/images/screenshots/developer-tool-services-icon.png" alt="service developer tool icon" class="no-shadow" height="38" /> service developer tools, select the service <code class="highlighter-rouge">homeassistant/restart</code> and click “Call Service”.</li>
|
||||
<li>Or you can restart it from an terminal by running <code class="highlighter-rouge">docker restart home-assistant</code></li>
|
||||
</ol>
|
||||
|
||||
|
||||
</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='section'>
|
||||
<h1 class="title delta">Topics</h1>
|
||||
<ul class='divided sidebar-menu'>
|
||||
<li>
|
||||
<a href='/docs/installation/'>Installation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/installation/python/'>Python </a></li>
|
||||
<li><a href='/docs/installation/virtualenv/'>Python Virtual Env </a></li>
|
||||
<li><a class='active' href='/docs/installation/docker/'>Docker </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi/'>Raspberry Pi </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi-all-in-one/'>Raspberrry Pi All-in-One </a></li>
|
||||
<li><a href='/docs/installation/vagrant/'>Vagrant </a></li>
|
||||
<li><a href='/docs/installation/synology/'>Synology </a></li>
|
||||
<li><a href='/docs/installation/updating/'>Updating </a></li>
|
||||
<li><a href='/docs/installation/troubleshooting/'>Troubleshooting </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/hassbian/'>Hassbian </a>
|
||||
<ul>
|
||||
<li><a href='/docs/hassbian/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/hassbian/customization/'>Customization </a></li>
|
||||
<li><a href='/docs/hassbian/common-tasks/'>Common tasks </a></li>
|
||||
<li><a href='/docs/hassbian/integrations/'>Integrations </a></li>
|
||||
<li><a href='/docs/hassbian/upgrading/'>Upgrading </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/configuration/'>Configuration </a>
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/yaml/'>YAML </a></li>
|
||||
<li><a href='/docs/configuration/basic/'>Basic information </a></li>
|
||||
<li><a href='/docs/configuration/devices/'>Setting up devices </a></li>
|
||||
<li><a href='/docs/configuration/customizing-devices/'>Customizing devices and services </a></li>
|
||||
<li><a href='/docs/configuration/presence-detection/'>Presence Detection </a></li>
|
||||
<li><a href='/docs/configuration/troubleshooting/'>Troubleshooting </a></li>
|
||||
<li><a href='/docs/configuration/securing/'>Security Check Points </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Advanced Configuration
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/remote/'>Remote access </a></li>
|
||||
<li><a href='/docs/configuration/packages/'>Packages </a></li>
|
||||
<li><a href='/docs/configuration/splitting_configuration/'>Splitting up the configuration </a></li>
|
||||
<li><a href='/docs/configuration/secrets/'>Storing Secrets </a></li>
|
||||
<li><a href='/docs/configuration/templating/'>Templating </a></li>
|
||||
<li><a href='/docs/configuration/group_visibility/'>Group Visibility </a></li>
|
||||
<li><a href='/docs/configuration/events/'>Events </a></li>
|
||||
<li><a href='/docs/configuration/state_object/'>State Objects </a></li>
|
||||
<li><a href='/docs/configuration/platform_options/'>Entity component platform options </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/automation/'>Automation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/automation/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/automation/trigger/'>Triggers </a></li>
|
||||
<li><a href='/docs/automation/condition/'>Conditions </a></li>
|
||||
<li><a href='/docs/automation/action/'>Actions </a></li>
|
||||
<li><a href='/docs/automation/templating/'>Templates </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/frontend/'>Frontend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/frontend/mobile/'>Android/iOS Homescreen </a></li>
|
||||
<li><a href='/docs/frontend/webserver/'>Web server fingerprint </a></li>
|
||||
<li><a href='/docs/frontend/browsers/'>Browser Compatibility List </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/backend/'>Backend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/backend/database/'>Database </a></li>
|
||||
<li><a href='/docs/backend/updater/'>Updater </a></li>
|
||||
<li><a href='/developers/api/'>API </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/scripts/'>Scripts </a>
|
||||
<ul>
|
||||
<li><a href='/docs/scripts/service-calls/'>Service Calls </a></li>
|
||||
<li><a href='/docs/scripts/conditions/'>Conditions </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/z-wave/'>Z-Wave </a>
|
||||
<ul>
|
||||
<li><a href='/docs/z-wave/controllers/'>Controllers </a></li>
|
||||
<li><a href='/docs/z-wave/settings/'>Modifying Settings </a></li>
|
||||
<li><a href='/docs/z-wave/device-specific/'>Device Specific </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/mqtt/'>MQTT </a>
|
||||
<ul>
|
||||
<li><a href='/docs/mqtt/broker/'>Broker </a></li>
|
||||
<li><a href='/docs/mqtt/certificate/'>Certificate </a></li>
|
||||
<li><a href='/docs/mqtt/discovery/'>Discovery </a></li>
|
||||
<li><a href='/docs/mqtt/service/'>Publish service </a></li>
|
||||
<li><a href='/docs/mqtt/birth_will/'>Birth and last will messages </a></li>
|
||||
<li><a href='/docs/mqtt/testing/'>Testing your setup </a></li>
|
||||
<li><a href='/docs/mqtt/logging/'>Logging </a></li>
|
||||
<li><a href='/docs/mqtt/processing_json/'>Processing JSON </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/'>Ecosystem </a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/autostart/'>Autostart </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/autostart/systemd/'>systemd (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/upstart/'>Upstart (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/init.d/'>init.d (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/macos/'>macOS </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/synology/'>Synology NAS </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/appdaemon/'>AppDaemon </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/appdaemon/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/configuration/'>Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/example_apps/'>Example Apps </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/running/'>Running AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/reboot/'>Starting AppDaemon at Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/operation/'>Operation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/windows/'>AppDaemon on Windows </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/updating/'>Updating AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/tutorial/'>AppDaemon Tutorial </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/api/'>AppDaemon API Reference </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/hadashboard/'>HADashboard </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/hadashboard/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/dash_config/'>Dashboard Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/hapush/'>HAPush </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/reboot/'>Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/updating/'>Updating HADashboard </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/notebooks/'>Notebooks </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/notebooks/'>Introduction </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/graph/'>Graph </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/api/'>Home Assistant API </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/database/'>Databsase </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/stats/'>Statistics </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/ios/notifications/'>iOS </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/basic/'>Basic notifications </a></li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/sounds/'>Sounds </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/architecture/'>Architecture </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/privacy_security_rate_limits/'>Privacy, rate limiting and security </a></li>
|
||||
</ul>
|
||||
<li>Advanced notifications</li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/attachments/'>Attachments </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/content_extensions/'>Dynamic content </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/actions/'>Actionable notifications </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/requesting_location_updates/'>Requesting location updates </a></li>
|
||||
</ul>
|
||||
<li><a href='/docs/ecosystem/ios/location/'>Location Tracking </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/integration/'>Integration with other apps </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</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>.<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>
|
||||
</body>
|
||||
</html>
|
||||
331
docs/installation/index.html
Normal file
331
docs/installation/index.html
Normal file
|
|
@ -0,0 +1,331 @@
|
|||
<!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>Installation of Home Assistant - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="Instructions how to install Home Assistant to launch on start.">
|
||||
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/docs/installation/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="Installation of Home Assistant">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/docs/installation/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="Instructions how to install Home Assistant to launch on start.">
|
||||
<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="Installation of Home Assistant">
|
||||
<meta name="twitter:description" content="Instructions how to install Home Assistant to launch on start.">
|
||||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||||
|
||||
<link href="/stylesheets/screen.css" media="screen, projection" 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>
|
||||
<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>
|
||||
</ul>
|
||||
</nav>
|
||||
</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">
|
||||
|
||||
|
||||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_docs/installation.markdown'>Edit this page on GitHub</a></div>
|
||||
|
||||
|
||||
|
||||
<header>
|
||||
<h1 class="title indent">
|
||||
Installation of Home Assistant
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
||||
|
||||
<p>Home Assistant provides multiple ways to be installed. If you are a Raspberry Pi owner then the <a href="/docs/hassbian/">Hassbian</a> is an easy and simple way to run home Assistant.</p>
|
||||
|
||||
<p>The only requirement is that you have <a href="https://www.python.org/downloads/">Python</a> installed. For Windows we require at least <strong>Python 3.5</strong> and for other operating systems at least <strong>Python 3.4.2</strong>.</p>
|
||||
|
||||
<p>It may be needed that you install additional library depending on the platforms/components you want to use.</p>
|
||||
|
||||
|
||||
|
||||
</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='section'>
|
||||
<h1 class="title delta">Topics</h1>
|
||||
<ul class='divided sidebar-menu'>
|
||||
<li>
|
||||
<a class='active' href='/docs/installation/'>Installation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/installation/python/'>Python </a></li>
|
||||
<li><a href='/docs/installation/virtualenv/'>Python Virtual Env </a></li>
|
||||
<li><a href='/docs/installation/docker/'>Docker </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi/'>Raspberry Pi </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi-all-in-one/'>Raspberrry Pi All-in-One </a></li>
|
||||
<li><a href='/docs/installation/vagrant/'>Vagrant </a></li>
|
||||
<li><a href='/docs/installation/synology/'>Synology </a></li>
|
||||
<li><a href='/docs/installation/updating/'>Updating </a></li>
|
||||
<li><a href='/docs/installation/troubleshooting/'>Troubleshooting </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/hassbian/'>Hassbian </a>
|
||||
<ul>
|
||||
<li><a href='/docs/hassbian/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/hassbian/customization/'>Customization </a></li>
|
||||
<li><a href='/docs/hassbian/common-tasks/'>Common tasks </a></li>
|
||||
<li><a href='/docs/hassbian/integrations/'>Integrations </a></li>
|
||||
<li><a href='/docs/hassbian/upgrading/'>Upgrading </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/configuration/'>Configuration </a>
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/yaml/'>YAML </a></li>
|
||||
<li><a href='/docs/configuration/basic/'>Basic information </a></li>
|
||||
<li><a href='/docs/configuration/devices/'>Setting up devices </a></li>
|
||||
<li><a href='/docs/configuration/customizing-devices/'>Customizing devices and services </a></li>
|
||||
<li><a href='/docs/configuration/presence-detection/'>Presence Detection </a></li>
|
||||
<li><a href='/docs/configuration/troubleshooting/'>Troubleshooting </a></li>
|
||||
<li><a href='/docs/configuration/securing/'>Security Check Points </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Advanced Configuration
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/remote/'>Remote access </a></li>
|
||||
<li><a href='/docs/configuration/packages/'>Packages </a></li>
|
||||
<li><a href='/docs/configuration/splitting_configuration/'>Splitting up the configuration </a></li>
|
||||
<li><a href='/docs/configuration/secrets/'>Storing Secrets </a></li>
|
||||
<li><a href='/docs/configuration/templating/'>Templating </a></li>
|
||||
<li><a href='/docs/configuration/group_visibility/'>Group Visibility </a></li>
|
||||
<li><a href='/docs/configuration/events/'>Events </a></li>
|
||||
<li><a href='/docs/configuration/state_object/'>State Objects </a></li>
|
||||
<li><a href='/docs/configuration/platform_options/'>Entity component platform options </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/automation/'>Automation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/automation/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/automation/trigger/'>Triggers </a></li>
|
||||
<li><a href='/docs/automation/condition/'>Conditions </a></li>
|
||||
<li><a href='/docs/automation/action/'>Actions </a></li>
|
||||
<li><a href='/docs/automation/templating/'>Templates </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/frontend/'>Frontend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/frontend/mobile/'>Android/iOS Homescreen </a></li>
|
||||
<li><a href='/docs/frontend/webserver/'>Web server fingerprint </a></li>
|
||||
<li><a href='/docs/frontend/browsers/'>Browser Compatibility List </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/backend/'>Backend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/backend/database/'>Database </a></li>
|
||||
<li><a href='/docs/backend/updater/'>Updater </a></li>
|
||||
<li><a href='/developers/api/'>API </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/scripts/'>Scripts </a>
|
||||
<ul>
|
||||
<li><a href='/docs/scripts/service-calls/'>Service Calls </a></li>
|
||||
<li><a href='/docs/scripts/conditions/'>Conditions </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/z-wave/'>Z-Wave </a>
|
||||
<ul>
|
||||
<li><a href='/docs/z-wave/controllers/'>Controllers </a></li>
|
||||
<li><a href='/docs/z-wave/settings/'>Modifying Settings </a></li>
|
||||
<li><a href='/docs/z-wave/device-specific/'>Device Specific </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/mqtt/'>MQTT </a>
|
||||
<ul>
|
||||
<li><a href='/docs/mqtt/broker/'>Broker </a></li>
|
||||
<li><a href='/docs/mqtt/certificate/'>Certificate </a></li>
|
||||
<li><a href='/docs/mqtt/discovery/'>Discovery </a></li>
|
||||
<li><a href='/docs/mqtt/service/'>Publish service </a></li>
|
||||
<li><a href='/docs/mqtt/birth_will/'>Birth and last will messages </a></li>
|
||||
<li><a href='/docs/mqtt/testing/'>Testing your setup </a></li>
|
||||
<li><a href='/docs/mqtt/logging/'>Logging </a></li>
|
||||
<li><a href='/docs/mqtt/processing_json/'>Processing JSON </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/'>Ecosystem </a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/autostart/'>Autostart </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/autostart/systemd/'>systemd (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/upstart/'>Upstart (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/init.d/'>init.d (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/macos/'>macOS </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/synology/'>Synology NAS </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/appdaemon/'>AppDaemon </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/appdaemon/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/configuration/'>Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/example_apps/'>Example Apps </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/running/'>Running AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/reboot/'>Starting AppDaemon at Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/operation/'>Operation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/windows/'>AppDaemon on Windows </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/updating/'>Updating AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/tutorial/'>AppDaemon Tutorial </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/api/'>AppDaemon API Reference </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/hadashboard/'>HADashboard </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/hadashboard/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/dash_config/'>Dashboard Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/hapush/'>HAPush </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/reboot/'>Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/updating/'>Updating HADashboard </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/notebooks/'>Notebooks </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/notebooks/'>Introduction </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/graph/'>Graph </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/api/'>Home Assistant API </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/database/'>Databsase </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/stats/'>Statistics </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/ios/notifications/'>iOS </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/basic/'>Basic notifications </a></li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/sounds/'>Sounds </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/architecture/'>Architecture </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/privacy_security_rate_limits/'>Privacy, rate limiting and security </a></li>
|
||||
</ul>
|
||||
<li>Advanced notifications</li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/attachments/'>Attachments </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/content_extensions/'>Dynamic content </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/actions/'>Actionable notifications </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/requesting_location_updates/'>Requesting location updates </a></li>
|
||||
</ul>
|
||||
<li><a href='/docs/ecosystem/ios/location/'>Location Tracking </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/integration/'>Integration with other apps </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</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>.<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>
|
||||
</body>
|
||||
</html>
|
||||
349
docs/installation/python/index.html
Normal file
349
docs/installation/python/index.html
Normal file
|
|
@ -0,0 +1,349 @@
|
|||
<!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>Installation on your computer - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="Installation of Home Assistant on your computer.">
|
||||
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/docs/installation/python/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="Installation on your computer">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/docs/installation/python/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="Installation of Home Assistant on your computer.">
|
||||
<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="Installation on your computer">
|
||||
<meta name="twitter:description" content="Installation of Home Assistant on your computer.">
|
||||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||||
|
||||
<link href="/stylesheets/screen.css" media="screen, projection" 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>
|
||||
<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>
|
||||
</ul>
|
||||
</nav>
|
||||
</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">
|
||||
|
||||
|
||||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_docs/installation/python.markdown'>Edit this page on GitHub</a></div>
|
||||
|
||||
|
||||
|
||||
<header>
|
||||
<h1 class="title indent">
|
||||
Installation on Your Computer
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
||||
|
||||
<p>Once Python is installed, execute the following code in a console:</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>pip3 install homeassistant
|
||||
<span class="gp">$ </span>hass --open-ui
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Running these commands will:</p>
|
||||
|
||||
<ul>
|
||||
<li>Install Home Assistant</li>
|
||||
<li>Launch Home Assistant and serve the web interface on <a href="http://localhost:8123">http://localhost:8123</a></li>
|
||||
</ul>
|
||||
|
||||
<p>If you’re running a Linux-based platform, we suggest you follow the <a href="/docs/installation/virtualenv/">VirtualEnv instructions</a> to avoid using <code class="highlighter-rouge">root</code>.</p>
|
||||
|
||||
<p>Video tutorials of this process for various operating systems are available here:</p>
|
||||
|
||||
<ul>
|
||||
<li><a href="https://www.youtube.com/watch?v=X27eVvuqwnY">Windows 10</a></li>
|
||||
<li><a href="https://www.youtube.com/watch?v=hej6ipN86ls">macOS</a></li>
|
||||
<li><a href="https://www.youtube.com/watch?v=SXaAG1lGNH0">Ubuntu 14.04</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</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='section'>
|
||||
<h1 class="title delta">Topics</h1>
|
||||
<ul class='divided sidebar-menu'>
|
||||
<li>
|
||||
<a href='/docs/installation/'>Installation </a>
|
||||
<ul>
|
||||
<li><a class='active' href='/docs/installation/python/'>Python </a></li>
|
||||
<li><a href='/docs/installation/virtualenv/'>Python Virtual Env </a></li>
|
||||
<li><a href='/docs/installation/docker/'>Docker </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi/'>Raspberry Pi </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi-all-in-one/'>Raspberrry Pi All-in-One </a></li>
|
||||
<li><a href='/docs/installation/vagrant/'>Vagrant </a></li>
|
||||
<li><a href='/docs/installation/synology/'>Synology </a></li>
|
||||
<li><a href='/docs/installation/updating/'>Updating </a></li>
|
||||
<li><a href='/docs/installation/troubleshooting/'>Troubleshooting </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/hassbian/'>Hassbian </a>
|
||||
<ul>
|
||||
<li><a href='/docs/hassbian/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/hassbian/customization/'>Customization </a></li>
|
||||
<li><a href='/docs/hassbian/common-tasks/'>Common tasks </a></li>
|
||||
<li><a href='/docs/hassbian/integrations/'>Integrations </a></li>
|
||||
<li><a href='/docs/hassbian/upgrading/'>Upgrading </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/configuration/'>Configuration </a>
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/yaml/'>YAML </a></li>
|
||||
<li><a href='/docs/configuration/basic/'>Basic information </a></li>
|
||||
<li><a href='/docs/configuration/devices/'>Setting up devices </a></li>
|
||||
<li><a href='/docs/configuration/customizing-devices/'>Customizing devices and services </a></li>
|
||||
<li><a href='/docs/configuration/presence-detection/'>Presence Detection </a></li>
|
||||
<li><a href='/docs/configuration/troubleshooting/'>Troubleshooting </a></li>
|
||||
<li><a href='/docs/configuration/securing/'>Security Check Points </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Advanced Configuration
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/remote/'>Remote access </a></li>
|
||||
<li><a href='/docs/configuration/packages/'>Packages </a></li>
|
||||
<li><a href='/docs/configuration/splitting_configuration/'>Splitting up the configuration </a></li>
|
||||
<li><a href='/docs/configuration/secrets/'>Storing Secrets </a></li>
|
||||
<li><a href='/docs/configuration/templating/'>Templating </a></li>
|
||||
<li><a href='/docs/configuration/group_visibility/'>Group Visibility </a></li>
|
||||
<li><a href='/docs/configuration/events/'>Events </a></li>
|
||||
<li><a href='/docs/configuration/state_object/'>State Objects </a></li>
|
||||
<li><a href='/docs/configuration/platform_options/'>Entity component platform options </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/automation/'>Automation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/automation/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/automation/trigger/'>Triggers </a></li>
|
||||
<li><a href='/docs/automation/condition/'>Conditions </a></li>
|
||||
<li><a href='/docs/automation/action/'>Actions </a></li>
|
||||
<li><a href='/docs/automation/templating/'>Templates </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/frontend/'>Frontend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/frontend/mobile/'>Android/iOS Homescreen </a></li>
|
||||
<li><a href='/docs/frontend/webserver/'>Web server fingerprint </a></li>
|
||||
<li><a href='/docs/frontend/browsers/'>Browser Compatibility List </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/backend/'>Backend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/backend/database/'>Database </a></li>
|
||||
<li><a href='/docs/backend/updater/'>Updater </a></li>
|
||||
<li><a href='/developers/api/'>API </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/scripts/'>Scripts </a>
|
||||
<ul>
|
||||
<li><a href='/docs/scripts/service-calls/'>Service Calls </a></li>
|
||||
<li><a href='/docs/scripts/conditions/'>Conditions </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/z-wave/'>Z-Wave </a>
|
||||
<ul>
|
||||
<li><a href='/docs/z-wave/controllers/'>Controllers </a></li>
|
||||
<li><a href='/docs/z-wave/settings/'>Modifying Settings </a></li>
|
||||
<li><a href='/docs/z-wave/device-specific/'>Device Specific </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/mqtt/'>MQTT </a>
|
||||
<ul>
|
||||
<li><a href='/docs/mqtt/broker/'>Broker </a></li>
|
||||
<li><a href='/docs/mqtt/certificate/'>Certificate </a></li>
|
||||
<li><a href='/docs/mqtt/discovery/'>Discovery </a></li>
|
||||
<li><a href='/docs/mqtt/service/'>Publish service </a></li>
|
||||
<li><a href='/docs/mqtt/birth_will/'>Birth and last will messages </a></li>
|
||||
<li><a href='/docs/mqtt/testing/'>Testing your setup </a></li>
|
||||
<li><a href='/docs/mqtt/logging/'>Logging </a></li>
|
||||
<li><a href='/docs/mqtt/processing_json/'>Processing JSON </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/'>Ecosystem </a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/autostart/'>Autostart </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/autostart/systemd/'>systemd (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/upstart/'>Upstart (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/init.d/'>init.d (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/macos/'>macOS </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/synology/'>Synology NAS </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/appdaemon/'>AppDaemon </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/appdaemon/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/configuration/'>Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/example_apps/'>Example Apps </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/running/'>Running AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/reboot/'>Starting AppDaemon at Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/operation/'>Operation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/windows/'>AppDaemon on Windows </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/updating/'>Updating AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/tutorial/'>AppDaemon Tutorial </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/api/'>AppDaemon API Reference </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/hadashboard/'>HADashboard </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/hadashboard/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/dash_config/'>Dashboard Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/hapush/'>HAPush </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/reboot/'>Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/updating/'>Updating HADashboard </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/notebooks/'>Notebooks </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/notebooks/'>Introduction </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/graph/'>Graph </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/api/'>Home Assistant API </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/database/'>Databsase </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/stats/'>Statistics </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/ios/notifications/'>iOS </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/basic/'>Basic notifications </a></li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/sounds/'>Sounds </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/architecture/'>Architecture </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/privacy_security_rate_limits/'>Privacy, rate limiting and security </a></li>
|
||||
</ul>
|
||||
<li>Advanced notifications</li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/attachments/'>Attachments </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/content_extensions/'>Dynamic content </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/actions/'>Actionable notifications </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/requesting_location_updates/'>Requesting location updates </a></li>
|
||||
</ul>
|
||||
<li><a href='/docs/ecosystem/ios/location/'>Location Tracking </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/integration/'>Integration with other apps </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</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>.<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>
|
||||
</body>
|
||||
</html>
|
||||
443
docs/installation/raspberry-pi-all-in-one/index.html
Normal file
443
docs/installation/raspberry-pi-all-in-one/index.html
Normal file
|
|
@ -0,0 +1,443 @@
|
|||
<!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>Raspberry Pi All-In-One Installer - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="Home Assistant is an open-source home automation platform running on Python 3.">
|
||||
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/docs/installation/raspberry-pi-all-in-one/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="Raspberry Pi All-In-One Installer">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/docs/installation/raspberry-pi-all-in-one/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="">
|
||||
<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="Raspberry Pi All-In-One Installer">
|
||||
<meta name="twitter:description" content="">
|
||||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||||
|
||||
<link href="/stylesheets/screen.css" media="screen, projection" 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>
|
||||
<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>
|
||||
</ul>
|
||||
</nav>
|
||||
</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">
|
||||
|
||||
|
||||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_docs/installation/raspberry-pi-all-in-one.markdown'>Edit this page on GitHub</a></div>
|
||||
|
||||
|
||||
|
||||
<header>
|
||||
<h1 class="title indent">
|
||||
Raspberry Pi All-In-One Installer
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
||||
|
||||
<p>The <a href="https://github.com/home-assistant/fabric-home-assistant">Raspberry Pi All-In-One Installer</a> deploys a complete Home Assistant server including support for MQTT with websockets, Z-Wave, and the Open-Zwave Control Panel.</p>
|
||||
|
||||
<p>The only requirement is that you have a Raspberry Pi with a fresh installation of <a href="https://www.raspberrypi.org/downloads/raspbian/">Raspbian</a> connected to your network.</p>
|
||||
|
||||
<p class="note">
|
||||
Note that as of 2016-11-30 SSH is disabled by default in the official Raspbian images. Adding an empty file called <code class="highlighter-rouge">ssh</code> to <code class="highlighter-rouge">/boot/</code> or the FAT32 partition will enable it. More information is on the Raspberry Pi Foundation <a href="https://www.raspberrypi.org/blog/page/2/?fish#a-security-update-for-raspbian-pixel">Blog</a>
|
||||
</p>
|
||||
|
||||
<ul>
|
||||
<li>Login to Raspberry Pi. For example with <code class="highlighter-rouge">ssh pi@your_raspberry_pi_ip</code></li>
|
||||
<li>Run the following command</li>
|
||||
</ul>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>curl -O https://raw.githubusercontent.com/home-assistant/fabric-home-assistant/master/hass_rpi_installer.sh <span class="o">&&</span> sudo chown pi:pi hass_rpi_installer.sh <span class="o">&&</span> bash hass_rpi_installer.sh
|
||||
</code></pre>
|
||||
</div>
|
||||
<p class="note warning">
|
||||
Note this command is one-line and not run as sudo.
|
||||
</p>
|
||||
|
||||
<p>Installation will take approx. 1-2 hours depending on the Raspberry Pi model the installer is being run against. The installer will identitfy what Raspberry PI hardware revision you are using and adjust commands accordingly. A complete log of the install is located at: <code class="highlighter-rouge">/home/pi/fabric-home-assistant/installation_report.txt</code> The installer has been updated to simply log any errors encountered, but resume installing. Please consult the “installation report” if your install encountered issues.</p>
|
||||
|
||||
<p><a href="http://www.bruhautomation.com">BRUH automation</a> has created <a href="https://www.youtube.com/watch?v=VGl3KTrYo6s">a tutorial video</a> explaining how to install Raspbian on your Raspberry Pi and install Home Assistant using the All-In-One Installer.</p>
|
||||
|
||||
<p>Once rebooted, your Raspberry Pi will be up and running with Home Assistant. You can access it at <a href="http://your_raspberry_pi_ip:8123">http://your_raspberry_pi_ip:8123</a>.</p>
|
||||
|
||||
<p>The Home Assistant configuration is located at <code class="highlighter-rouge">/home/homeassistant/.homeassistant</code> (or <code class="highlighter-rouge">/home/hass/.homeassistant</code> if installed prior to December 2016). The <a href="https://virtualenv.pypa.io/en/latest/">virtualenv</a> with the Home Assistant installation is located at <code class="highlighter-rouge">/srv/homeassistant/homeassistant_venv</code>. As part of the secure installation, a new user (<strong>homeassistant</strong>) is added to your Raspberry Pi to run Home Assistant. This is a system account and does not have login or other abilities by design. When editing your <code class="highlighter-rouge">configuration.yaml</code> files, you will need to run the commands with <code class="highlighter-rouge">sudo</code> or by switching user.</p>
|
||||
|
||||
<p class="note note">
|
||||
<em>Windows users</em>: Setting up WinSCP to allow this seemlessly is at the end of this page.
|
||||
</p>
|
||||
|
||||
<p>By default, installation makes use of a Python Virtualenv. If you wish to not follow this recommendation, you may add the flag <code class="highlighter-rouge">-n</code> to the end of the install command specified above.</p>
|
||||
|
||||
<p>The All-In-One Installer script will do the following automatically:</p>
|
||||
|
||||
<ul>
|
||||
<li>Create all needed directories</li>
|
||||
<li>Create needed service accounts</li>
|
||||
<li>Install OS and Python dependencies</li>
|
||||
<li>Setup a python virtualenv to run Home Assistant and components inside.</li>
|
||||
<li>Run as <code class="highlighter-rouge">homeassistant</code> service account</li>
|
||||
<li>Install Home Assistant in a virtualenv</li>
|
||||
<li>Install Mosquitto with websocket support running on ports 1883 and 9001</li>
|
||||
<li>Build and Install Python-openzwave in the Home Assistant virtualenv</li>
|
||||
<li>Build openzwave-control-panel in <code class="highlighter-rouge">/srv/homeassistant/src/open-zwave-control-panel</code></li>
|
||||
<li>Add Home Assistant to systemd services to start at boot</li>
|
||||
</ul>
|
||||
|
||||
<h3><a class="title-link" name="upgrading" href="#upgrading"></a> Upgrading</h3>
|
||||
|
||||
<p>To upgrade the All-In-One setup manually:</p>
|
||||
|
||||
<ul>
|
||||
<li>Login to Raspberry Pi <code class="highlighter-rouge">ssh pi@your_raspberry_pi_ip</code></li>
|
||||
<li>Change to homeassistant user <code class="highlighter-rouge">sudo su -s /bin/bash homeassistant</code></li>
|
||||
<li>Change to virtual enviroment <code class="highlighter-rouge">source /srv/homeassistant/homeassistant_venv/bin/activate</code></li>
|
||||
<li>Update HA <code class="highlighter-rouge">pip3 install --upgrade homeassistant</code></li>
|
||||
<li>Type <code class="highlighter-rouge">exit</code> to logout the hass user and return to the <code class="highlighter-rouge">pi</code> user.</li>
|
||||
</ul>
|
||||
|
||||
<p class="note note">
|
||||
If you deployed Home Assistant via the AiO installer prior to December 2016, replace <code class="highlighter-rouge">sudo su -s /bin/bash homeassistant</code> with <code class="highlighter-rouge">sudo su -s /bin/bash hass</code> and <code class="highlighter-rouge">source /srv/homeassistant/homeassistant_venv/bin/activate</code> with <code class="highlighter-rouge">source /srv/hass/hass_venv/bin/activate</code></p>
|
||||
|
||||
<p>To upgrade with fabric:</p>
|
||||
|
||||
<ul>
|
||||
<li>Login to Raspberry Pi <code class="highlighter-rouge">ssh pi@your_raspberry_pi_ip</code></li>
|
||||
<li>Change to <code class="highlighter-rouge">cd ~/fabric-home-assistant</code></li>
|
||||
<li>Run <code class="highlighter-rouge">fab upgrade_homeassistant</code></li>
|
||||
</ul>
|
||||
|
||||
<p>After upgrading, you can restart Home Assistant a few different ways:</p>
|
||||
|
||||
<ul>
|
||||
<li>Restarting the Raspberry Pi <code class="highlighter-rouge">sudo reboot</code></li>
|
||||
<li>Restarting the Home-Assistant Service <code class="highlighter-rouge">sudo systemctl restart home-assistant.service</code></li>
|
||||
</ul>
|
||||
|
||||
<h3><a class="title-link" name="to-change-the-mqtt-default-password" href="#to-change-the-mqtt-default-password"></a> To change the MQTT default password</h3>
|
||||
|
||||
<ul>
|
||||
<li>Login to Raspberry Pi <code class="highlighter-rouge">ssh pi@your_raspberry_pi_ip</code></li>
|
||||
<li>Change password <code class="highlighter-rouge">sudo mosquitto_passwd /etc/mosquitto/pwfile pi</code></li>
|
||||
<li>Restart mosquitto <code class="highlighter-rouge">sudo systemctl restart mosquitto.service</code></li>
|
||||
<li>Be sure to update your <code class="highlighter-rouge">configuration.yaml</code> to reflect the new password.</li>
|
||||
</ul>
|
||||
|
||||
<h3><a class="title-link" name="using-the-ozwcp-web-application" href="#using-the-ozwcp-web-application"></a> Using the OZWCP web application</h3>
|
||||
|
||||
<p>To launch the OZWCP web application:</p>
|
||||
|
||||
<ul>
|
||||
<li>Make sure Home Assistant is not running! So stop that first</li>
|
||||
<li>Login to Raspberry Pi <code class="highlighter-rouge">ssh pi@your_raspberry_pi_ip</code></li>
|
||||
<li>Change to the ozwcp directory <code class="highlighter-rouge">cd /srv/homeassistant/src/open-zwave-control-panel/</code></li>
|
||||
<li>Launch the control panel <code class="highlighter-rouge">sudo ./ozwcp -p 8888</code></li>
|
||||
<li>Open a web browser to <code class="highlighter-rouge">http://your_pi_ip:8888</code></li>
|
||||
<li>Specify your zwave controller, for example <code class="highlighter-rouge">/dev/ttyACM0</code> and hit initialize</li>
|
||||
</ul>
|
||||
|
||||
<p class="note note">
|
||||
If you deployed Home Assistant via the AiO installer prior to December 2016, replace <code class="highlighter-rouge">cd /srv/homeassistant/src/open-zwave-control-panel/</code> with <code class="highlighter-rouge">cd /srv/hass/src/open-zwave-control-panel/</code>
|
||||
</p>
|
||||
|
||||
<p class="note warning">
|
||||
Don’t check the USB box regardless of using a USB based device.
|
||||
</p>
|
||||
|
||||
<h3><a class="title-link" name="using-the-gpios" href="#using-the-gpios"></a> Using the GPIOs</h3>
|
||||
|
||||
<p>The (<strong>homeassistant</strong>) user is added to the GPIO group as part of the install now.</p>
|
||||
|
||||
<h3><a class="title-link" name="winscp" href="#winscp"></a> WinSCP</h3>
|
||||
|
||||
<p>If you are Windows users who is using <a href="https://winscp.net/">WinSCP</a>, please note that after running the installer, you will need to modify settings allowing you to “switch users” to edit your configuration files.</p>
|
||||
|
||||
<p>First create a new session on WinSCP using Protocol <strong>SCP</strong> pointing to your Pi IP address and port 22 and then modify the needed setting by click on <strong>Advanced…</strong> -> <strong>Environment</strong> -> <strong>SCP/Shell</strong> -> <strong>Shell</strong> and selecting <code class="highlighter-rouge">sudo su -</code>.</p>
|
||||
|
||||
|
||||
</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='section'>
|
||||
<h1 class="title delta">Topics</h1>
|
||||
<ul class='divided sidebar-menu'>
|
||||
<li>
|
||||
<a href='/docs/installation/'>Installation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/installation/python/'>Python </a></li>
|
||||
<li><a href='/docs/installation/virtualenv/'>Python Virtual Env </a></li>
|
||||
<li><a href='/docs/installation/docker/'>Docker </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi/'>Raspberry Pi </a></li>
|
||||
<li><a class='active' href='/docs/installation/raspberry-pi-all-in-one/'>Raspberrry Pi All-in-One </a></li>
|
||||
<li><a href='/docs/installation/vagrant/'>Vagrant </a></li>
|
||||
<li><a href='/docs/installation/synology/'>Synology </a></li>
|
||||
<li><a href='/docs/installation/updating/'>Updating </a></li>
|
||||
<li><a href='/docs/installation/troubleshooting/'>Troubleshooting </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/hassbian/'>Hassbian </a>
|
||||
<ul>
|
||||
<li><a href='/docs/hassbian/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/hassbian/customization/'>Customization </a></li>
|
||||
<li><a href='/docs/hassbian/common-tasks/'>Common tasks </a></li>
|
||||
<li><a href='/docs/hassbian/integrations/'>Integrations </a></li>
|
||||
<li><a href='/docs/hassbian/upgrading/'>Upgrading </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/configuration/'>Configuration </a>
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/yaml/'>YAML </a></li>
|
||||
<li><a href='/docs/configuration/basic/'>Basic information </a></li>
|
||||
<li><a href='/docs/configuration/devices/'>Setting up devices </a></li>
|
||||
<li><a href='/docs/configuration/customizing-devices/'>Customizing devices and services </a></li>
|
||||
<li><a href='/docs/configuration/presence-detection/'>Presence Detection </a></li>
|
||||
<li><a href='/docs/configuration/troubleshooting/'>Troubleshooting </a></li>
|
||||
<li><a href='/docs/configuration/securing/'>Security Check Points </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Advanced Configuration
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/remote/'>Remote access </a></li>
|
||||
<li><a href='/docs/configuration/packages/'>Packages </a></li>
|
||||
<li><a href='/docs/configuration/splitting_configuration/'>Splitting up the configuration </a></li>
|
||||
<li><a href='/docs/configuration/secrets/'>Storing Secrets </a></li>
|
||||
<li><a href='/docs/configuration/templating/'>Templating </a></li>
|
||||
<li><a href='/docs/configuration/group_visibility/'>Group Visibility </a></li>
|
||||
<li><a href='/docs/configuration/events/'>Events </a></li>
|
||||
<li><a href='/docs/configuration/state_object/'>State Objects </a></li>
|
||||
<li><a href='/docs/configuration/platform_options/'>Entity component platform options </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/automation/'>Automation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/automation/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/automation/trigger/'>Triggers </a></li>
|
||||
<li><a href='/docs/automation/condition/'>Conditions </a></li>
|
||||
<li><a href='/docs/automation/action/'>Actions </a></li>
|
||||
<li><a href='/docs/automation/templating/'>Templates </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/frontend/'>Frontend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/frontend/mobile/'>Android/iOS Homescreen </a></li>
|
||||
<li><a href='/docs/frontend/webserver/'>Web server fingerprint </a></li>
|
||||
<li><a href='/docs/frontend/browsers/'>Browser Compatibility List </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/backend/'>Backend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/backend/database/'>Database </a></li>
|
||||
<li><a href='/docs/backend/updater/'>Updater </a></li>
|
||||
<li><a href='/developers/api/'>API </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/scripts/'>Scripts </a>
|
||||
<ul>
|
||||
<li><a href='/docs/scripts/service-calls/'>Service Calls </a></li>
|
||||
<li><a href='/docs/scripts/conditions/'>Conditions </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/z-wave/'>Z-Wave </a>
|
||||
<ul>
|
||||
<li><a href='/docs/z-wave/controllers/'>Controllers </a></li>
|
||||
<li><a href='/docs/z-wave/settings/'>Modifying Settings </a></li>
|
||||
<li><a href='/docs/z-wave/device-specific/'>Device Specific </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/mqtt/'>MQTT </a>
|
||||
<ul>
|
||||
<li><a href='/docs/mqtt/broker/'>Broker </a></li>
|
||||
<li><a href='/docs/mqtt/certificate/'>Certificate </a></li>
|
||||
<li><a href='/docs/mqtt/discovery/'>Discovery </a></li>
|
||||
<li><a href='/docs/mqtt/service/'>Publish service </a></li>
|
||||
<li><a href='/docs/mqtt/birth_will/'>Birth and last will messages </a></li>
|
||||
<li><a href='/docs/mqtt/testing/'>Testing your setup </a></li>
|
||||
<li><a href='/docs/mqtt/logging/'>Logging </a></li>
|
||||
<li><a href='/docs/mqtt/processing_json/'>Processing JSON </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/'>Ecosystem </a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/autostart/'>Autostart </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/autostart/systemd/'>systemd (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/upstart/'>Upstart (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/init.d/'>init.d (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/macos/'>macOS </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/synology/'>Synology NAS </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/appdaemon/'>AppDaemon </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/appdaemon/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/configuration/'>Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/example_apps/'>Example Apps </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/running/'>Running AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/reboot/'>Starting AppDaemon at Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/operation/'>Operation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/windows/'>AppDaemon on Windows </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/updating/'>Updating AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/tutorial/'>AppDaemon Tutorial </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/api/'>AppDaemon API Reference </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/hadashboard/'>HADashboard </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/hadashboard/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/dash_config/'>Dashboard Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/hapush/'>HAPush </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/reboot/'>Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/updating/'>Updating HADashboard </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/notebooks/'>Notebooks </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/notebooks/'>Introduction </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/graph/'>Graph </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/api/'>Home Assistant API </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/database/'>Databsase </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/stats/'>Statistics </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/ios/notifications/'>iOS </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/basic/'>Basic notifications </a></li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/sounds/'>Sounds </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/architecture/'>Architecture </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/privacy_security_rate_limits/'>Privacy, rate limiting and security </a></li>
|
||||
</ul>
|
||||
<li>Advanced notifications</li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/attachments/'>Attachments </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/content_extensions/'>Dynamic content </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/actions/'>Actionable notifications </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/requesting_location_updates/'>Requesting location updates </a></li>
|
||||
</ul>
|
||||
<li><a href='/docs/ecosystem/ios/location/'>Location Tracking </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/integration/'>Integration with other apps </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</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>.<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>
|
||||
</body>
|
||||
</html>
|
||||
390
docs/installation/raspberry-pi/index.html
Normal file
390
docs/installation/raspberry-pi/index.html
Normal file
|
|
@ -0,0 +1,390 @@
|
|||
<!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>Manual installation on a Raspberry Pi - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="Instructions to install Home Assistant on a Raspberry Pi runnning Raspbian Lite.">
|
||||
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/docs/installation/raspberry-pi/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="Manual installation on a Raspberry Pi">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/docs/installation/raspberry-pi/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="Instructions to install Home Assistant on a Raspberry Pi runnning Raspbian Lite.">
|
||||
<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="Manual installation on a Raspberry Pi">
|
||||
<meta name="twitter:description" content="Instructions to install Home Assistant on a Raspberry Pi runnning Raspbian Lite.">
|
||||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||||
|
||||
<link href="/stylesheets/screen.css" media="screen, projection" 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>
|
||||
<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>
|
||||
</ul>
|
||||
</nav>
|
||||
</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">
|
||||
|
||||
|
||||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_docs/installation/raspberry-pi.markdown'>Edit this page on GitHub</a></div>
|
||||
|
||||
|
||||
|
||||
<header>
|
||||
<h1 class="title indent">
|
||||
Manual Installation on a Raspberry Pi
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
||||
|
||||
<p>This installation of Home Assistant requires the Raspberry Pi to run <a href="https://www.raspberrypi.org/downloads/raspbian/">Raspbian Lite</a>. The installation will be installed in a <a href="/docs/installation/virtualenv">Virtual Environment</a> with minimal overhead. Instructions assume this is a new installation of Raspbian Lite.</p>
|
||||
|
||||
<p>Connect to the Raspberry Pi over SSH. Default password is <code class="highlighter-rouge">raspberry</code>.
|
||||
You will need to enable SSH access. The Raspberry Pi website has instructions <a href="https://www.raspberrypi.org/documentation/remote-access/ssh/">here</a>.</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>ssh pi@ipadress
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Changing the default password is encouraged.</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>passwd
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Update the system.</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo apt-get update
|
||||
<span class="gp">$ </span>sudo apt-get upgrade -y
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Install the dependencies.</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo apt-get install python3 python3-venv python3-pip
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Add an account for Home Assistant called <code class="highlighter-rouge">homeassistant</code>.
|
||||
Since this account is only for running Home Assistant the extra arguments of <code class="highlighter-rouge">-rm</code> is added to create a system account and create a home directory.</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo useradd -rm homeassistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Next we will create a directory for the installation of Home Assistant and change the owner to the <code class="highlighter-rouge">homeassistant</code> account.</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span><span class="nb">cd</span> /srv
|
||||
<span class="gp">$ </span>sudo mkdir homeassistant
|
||||
<span class="gp">$ </span>sudo chown homeassistant:homeassistant homeassistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Next up is to create and change to a virtual environment for Home Assistant. This will be done as the <code class="highlighter-rouge">homeassistant</code> account.</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo su -s /bin/bash homeassistant
|
||||
<span class="gp">$ </span><span class="nb">cd</span> /srv/homeassistant
|
||||
<span class="gp">$ </span>python3 -m venv .
|
||||
<span class="gp">$ </span><span class="nb">source </span>bin/activate
|
||||
</code></pre>
|
||||
</div>
|
||||
<p>Once you have activated the virtual environment you will notice the prompt change and then you can install Home Assistant.</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="o">(</span>homeassistant<span class="o">)</span> homeassistant@raspberrypi:/srv/homeassistant <span class="nv">$ </span>pip3 install homeassistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Start Home Assistant for the first time. This will complete the installation, create the <code class="highlighter-rouge">.homeasssistant</code> configuration directory in the <code class="highlighter-rouge">/home/homeassistant</code> directory and install any basic dependencies.</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="o">(</span>homeassistant<span class="o">)</span> <span class="nv">$ </span>hass
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>You can now reach your installation on your Raspberry Pi over the web interface on <a href="http://ipaddress:8123">http://ipaddress:8123</a>.</p>
|
||||
|
||||
|
||||
|
||||
</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='section'>
|
||||
<h1 class="title delta">Topics</h1>
|
||||
<ul class='divided sidebar-menu'>
|
||||
<li>
|
||||
<a href='/docs/installation/'>Installation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/installation/python/'>Python </a></li>
|
||||
<li><a href='/docs/installation/virtualenv/'>Python Virtual Env </a></li>
|
||||
<li><a href='/docs/installation/docker/'>Docker </a></li>
|
||||
<li><a class='active' href='/docs/installation/raspberry-pi/'>Raspberry Pi </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi-all-in-one/'>Raspberrry Pi All-in-One </a></li>
|
||||
<li><a href='/docs/installation/vagrant/'>Vagrant </a></li>
|
||||
<li><a href='/docs/installation/synology/'>Synology </a></li>
|
||||
<li><a href='/docs/installation/updating/'>Updating </a></li>
|
||||
<li><a href='/docs/installation/troubleshooting/'>Troubleshooting </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/hassbian/'>Hassbian </a>
|
||||
<ul>
|
||||
<li><a href='/docs/hassbian/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/hassbian/customization/'>Customization </a></li>
|
||||
<li><a href='/docs/hassbian/common-tasks/'>Common tasks </a></li>
|
||||
<li><a href='/docs/hassbian/integrations/'>Integrations </a></li>
|
||||
<li><a href='/docs/hassbian/upgrading/'>Upgrading </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/configuration/'>Configuration </a>
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/yaml/'>YAML </a></li>
|
||||
<li><a href='/docs/configuration/basic/'>Basic information </a></li>
|
||||
<li><a href='/docs/configuration/devices/'>Setting up devices </a></li>
|
||||
<li><a href='/docs/configuration/customizing-devices/'>Customizing devices and services </a></li>
|
||||
<li><a href='/docs/configuration/presence-detection/'>Presence Detection </a></li>
|
||||
<li><a href='/docs/configuration/troubleshooting/'>Troubleshooting </a></li>
|
||||
<li><a href='/docs/configuration/securing/'>Security Check Points </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Advanced Configuration
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/remote/'>Remote access </a></li>
|
||||
<li><a href='/docs/configuration/packages/'>Packages </a></li>
|
||||
<li><a href='/docs/configuration/splitting_configuration/'>Splitting up the configuration </a></li>
|
||||
<li><a href='/docs/configuration/secrets/'>Storing Secrets </a></li>
|
||||
<li><a href='/docs/configuration/templating/'>Templating </a></li>
|
||||
<li><a href='/docs/configuration/group_visibility/'>Group Visibility </a></li>
|
||||
<li><a href='/docs/configuration/events/'>Events </a></li>
|
||||
<li><a href='/docs/configuration/state_object/'>State Objects </a></li>
|
||||
<li><a href='/docs/configuration/platform_options/'>Entity component platform options </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/automation/'>Automation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/automation/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/automation/trigger/'>Triggers </a></li>
|
||||
<li><a href='/docs/automation/condition/'>Conditions </a></li>
|
||||
<li><a href='/docs/automation/action/'>Actions </a></li>
|
||||
<li><a href='/docs/automation/templating/'>Templates </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/frontend/'>Frontend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/frontend/mobile/'>Android/iOS Homescreen </a></li>
|
||||
<li><a href='/docs/frontend/webserver/'>Web server fingerprint </a></li>
|
||||
<li><a href='/docs/frontend/browsers/'>Browser Compatibility List </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/backend/'>Backend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/backend/database/'>Database </a></li>
|
||||
<li><a href='/docs/backend/updater/'>Updater </a></li>
|
||||
<li><a href='/developers/api/'>API </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/scripts/'>Scripts </a>
|
||||
<ul>
|
||||
<li><a href='/docs/scripts/service-calls/'>Service Calls </a></li>
|
||||
<li><a href='/docs/scripts/conditions/'>Conditions </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/z-wave/'>Z-Wave </a>
|
||||
<ul>
|
||||
<li><a href='/docs/z-wave/controllers/'>Controllers </a></li>
|
||||
<li><a href='/docs/z-wave/settings/'>Modifying Settings </a></li>
|
||||
<li><a href='/docs/z-wave/device-specific/'>Device Specific </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/mqtt/'>MQTT </a>
|
||||
<ul>
|
||||
<li><a href='/docs/mqtt/broker/'>Broker </a></li>
|
||||
<li><a href='/docs/mqtt/certificate/'>Certificate </a></li>
|
||||
<li><a href='/docs/mqtt/discovery/'>Discovery </a></li>
|
||||
<li><a href='/docs/mqtt/service/'>Publish service </a></li>
|
||||
<li><a href='/docs/mqtt/birth_will/'>Birth and last will messages </a></li>
|
||||
<li><a href='/docs/mqtt/testing/'>Testing your setup </a></li>
|
||||
<li><a href='/docs/mqtt/logging/'>Logging </a></li>
|
||||
<li><a href='/docs/mqtt/processing_json/'>Processing JSON </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/'>Ecosystem </a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/autostart/'>Autostart </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/autostart/systemd/'>systemd (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/upstart/'>Upstart (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/init.d/'>init.d (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/macos/'>macOS </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/synology/'>Synology NAS </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/appdaemon/'>AppDaemon </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/appdaemon/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/configuration/'>Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/example_apps/'>Example Apps </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/running/'>Running AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/reboot/'>Starting AppDaemon at Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/operation/'>Operation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/windows/'>AppDaemon on Windows </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/updating/'>Updating AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/tutorial/'>AppDaemon Tutorial </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/api/'>AppDaemon API Reference </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/hadashboard/'>HADashboard </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/hadashboard/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/dash_config/'>Dashboard Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/hapush/'>HAPush </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/reboot/'>Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/updating/'>Updating HADashboard </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/notebooks/'>Notebooks </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/notebooks/'>Introduction </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/graph/'>Graph </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/api/'>Home Assistant API </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/database/'>Databsase </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/stats/'>Statistics </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/ios/notifications/'>iOS </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/basic/'>Basic notifications </a></li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/sounds/'>Sounds </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/architecture/'>Architecture </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/privacy_security_rate_limits/'>Privacy, rate limiting and security </a></li>
|
||||
</ul>
|
||||
<li>Advanced notifications</li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/attachments/'>Attachments </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/content_extensions/'>Dynamic content </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/actions/'>Actionable notifications </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/requesting_location_updates/'>Requesting location updates </a></li>
|
||||
</ul>
|
||||
<li><a href='/docs/ecosystem/ios/location/'>Location Tracking </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/integration/'>Integration with other apps </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</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>.<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>
|
||||
</body>
|
||||
</html>
|
||||
555
docs/installation/synology/index.html
Normal file
555
docs/installation/synology/index.html
Normal file
|
|
@ -0,0 +1,555 @@
|
|||
<!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>Installation on a Synology NAS - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="Instructions to install Home Assistant on a Synology NAS.">
|
||||
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/docs/installation/synology/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="Installation on a Synology NAS">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/docs/installation/synology/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="Instructions to install Home Assistant on a Synology NAS.">
|
||||
<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="Installation on a Synology NAS">
|
||||
<meta name="twitter:description" content="Instructions to install Home Assistant on a Synology NAS.">
|
||||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||||
|
||||
<link href="/stylesheets/screen.css" media="screen, projection" 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>
|
||||
<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>
|
||||
</ul>
|
||||
</nav>
|
||||
</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">
|
||||
|
||||
|
||||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_docs/installation/synology.markdown'>Edit this page on GitHub</a></div>
|
||||
|
||||
|
||||
|
||||
<header>
|
||||
<h1 class="title indent">
|
||||
Installation on a Synology NAS
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
||||
|
||||
<p>The following configuration has been tested on Synology 413j running DSM 6.0-7321 Update 1.</p>
|
||||
|
||||
<p>Running these commands will:</p>
|
||||
|
||||
<ul>
|
||||
<li>Install Home Assistant</li>
|
||||
<li>Enable Home Assistant to be launched on <a href="http://localhost:8123">http://localhost:8123</a></li>
|
||||
</ul>
|
||||
|
||||
<p>Using the Synology webadmin:</p>
|
||||
|
||||
<ul>
|
||||
<li>Install python3 using the Synology Package Center</li>
|
||||
<li>Create homeassistant user and add to the “users” group</li>
|
||||
</ul>
|
||||
|
||||
<p>SSH onto your synology & login as admin or root</p>
|
||||
|
||||
<ul>
|
||||
<li>Log in with your own administrator account</li>
|
||||
<li>Switch to root using:</li>
|
||||
</ul>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo -i
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Check the path to python3 (assumed to be /volume1/@appstore/py3k/usr/local/bin)</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span><span class="nb">cd</span> /volume1/@appstore/py3k/usr/local/bin
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Install PIP (Python’s package management system)</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>./python3 -m ensurepip
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Use PIP to install Homeassistant package</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>./python3 -m pip install homeassistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Create homeassistant config directory & switch to it</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>mkdir /volume1/homeassistant
|
||||
<span class="gp">$ </span><span class="nb">cd</span> /volume1/homeassistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Create hass-daemon file using the following code (edit the variables in uppercase if necessary)</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="c">#!/bin/sh</span>
|
||||
|
||||
<span class="c"># Package</span>
|
||||
<span class="nv">PACKAGE</span><span class="o">=</span><span class="s2">"homeassistant"</span>
|
||||
<span class="nv">DNAME</span><span class="o">=</span><span class="s2">"Home Assistant"</span>
|
||||
|
||||
<span class="c"># Others</span>
|
||||
<span class="nv">USER</span><span class="o">=</span><span class="s2">"homeassistant"</span>
|
||||
<span class="nv">PYTHON_DIR</span><span class="o">=</span><span class="s2">"/volume1/@appstore/py3k/usr/local/bin"</span>
|
||||
<span class="nv">PYTHON</span><span class="o">=</span><span class="s2">"</span><span class="nv">$PYTHON_DIR</span><span class="s2">/python3"</span>
|
||||
<span class="nv">HASS</span><span class="o">=</span><span class="s2">"</span><span class="nv">$PYTHON_DIR</span><span class="s2">/hass"</span>
|
||||
<span class="nv">INSTALL_DIR</span><span class="o">=</span><span class="s2">"/volume1/homeassistant"</span>
|
||||
<span class="nv">PID_FILE</span><span class="o">=</span><span class="s2">"</span><span class="nv">$INSTALL_DIR</span><span class="s2">/home-assistant.pid"</span>
|
||||
<span class="nv">FLAGS</span><span class="o">=</span><span class="s2">"-v --config </span><span class="nv">$INSTALL_DIR</span><span class="s2"> --pid-file </span><span class="nv">$PID_FILE</span><span class="s2"> --daemon"</span>
|
||||
<span class="gp">REDIRECT="> </span><span class="nv">$INSTALL_DIR</span>/home-assistant.log 2>&1<span class="s2">"
|
||||
|
||||
start_daemon ()
|
||||
{
|
||||
sudo -u </span><span class="k">${</span><span class="nv">USER</span><span class="k">}</span><span class="s2"> /bin/sh -c "</span><span class="nv">$PYTHON</span> <span class="nv">$HASS</span> <span class="nv">$FLAGS</span> <span class="nv">$REDIRECT</span>;<span class="s2">"
|
||||
}
|
||||
|
||||
stop_daemon ()
|
||||
{
|
||||
kill </span><span class="sb">`</span>cat <span class="k">${</span><span class="nv">PID_FILE</span><span class="k">}</span><span class="sb">`</span><span class="s2">
|
||||
wait_for_status 1 20 || kill -9 </span><span class="sb">`</span>cat <span class="k">${</span><span class="nv">PID_FILE</span><span class="k">}</span><span class="sb">`</span><span class="s2">
|
||||
rm -f </span><span class="k">${</span><span class="nv">PID_FILE</span><span class="k">}</span><span class="s2">
|
||||
}
|
||||
|
||||
daemon_status ()
|
||||
{
|
||||
if [ -f </span><span class="k">${</span><span class="nv">PID_FILE</span><span class="k">}</span><span class="s2"> ] && kill -0 </span><span class="sb">`</span>cat <span class="k">${</span><span class="nv">PID_FILE</span><span class="k">}</span><span class="sb">`</span><span class="s2"> > /dev/null 2>&1; then
|
||||
return
|
||||
fi
|
||||
rm -f </span><span class="k">${</span><span class="nv">PID_FILE</span><span class="k">}</span><span class="s2">
|
||||
return 1
|
||||
}
|
||||
|
||||
wait_for_status ()
|
||||
{
|
||||
counter=</span><span class="nv">$2</span><span class="s2">
|
||||
while [ </span><span class="k">${</span><span class="nv">counter</span><span class="k">}</span><span class="s2"> -gt 0 ]; do
|
||||
daemon_status
|
||||
[ </span><span class="nv">$?</span><span class="s2"> -eq </span><span class="nv">$1</span><span class="s2"> ] && return
|
||||
let counter=counter-1
|
||||
sleep 1
|
||||
done
|
||||
return 1
|
||||
}
|
||||
|
||||
case </span><span class="nv">$1</span><span class="s2"> in
|
||||
start)
|
||||
if daemon_status; then
|
||||
echo </span><span class="k">${</span><span class="nv">DNAME</span><span class="k">}</span><span class="s2"> is already running
|
||||
exit 0
|
||||
else
|
||||
echo Starting </span><span class="k">${</span><span class="nv">DNAME</span><span class="k">}</span><span class="s2"> ...
|
||||
start_daemon
|
||||
exit </span><span class="nv">$?</span><span class="s2">
|
||||
fi
|
||||
;;
|
||||
stop)
|
||||
if daemon_status; then
|
||||
echo Stopping </span><span class="k">${</span><span class="nv">DNAME</span><span class="k">}</span><span class="s2"> ...
|
||||
stop_daemon
|
||||
exit </span><span class="nv">$?</span><span class="s2">
|
||||
else
|
||||
echo </span><span class="k">${</span><span class="nv">DNAME</span><span class="k">}</span><span class="s2"> is not running
|
||||
exit 0
|
||||
fi
|
||||
;;
|
||||
restart)
|
||||
if daemon_status; then
|
||||
echo Stopping </span><span class="k">${</span><span class="nv">DNAME</span><span class="k">}</span><span class="s2"> ...
|
||||
stop_daemon
|
||||
echo Starting </span><span class="k">${</span><span class="nv">DNAME</span><span class="k">}</span><span class="s2"> ...
|
||||
start_daemon
|
||||
exit </span><span class="nv">$?</span><span class="s2">
|
||||
else
|
||||
echo </span><span class="k">${</span><span class="nv">DNAME</span><span class="k">}</span><span class="s2"> is not running
|
||||
echo Starting </span><span class="k">${</span><span class="nv">DNAME</span><span class="k">}</span><span class="s2"> ...
|
||||
start_daemon
|
||||
exit </span><span class="nv">$?</span><span class="s2">
|
||||
fi
|
||||
;;
|
||||
status)
|
||||
if daemon_status; then
|
||||
echo </span><span class="k">${</span><span class="nv">DNAME</span><span class="k">}</span><span class="s2"> is running
|
||||
exit 0
|
||||
else
|
||||
echo </span><span class="k">${</span><span class="nv">DNAME</span><span class="k">}</span><span class="s2"> is not running
|
||||
exit 1
|
||||
fi
|
||||
;;
|
||||
log)
|
||||
echo </span><span class="k">${</span><span class="nv">LOG_FILE</span><span class="k">}</span><span class="s2">
|
||||
exit 0
|
||||
;;
|
||||
*)
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
|
||||
</span></code></pre>
|
||||
</div>
|
||||
|
||||
<p>Create links to python folders to make things easier in the future:</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>ln -s /volume1/@appstore/py3k/usr/local/bin python3
|
||||
<span class="gp">$ </span>ln -s /volume1/@appstore/py3k/usr/local/lib/python3.5/site-packages/homeassistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Set the owner and permissions on your config folder</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>chown -R homeassistant:users /volume1/homeassistant
|
||||
<span class="gp">$ </span>chmod -R 664 /volume1/homeassistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Make the daemon file executable:</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>chmod 777 /volume1/homeassistant/hass-daemon
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Update your firewall (if it is turned on on the Synology device):</p>
|
||||
|
||||
<ul>
|
||||
<li>Go to your Synology control panel</li>
|
||||
<li>Go to security</li>
|
||||
<li>Go to firewall</li>
|
||||
<li>Go to Edit Rules</li>
|
||||
<li>Click Create</li>
|
||||
<li>Select Custom: Destination port “TCP”</li>
|
||||
<li>Type “8123” in port</li>
|
||||
<li>Click on OK</li>
|
||||
<li>Click on OK again</li>
|
||||
</ul>
|
||||
|
||||
<p>Copy your configuration.yaml file into the config folder
|
||||
That’s it… you’re all set to go</p>
|
||||
|
||||
<p>Here are some useful commands:</p>
|
||||
|
||||
<ul>
|
||||
<li>Start Home Assistant:</li>
|
||||
</ul>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo /volume1/homeassistant/hass-daemon start
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<ul>
|
||||
<li>Stop Home Assistant:</li>
|
||||
</ul>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo /volume1/homeassistant/hass-daemon stop
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<ul>
|
||||
<li>Restart Home Assistant:</li>
|
||||
</ul>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo /volume1/homeassistant/hass-daemon restart
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<ul>
|
||||
<li>Upgrade Home Assistant::</li>
|
||||
</ul>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>/volume1/@appstore/py3k/usr/local/bin/python3 -m pip install --upgrade homeassistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</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='section'>
|
||||
<h1 class="title delta">Topics</h1>
|
||||
<ul class='divided sidebar-menu'>
|
||||
<li>
|
||||
<a href='/docs/installation/'>Installation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/installation/python/'>Python </a></li>
|
||||
<li><a href='/docs/installation/virtualenv/'>Python Virtual Env </a></li>
|
||||
<li><a href='/docs/installation/docker/'>Docker </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi/'>Raspberry Pi </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi-all-in-one/'>Raspberrry Pi All-in-One </a></li>
|
||||
<li><a href='/docs/installation/vagrant/'>Vagrant </a></li>
|
||||
<li><a class='active' href='/docs/installation/synology/'>Synology </a></li>
|
||||
<li><a href='/docs/installation/updating/'>Updating </a></li>
|
||||
<li><a href='/docs/installation/troubleshooting/'>Troubleshooting </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/hassbian/'>Hassbian </a>
|
||||
<ul>
|
||||
<li><a href='/docs/hassbian/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/hassbian/customization/'>Customization </a></li>
|
||||
<li><a href='/docs/hassbian/common-tasks/'>Common tasks </a></li>
|
||||
<li><a href='/docs/hassbian/integrations/'>Integrations </a></li>
|
||||
<li><a href='/docs/hassbian/upgrading/'>Upgrading </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/configuration/'>Configuration </a>
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/yaml/'>YAML </a></li>
|
||||
<li><a href='/docs/configuration/basic/'>Basic information </a></li>
|
||||
<li><a href='/docs/configuration/devices/'>Setting up devices </a></li>
|
||||
<li><a href='/docs/configuration/customizing-devices/'>Customizing devices and services </a></li>
|
||||
<li><a href='/docs/configuration/presence-detection/'>Presence Detection </a></li>
|
||||
<li><a href='/docs/configuration/troubleshooting/'>Troubleshooting </a></li>
|
||||
<li><a href='/docs/configuration/securing/'>Security Check Points </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Advanced Configuration
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/remote/'>Remote access </a></li>
|
||||
<li><a href='/docs/configuration/packages/'>Packages </a></li>
|
||||
<li><a href='/docs/configuration/splitting_configuration/'>Splitting up the configuration </a></li>
|
||||
<li><a href='/docs/configuration/secrets/'>Storing Secrets </a></li>
|
||||
<li><a href='/docs/configuration/templating/'>Templating </a></li>
|
||||
<li><a href='/docs/configuration/group_visibility/'>Group Visibility </a></li>
|
||||
<li><a href='/docs/configuration/events/'>Events </a></li>
|
||||
<li><a href='/docs/configuration/state_object/'>State Objects </a></li>
|
||||
<li><a href='/docs/configuration/platform_options/'>Entity component platform options </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/automation/'>Automation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/automation/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/automation/trigger/'>Triggers </a></li>
|
||||
<li><a href='/docs/automation/condition/'>Conditions </a></li>
|
||||
<li><a href='/docs/automation/action/'>Actions </a></li>
|
||||
<li><a href='/docs/automation/templating/'>Templates </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/frontend/'>Frontend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/frontend/mobile/'>Android/iOS Homescreen </a></li>
|
||||
<li><a href='/docs/frontend/webserver/'>Web server fingerprint </a></li>
|
||||
<li><a href='/docs/frontend/browsers/'>Browser Compatibility List </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/backend/'>Backend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/backend/database/'>Database </a></li>
|
||||
<li><a href='/docs/backend/updater/'>Updater </a></li>
|
||||
<li><a href='/developers/api/'>API </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/scripts/'>Scripts </a>
|
||||
<ul>
|
||||
<li><a href='/docs/scripts/service-calls/'>Service Calls </a></li>
|
||||
<li><a href='/docs/scripts/conditions/'>Conditions </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/z-wave/'>Z-Wave </a>
|
||||
<ul>
|
||||
<li><a href='/docs/z-wave/controllers/'>Controllers </a></li>
|
||||
<li><a href='/docs/z-wave/settings/'>Modifying Settings </a></li>
|
||||
<li><a href='/docs/z-wave/device-specific/'>Device Specific </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/mqtt/'>MQTT </a>
|
||||
<ul>
|
||||
<li><a href='/docs/mqtt/broker/'>Broker </a></li>
|
||||
<li><a href='/docs/mqtt/certificate/'>Certificate </a></li>
|
||||
<li><a href='/docs/mqtt/discovery/'>Discovery </a></li>
|
||||
<li><a href='/docs/mqtt/service/'>Publish service </a></li>
|
||||
<li><a href='/docs/mqtt/birth_will/'>Birth and last will messages </a></li>
|
||||
<li><a href='/docs/mqtt/testing/'>Testing your setup </a></li>
|
||||
<li><a href='/docs/mqtt/logging/'>Logging </a></li>
|
||||
<li><a href='/docs/mqtt/processing_json/'>Processing JSON </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/'>Ecosystem </a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/autostart/'>Autostart </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/autostart/systemd/'>systemd (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/upstart/'>Upstart (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/init.d/'>init.d (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/macos/'>macOS </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/synology/'>Synology NAS </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/appdaemon/'>AppDaemon </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/appdaemon/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/configuration/'>Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/example_apps/'>Example Apps </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/running/'>Running AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/reboot/'>Starting AppDaemon at Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/operation/'>Operation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/windows/'>AppDaemon on Windows </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/updating/'>Updating AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/tutorial/'>AppDaemon Tutorial </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/api/'>AppDaemon API Reference </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/hadashboard/'>HADashboard </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/hadashboard/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/dash_config/'>Dashboard Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/hapush/'>HAPush </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/reboot/'>Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/updating/'>Updating HADashboard </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/notebooks/'>Notebooks </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/notebooks/'>Introduction </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/graph/'>Graph </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/api/'>Home Assistant API </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/database/'>Databsase </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/stats/'>Statistics </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/ios/notifications/'>iOS </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/basic/'>Basic notifications </a></li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/sounds/'>Sounds </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/architecture/'>Architecture </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/privacy_security_rate_limits/'>Privacy, rate limiting and security </a></li>
|
||||
</ul>
|
||||
<li>Advanced notifications</li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/attachments/'>Attachments </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/content_extensions/'>Dynamic content </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/actions/'>Actionable notifications </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/requesting_location_updates/'>Requesting location updates </a></li>
|
||||
</ul>
|
||||
<li><a href='/docs/ecosystem/ios/location/'>Location Tracking </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/integration/'>Integration with other apps </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</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>.<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>
|
||||
</body>
|
||||
</html>
|
||||
391
docs/installation/troubleshooting/index.html
Normal file
391
docs/installation/troubleshooting/index.html
Normal file
|
|
@ -0,0 +1,391 @@
|
|||
<!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>Troubleshooting installation problems - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="Common installation problems and their solutions.">
|
||||
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/docs/installation/troubleshooting/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="Troubleshooting installation problems">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/docs/installation/troubleshooting/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="Common installation problems and their solutions.">
|
||||
<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="Troubleshooting installation problems">
|
||||
<meta name="twitter:description" content="Common installation problems and their solutions.">
|
||||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||||
|
||||
<link href="/stylesheets/screen.css" media="screen, projection" 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>
|
||||
<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>
|
||||
</ul>
|
||||
</nav>
|
||||
</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">
|
||||
|
||||
|
||||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_docs/installation/troubleshooting.markdown'>Edit this page on GitHub</a></div>
|
||||
|
||||
|
||||
|
||||
<header>
|
||||
<h1 class="title indent">
|
||||
Troubleshooting Installation Problems
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
||||
|
||||
<p>It can happen that you run into trouble while installing Home Assistant. This page is here to help you solve the most common problems.</p>
|
||||
|
||||
<h4><a class="title-link" name="pip3-command-not-found" href="#pip3-command-not-found"></a> pip3: command not found</h4>
|
||||
<p>This utility should have been installed as part of the Python 3.4 installation. Check if Python 3.4 is installed by running <code class="highlighter-rouge">python3 --version</code>. If it is not installed, <a href="https://www.python.org/getit/">download it here</a>.</p>
|
||||
|
||||
<p>If you are able to successfully run <code class="highlighter-rouge">python3 --version</code> but not <code class="highlighter-rouge">pip3</code>, install Home Assistant by running the following command instead:</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>python3 -m pip install homeassistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>On a Debian system, you can also install python3 by <code class="highlighter-rouge">sudo apt-get install python3</code>, and pip3 by <code class="highlighter-rouge">sudo apt-get install python3-pip</code>.</p>
|
||||
|
||||
<h4><a class="title-link" name="no-module-named-pip" href="#no-module-named-pip"></a> No module named pip</h4>
|
||||
<p><a href="https://pip.pypa.io/en/stable/">Pip</a> should come bundled with the latest Python 3 but is omitted by some distributions. If you are unable to run <code class="highlighter-rouge">python3 -m pip --version</code> you can install <code class="highlighter-rouge">pip</code> by <a href="https://bootstrap.pypa.io/get-pip.py">downloading the installer</a> and running it with Python 3:</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>python3 get-pip.py
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h4><a class="title-link" name="libyaml-is-not-found-or-a-compiler-error" href="#libyaml-is-not-found-or-a-compiler-error"></a> libyaml is not found or a compiler error</h4>
|
||||
|
||||
<p>On a Debian system, install the Python 3 YAML library by <code class="highlighter-rouge">sudo apt-get install python3-yaml</code>.</p>
|
||||
|
||||
<h4><a class="title-link" name="distutilserrorsdistutilsoptionerror-must-supply-either-home-or-prefixexec-prefix----not-both" href="#distutilserrorsdistutilsoptionerror-must-supply-either-home-or-prefixexec-prefix----not-both"></a> distutils.errors.DistutilsOptionError: must supply either home or prefix/exec-prefix – not both</h4>
|
||||
<p>This is a known issue if you’re on a Mac using Homebrew to install Python. Please follow <a href="https://github.com/Homebrew/brew/blob/master/docs/Homebrew-and-Python.md#note-on-pip-install---user">these instructions</a> to resolve it.</p>
|
||||
|
||||
<h4><a class="title-link" name="centos-and-python-3" href="#centos-and-python-3"></a> CentOS and Python 3</h4>
|
||||
<p>To run Python 3.x on <a href="https://www.centos.org/">CentOS</a> or RHEL, <a href="https://www.softwarecollections.org/en/scls/rhscl/rh-python34/">Software Collections</a> needs to be activated.</p>
|
||||
|
||||
<h4><a class="title-link" name="no-access-to-the-frontend" href="#no-access-to-the-frontend"></a> No access to the frontend</h4>
|
||||
<p>In newer Linux distributions (at least Fedora > 22/CentOS 7) the access to a host is very limited. This means that you can’t access the Home Assistant frontend that is running on a host outside of the host machine. Windows and macOS machines may also have issues with this.</p>
|
||||
|
||||
<p>To fix this you will need to open your machine’s firewall for TCP traffic to port 8123. The method for doing this will vary depending on your operating system and the firewall you have installed. Below are some suggestions to try. Google is your friend here.</p>
|
||||
|
||||
<ul>
|
||||
<li><a href="http://windows.microsoft.com/en-us/windows/open-port-windows-firewall#1TC=windows-7">Windows instructions</a></li>
|
||||
<li><a href="https://support.apple.com/en-us/HT201642">macOS instructions</a></li>
|
||||
</ul>
|
||||
|
||||
<p>For systems with <strong>firewalld</strong> (Fedora, CentOS/RHEL, etc.):</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo firewall-cmd --permanent --add-port<span class="o">=</span>8123/tcp
|
||||
<span class="gp">$ </span>sudo firewall-cmd --reload
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>For UFW systems (Ubuntu, Debian, Raspbian, etc.):</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo ufw allow 8123/tcp
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>For <code class="highlighter-rouge">iptables</code> systems (was the default for older distributions):</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>iptables -I INPUT -p tcp --dport 8123 -j ACCEPT
|
||||
<span class="gp">$ </span>iptables-save > /etc/network/iptables.rules <span class="c"># your rules may be saved elsewhere</span>
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h4><a class="title-link" name="after-upgrading-your-browser-login-gets-stuck-at-the-loading-data-step" href="#after-upgrading-your-browser-login-gets-stuck-at-the-loading-data-step"></a> After upgrading, your browser login gets stuck at the “loading data” step</h4>
|
||||
<p>After upgrading to a new version, you may notice your browser gets stuck at the “loading data” login screen. Close the window/tab and go into your browser settings and delete all the cookies for your URL. You can then log back in and it should work.</p>
|
||||
|
||||
<p>Android Chrome
|
||||
chrome -> settings -> site settings -> storage -> search for your URL for home assistant-> “clear & reset”</p>
|
||||
|
||||
|
||||
|
||||
</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='section'>
|
||||
<h1 class="title delta">Topics</h1>
|
||||
<ul class='divided sidebar-menu'>
|
||||
<li>
|
||||
<a href='/docs/installation/'>Installation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/installation/python/'>Python </a></li>
|
||||
<li><a href='/docs/installation/virtualenv/'>Python Virtual Env </a></li>
|
||||
<li><a href='/docs/installation/docker/'>Docker </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi/'>Raspberry Pi </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi-all-in-one/'>Raspberrry Pi All-in-One </a></li>
|
||||
<li><a href='/docs/installation/vagrant/'>Vagrant </a></li>
|
||||
<li><a href='/docs/installation/synology/'>Synology </a></li>
|
||||
<li><a href='/docs/installation/updating/'>Updating </a></li>
|
||||
<li><a class='active' href='/docs/installation/troubleshooting/'>Troubleshooting </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/hassbian/'>Hassbian </a>
|
||||
<ul>
|
||||
<li><a href='/docs/hassbian/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/hassbian/customization/'>Customization </a></li>
|
||||
<li><a href='/docs/hassbian/common-tasks/'>Common tasks </a></li>
|
||||
<li><a href='/docs/hassbian/integrations/'>Integrations </a></li>
|
||||
<li><a href='/docs/hassbian/upgrading/'>Upgrading </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/configuration/'>Configuration </a>
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/yaml/'>YAML </a></li>
|
||||
<li><a href='/docs/configuration/basic/'>Basic information </a></li>
|
||||
<li><a href='/docs/configuration/devices/'>Setting up devices </a></li>
|
||||
<li><a href='/docs/configuration/customizing-devices/'>Customizing devices and services </a></li>
|
||||
<li><a href='/docs/configuration/presence-detection/'>Presence Detection </a></li>
|
||||
<li><a href='/docs/configuration/troubleshooting/'>Troubleshooting </a></li>
|
||||
<li><a href='/docs/configuration/securing/'>Security Check Points </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Advanced Configuration
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/remote/'>Remote access </a></li>
|
||||
<li><a href='/docs/configuration/packages/'>Packages </a></li>
|
||||
<li><a href='/docs/configuration/splitting_configuration/'>Splitting up the configuration </a></li>
|
||||
<li><a href='/docs/configuration/secrets/'>Storing Secrets </a></li>
|
||||
<li><a href='/docs/configuration/templating/'>Templating </a></li>
|
||||
<li><a href='/docs/configuration/group_visibility/'>Group Visibility </a></li>
|
||||
<li><a href='/docs/configuration/events/'>Events </a></li>
|
||||
<li><a href='/docs/configuration/state_object/'>State Objects </a></li>
|
||||
<li><a href='/docs/configuration/platform_options/'>Entity component platform options </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/automation/'>Automation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/automation/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/automation/trigger/'>Triggers </a></li>
|
||||
<li><a href='/docs/automation/condition/'>Conditions </a></li>
|
||||
<li><a href='/docs/automation/action/'>Actions </a></li>
|
||||
<li><a href='/docs/automation/templating/'>Templates </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/frontend/'>Frontend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/frontend/mobile/'>Android/iOS Homescreen </a></li>
|
||||
<li><a href='/docs/frontend/webserver/'>Web server fingerprint </a></li>
|
||||
<li><a href='/docs/frontend/browsers/'>Browser Compatibility List </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/backend/'>Backend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/backend/database/'>Database </a></li>
|
||||
<li><a href='/docs/backend/updater/'>Updater </a></li>
|
||||
<li><a href='/developers/api/'>API </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/scripts/'>Scripts </a>
|
||||
<ul>
|
||||
<li><a href='/docs/scripts/service-calls/'>Service Calls </a></li>
|
||||
<li><a href='/docs/scripts/conditions/'>Conditions </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/z-wave/'>Z-Wave </a>
|
||||
<ul>
|
||||
<li><a href='/docs/z-wave/controllers/'>Controllers </a></li>
|
||||
<li><a href='/docs/z-wave/settings/'>Modifying Settings </a></li>
|
||||
<li><a href='/docs/z-wave/device-specific/'>Device Specific </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/mqtt/'>MQTT </a>
|
||||
<ul>
|
||||
<li><a href='/docs/mqtt/broker/'>Broker </a></li>
|
||||
<li><a href='/docs/mqtt/certificate/'>Certificate </a></li>
|
||||
<li><a href='/docs/mqtt/discovery/'>Discovery </a></li>
|
||||
<li><a href='/docs/mqtt/service/'>Publish service </a></li>
|
||||
<li><a href='/docs/mqtt/birth_will/'>Birth and last will messages </a></li>
|
||||
<li><a href='/docs/mqtt/testing/'>Testing your setup </a></li>
|
||||
<li><a href='/docs/mqtt/logging/'>Logging </a></li>
|
||||
<li><a href='/docs/mqtt/processing_json/'>Processing JSON </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/'>Ecosystem </a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/autostart/'>Autostart </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/autostart/systemd/'>systemd (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/upstart/'>Upstart (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/init.d/'>init.d (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/macos/'>macOS </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/synology/'>Synology NAS </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/appdaemon/'>AppDaemon </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/appdaemon/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/configuration/'>Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/example_apps/'>Example Apps </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/running/'>Running AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/reboot/'>Starting AppDaemon at Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/operation/'>Operation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/windows/'>AppDaemon on Windows </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/updating/'>Updating AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/tutorial/'>AppDaemon Tutorial </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/api/'>AppDaemon API Reference </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/hadashboard/'>HADashboard </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/hadashboard/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/dash_config/'>Dashboard Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/hapush/'>HAPush </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/reboot/'>Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/updating/'>Updating HADashboard </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/notebooks/'>Notebooks </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/notebooks/'>Introduction </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/graph/'>Graph </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/api/'>Home Assistant API </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/database/'>Databsase </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/stats/'>Statistics </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/ios/notifications/'>iOS </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/basic/'>Basic notifications </a></li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/sounds/'>Sounds </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/architecture/'>Architecture </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/privacy_security_rate_limits/'>Privacy, rate limiting and security </a></li>
|
||||
</ul>
|
||||
<li>Advanced notifications</li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/attachments/'>Attachments </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/content_extensions/'>Dynamic content </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/actions/'>Actionable notifications </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/requesting_location_updates/'>Requesting location updates </a></li>
|
||||
</ul>
|
||||
<li><a href='/docs/ecosystem/ios/location/'>Location Tracking </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/integration/'>Integration with other apps </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</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>.<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>
|
||||
</body>
|
||||
</html>
|
||||
362
docs/installation/updating/index.html
Normal file
362
docs/installation/updating/index.html
Normal file
|
|
@ -0,0 +1,362 @@
|
|||
<!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>Updating Home Assistant - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="Step to update Home Assistant.">
|
||||
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/docs/installation/updating/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="Updating Home Assistant">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/docs/installation/updating/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="Step to update Home Assistant.">
|
||||
<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="Updating Home Assistant">
|
||||
<meta name="twitter:description" content="Step to update Home Assistant.">
|
||||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||||
|
||||
<link href="/stylesheets/screen.css" media="screen, projection" 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>
|
||||
<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>
|
||||
</ul>
|
||||
</nav>
|
||||
</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">
|
||||
|
||||
|
||||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_docs/installation/updating.markdown'>Edit this page on GitHub</a></div>
|
||||
|
||||
|
||||
|
||||
<header>
|
||||
<h1 class="title indent">
|
||||
Updating Home Assistant
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
||||
|
||||
<p class="note warning">
|
||||
The upgrade process differs depending on the installation you have, so please review the documentation that is specific to your install <a href="/docs/hassbian/common-tasks/#update-home-assistant">HASSbian</a>, <a href="/docs/installation/raspberry-pi-all-in-one/#upgrading">Raspberry Pi All-In-One Installer</a>, <a href="/docs/installation/vagrant/">Vagrant</a>, or <a href="/docs/installation/virtualenv/#upgrading-home-assistant">Virtualenv</a>.
|
||||
</p>
|
||||
|
||||
<p>The default way to update Home Assistant to the latest release, when available, is:</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>pip3 install --upgrade homeassistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>After updating, you must restart Home Assistant for the changes to take effect. This means that you will have to restart <code class="highlighter-rouge">hass</code> itself or the <a href="/docs/autostart/">autostarting</a> daemon (if applicable)</p>
|
||||
|
||||
<p class="note">
|
||||
To avoid permission errors, the upgrade must be run as the same user as the installation was completed, again review the documentation specific to your install <a href="/docs/hassbian/installation/">HASSbian</a>, <a href="/docs/installation/raspberry-pi-all-in-one/">Raspberry Pi All-In-One Installer</a>, <a href="/docs/installation/vagrant/">Vagrant</a>, or <a href="/docs/installation/virtualenv">Virtualenv</a>.
|
||||
</p>
|
||||
|
||||
<p><a href="http://www.bruhautomation.com">BRUH automation</a> has created <a href="https://www.youtube.com/watch?v=tuG2rs1Cl2Y">a tutorial video</a> explaining how to upgrade Home Assistant.</p>
|
||||
|
||||
<h4><a class="title-link" name="run-a-specific-version" href="#run-a-specific-version"></a> Run a specific version</h4>
|
||||
|
||||
<p>In the event that a Home Assistant version doesn’t play well with your hardware setup, you can downgrade to a previous release:</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>pip3 install <span class="nv">homeassistant</span><span class="o">==</span>0.XX.X
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h4><a class="title-link" name="run-the-development-version" href="#run-the-development-version"></a> Run the development version</h4>
|
||||
|
||||
<p>If you want to stay on the bleeding-edge Home Assistant development branch, you can upgrade to <code class="highlighter-rouge">dev</code>.</p>
|
||||
|
||||
<p class="note warning">
|
||||
The “dev” branch is likely to be unstable. Potential consequences include loss of data and instance corruption.
|
||||
</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>pip3 install --upgrade git+git://github.com/home-assistant/home-assistant.git@dev
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
</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='section'>
|
||||
<h1 class="title delta">Topics</h1>
|
||||
<ul class='divided sidebar-menu'>
|
||||
<li>
|
||||
<a href='/docs/installation/'>Installation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/installation/python/'>Python </a></li>
|
||||
<li><a href='/docs/installation/virtualenv/'>Python Virtual Env </a></li>
|
||||
<li><a href='/docs/installation/docker/'>Docker </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi/'>Raspberry Pi </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi-all-in-one/'>Raspberrry Pi All-in-One </a></li>
|
||||
<li><a href='/docs/installation/vagrant/'>Vagrant </a></li>
|
||||
<li><a href='/docs/installation/synology/'>Synology </a></li>
|
||||
<li><a class='active' href='/docs/installation/updating/'>Updating </a></li>
|
||||
<li><a href='/docs/installation/troubleshooting/'>Troubleshooting </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/hassbian/'>Hassbian </a>
|
||||
<ul>
|
||||
<li><a href='/docs/hassbian/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/hassbian/customization/'>Customization </a></li>
|
||||
<li><a href='/docs/hassbian/common-tasks/'>Common tasks </a></li>
|
||||
<li><a href='/docs/hassbian/integrations/'>Integrations </a></li>
|
||||
<li><a href='/docs/hassbian/upgrading/'>Upgrading </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/configuration/'>Configuration </a>
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/yaml/'>YAML </a></li>
|
||||
<li><a href='/docs/configuration/basic/'>Basic information </a></li>
|
||||
<li><a href='/docs/configuration/devices/'>Setting up devices </a></li>
|
||||
<li><a href='/docs/configuration/customizing-devices/'>Customizing devices and services </a></li>
|
||||
<li><a href='/docs/configuration/presence-detection/'>Presence Detection </a></li>
|
||||
<li><a href='/docs/configuration/troubleshooting/'>Troubleshooting </a></li>
|
||||
<li><a href='/docs/configuration/securing/'>Security Check Points </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Advanced Configuration
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/remote/'>Remote access </a></li>
|
||||
<li><a href='/docs/configuration/packages/'>Packages </a></li>
|
||||
<li><a href='/docs/configuration/splitting_configuration/'>Splitting up the configuration </a></li>
|
||||
<li><a href='/docs/configuration/secrets/'>Storing Secrets </a></li>
|
||||
<li><a href='/docs/configuration/templating/'>Templating </a></li>
|
||||
<li><a href='/docs/configuration/group_visibility/'>Group Visibility </a></li>
|
||||
<li><a href='/docs/configuration/events/'>Events </a></li>
|
||||
<li><a href='/docs/configuration/state_object/'>State Objects </a></li>
|
||||
<li><a href='/docs/configuration/platform_options/'>Entity component platform options </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/automation/'>Automation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/automation/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/automation/trigger/'>Triggers </a></li>
|
||||
<li><a href='/docs/automation/condition/'>Conditions </a></li>
|
||||
<li><a href='/docs/automation/action/'>Actions </a></li>
|
||||
<li><a href='/docs/automation/templating/'>Templates </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/frontend/'>Frontend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/frontend/mobile/'>Android/iOS Homescreen </a></li>
|
||||
<li><a href='/docs/frontend/webserver/'>Web server fingerprint </a></li>
|
||||
<li><a href='/docs/frontend/browsers/'>Browser Compatibility List </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/backend/'>Backend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/backend/database/'>Database </a></li>
|
||||
<li><a href='/docs/backend/updater/'>Updater </a></li>
|
||||
<li><a href='/developers/api/'>API </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/scripts/'>Scripts </a>
|
||||
<ul>
|
||||
<li><a href='/docs/scripts/service-calls/'>Service Calls </a></li>
|
||||
<li><a href='/docs/scripts/conditions/'>Conditions </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/z-wave/'>Z-Wave </a>
|
||||
<ul>
|
||||
<li><a href='/docs/z-wave/controllers/'>Controllers </a></li>
|
||||
<li><a href='/docs/z-wave/settings/'>Modifying Settings </a></li>
|
||||
<li><a href='/docs/z-wave/device-specific/'>Device Specific </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/mqtt/'>MQTT </a>
|
||||
<ul>
|
||||
<li><a href='/docs/mqtt/broker/'>Broker </a></li>
|
||||
<li><a href='/docs/mqtt/certificate/'>Certificate </a></li>
|
||||
<li><a href='/docs/mqtt/discovery/'>Discovery </a></li>
|
||||
<li><a href='/docs/mqtt/service/'>Publish service </a></li>
|
||||
<li><a href='/docs/mqtt/birth_will/'>Birth and last will messages </a></li>
|
||||
<li><a href='/docs/mqtt/testing/'>Testing your setup </a></li>
|
||||
<li><a href='/docs/mqtt/logging/'>Logging </a></li>
|
||||
<li><a href='/docs/mqtt/processing_json/'>Processing JSON </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/'>Ecosystem </a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/autostart/'>Autostart </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/autostart/systemd/'>systemd (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/upstart/'>Upstart (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/init.d/'>init.d (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/macos/'>macOS </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/synology/'>Synology NAS </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/appdaemon/'>AppDaemon </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/appdaemon/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/configuration/'>Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/example_apps/'>Example Apps </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/running/'>Running AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/reboot/'>Starting AppDaemon at Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/operation/'>Operation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/windows/'>AppDaemon on Windows </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/updating/'>Updating AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/tutorial/'>AppDaemon Tutorial </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/api/'>AppDaemon API Reference </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/hadashboard/'>HADashboard </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/hadashboard/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/dash_config/'>Dashboard Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/hapush/'>HAPush </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/reboot/'>Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/updating/'>Updating HADashboard </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/notebooks/'>Notebooks </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/notebooks/'>Introduction </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/graph/'>Graph </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/api/'>Home Assistant API </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/database/'>Databsase </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/stats/'>Statistics </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/ios/notifications/'>iOS </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/basic/'>Basic notifications </a></li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/sounds/'>Sounds </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/architecture/'>Architecture </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/privacy_security_rate_limits/'>Privacy, rate limiting and security </a></li>
|
||||
</ul>
|
||||
<li>Advanced notifications</li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/attachments/'>Attachments </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/content_extensions/'>Dynamic content </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/actions/'>Actionable notifications </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/requesting_location_updates/'>Requesting location updates </a></li>
|
||||
</ul>
|
||||
<li><a href='/docs/ecosystem/ios/location/'>Location Tracking </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/integration/'>Integration with other apps </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</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>.<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>
|
||||
</body>
|
||||
</html>
|
||||
402
docs/installation/vagrant/index.html
Normal file
402
docs/installation/vagrant/index.html
Normal file
|
|
@ -0,0 +1,402 @@
|
|||
<!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>Installation on Vagrant - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="Instructions to run Home Assistant on a Vagrant VM.">
|
||||
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/docs/installation/vagrant/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="Installation on Vagrant">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/docs/installation/vagrant/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="Instructions to run Home Assistant on a Vagrant VM.">
|
||||
<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="Installation on Vagrant">
|
||||
<meta name="twitter:description" content="Instructions to run Home Assistant on a Vagrant VM.">
|
||||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||||
|
||||
<link href="/stylesheets/screen.css" media="screen, projection" 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>
|
||||
<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>
|
||||
</ul>
|
||||
</nav>
|
||||
</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">
|
||||
|
||||
|
||||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_docs/installation/vagrant.markdown'>Edit this page on GitHub</a></div>
|
||||
|
||||
|
||||
|
||||
<header>
|
||||
<h1 class="title indent">
|
||||
Installation on Vagrant
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
||||
|
||||
<p>A <code class="highlighter-rouge">Vagrantfile</code> is available into <code class="highlighter-rouge">virtualization/vagrant</code> folder for quickly spinning up a Linux virtual machine running Home Assistant. This can be beneficial for those who want to experiment with Home Assistant and/or developers willing to easily test local changes and run test suite against them.</p>
|
||||
|
||||
<p class="note">
|
||||
Vagrant is intended for testing/development only. It is NOT recommended for permanent installations.
|
||||
</p>
|
||||
|
||||
<h2><a class="title-link" name="install-vagrant" href="#install-vagrant"></a> Install Vagrant</h2>
|
||||
|
||||
<p>You must have <a href="https://www.vagrantup.com/downloads.html">Vagrant</a> and <a href="https://www.virtualbox.org/wiki/Downloads">Virtualbox</a> installed on your workstation.</p>
|
||||
|
||||
<h2><a class="title-link" name="get-home-assistant-source-code" href="#get-home-assistant-source-code"></a> Get Home Assistant source code</h2>
|
||||
|
||||
<p>Download the Home Assistant source code by either downloading the .zip file from <a href="https://github.com/home-assistant/home-assistant/releases">GitHub releases page</a> or by using <a href="https://git-scm.com/">Git</a></p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>git clone https://github.com/home-assistant/home-assistant.git
|
||||
<span class="gp">$ </span><span class="nb">cd </span>home-assistant/virtualization/vagrant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p class="note">
|
||||
The following instructions will assume you changed your working directory to be <code class="highlighter-rouge">home-assistant/virtualization/vagrant</code>. This is mandatory because Vagrant will look for informations about the running VM inside that folder and won’t work otherwise
|
||||
</p>
|
||||
|
||||
<p class="note">
|
||||
When using Vagrant on Windows, change git’s <code class="highlighter-rouge">auto.crlf</code> to input before cloning the Home Assistant repository. With input setting git won’t automatically change line endings from Unix LF to Windows CRLF. Shell scripts executed during provision won’t work with Windows line endings.
|
||||
</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>git config --global core.autocrlf input
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h2><a class="title-link" name="create-the-vagrant-vm-and-start-home-assistant" href="#create-the-vagrant-vm-and-start-home-assistant"></a> Create the Vagrant VM and start Home Assistant</h2>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>vagrant up
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>This will download and start a virtual machine using Virtualbox, which will internally setup the development environment necessary to start Home Assistant process and run test suite as well. After the VM has started successfully, the Home Assistant frontend will be accessible locally from your browser at <a href="http://localhost:8123">http://localhost:8123</a></p>
|
||||
|
||||
<h2><a class="title-link" name="stopping-vagrant" href="#stopping-vagrant"></a> Stopping Vagrant</h2>
|
||||
|
||||
<p>To shutdown the Vagrant host:</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>vagrant halt
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>To start it again, just run <code class="highlighter-rouge">vagrant up</code></p>
|
||||
|
||||
<h2><a class="title-link" name="restarting-home-assistant-process-to-test-changes" href="#restarting-home-assistant-process-to-test-changes"></a> Restarting Home Assistant process to test changes</h2>
|
||||
|
||||
<p>The root <code class="highlighter-rouge">home-assistant</code> directory on your workstation will be mirrored with <code class="highlighter-rouge">/home-assistant</code> inside the VM. In <code class="highlighter-rouge">virtualization/vagrant</code> there’s also a <code class="highlighter-rouge">config</code> folder that you can use to drop configuration files (Check the <a href="/docs/configuration/">Configuration section</a> in the docmentation for more information about how to configure Home Assistant).</p>
|
||||
|
||||
<p>Any changes made to the local directory on your workstation will be available from the Vagrant host, so to apply your changes to the Home Assistant process, just restart it:</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>touch restart ; vagrant provision
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h2><a class="title-link" name="run-test-suite-tox" href="#run-test-suite-tox"></a> Run test suite (Tox)</h2>
|
||||
|
||||
<p>To run tests against your changes:</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>touch run_tests ; vagrant provision
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h2><a class="title-link" name="cleanup" href="#cleanup"></a> Cleanup</h2>
|
||||
|
||||
<p>To completely remove the VM:</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>rm setup_done ; vagrant destroy -f
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>You can now recreate a completely new Vagrant host with <code class="highlighter-rouge">vagrant up</code></p>
|
||||
|
||||
|
||||
|
||||
</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='section'>
|
||||
<h1 class="title delta">Topics</h1>
|
||||
<ul class='divided sidebar-menu'>
|
||||
<li>
|
||||
<a href='/docs/installation/'>Installation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/installation/python/'>Python </a></li>
|
||||
<li><a href='/docs/installation/virtualenv/'>Python Virtual Env </a></li>
|
||||
<li><a href='/docs/installation/docker/'>Docker </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi/'>Raspberry Pi </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi-all-in-one/'>Raspberrry Pi All-in-One </a></li>
|
||||
<li><a class='active' href='/docs/installation/vagrant/'>Vagrant </a></li>
|
||||
<li><a href='/docs/installation/synology/'>Synology </a></li>
|
||||
<li><a href='/docs/installation/updating/'>Updating </a></li>
|
||||
<li><a href='/docs/installation/troubleshooting/'>Troubleshooting </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/hassbian/'>Hassbian </a>
|
||||
<ul>
|
||||
<li><a href='/docs/hassbian/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/hassbian/customization/'>Customization </a></li>
|
||||
<li><a href='/docs/hassbian/common-tasks/'>Common tasks </a></li>
|
||||
<li><a href='/docs/hassbian/integrations/'>Integrations </a></li>
|
||||
<li><a href='/docs/hassbian/upgrading/'>Upgrading </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/configuration/'>Configuration </a>
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/yaml/'>YAML </a></li>
|
||||
<li><a href='/docs/configuration/basic/'>Basic information </a></li>
|
||||
<li><a href='/docs/configuration/devices/'>Setting up devices </a></li>
|
||||
<li><a href='/docs/configuration/customizing-devices/'>Customizing devices and services </a></li>
|
||||
<li><a href='/docs/configuration/presence-detection/'>Presence Detection </a></li>
|
||||
<li><a href='/docs/configuration/troubleshooting/'>Troubleshooting </a></li>
|
||||
<li><a href='/docs/configuration/securing/'>Security Check Points </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Advanced Configuration
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/remote/'>Remote access </a></li>
|
||||
<li><a href='/docs/configuration/packages/'>Packages </a></li>
|
||||
<li><a href='/docs/configuration/splitting_configuration/'>Splitting up the configuration </a></li>
|
||||
<li><a href='/docs/configuration/secrets/'>Storing Secrets </a></li>
|
||||
<li><a href='/docs/configuration/templating/'>Templating </a></li>
|
||||
<li><a href='/docs/configuration/group_visibility/'>Group Visibility </a></li>
|
||||
<li><a href='/docs/configuration/events/'>Events </a></li>
|
||||
<li><a href='/docs/configuration/state_object/'>State Objects </a></li>
|
||||
<li><a href='/docs/configuration/platform_options/'>Entity component platform options </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/automation/'>Automation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/automation/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/automation/trigger/'>Triggers </a></li>
|
||||
<li><a href='/docs/automation/condition/'>Conditions </a></li>
|
||||
<li><a href='/docs/automation/action/'>Actions </a></li>
|
||||
<li><a href='/docs/automation/templating/'>Templates </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/frontend/'>Frontend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/frontend/mobile/'>Android/iOS Homescreen </a></li>
|
||||
<li><a href='/docs/frontend/webserver/'>Web server fingerprint </a></li>
|
||||
<li><a href='/docs/frontend/browsers/'>Browser Compatibility List </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/backend/'>Backend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/backend/database/'>Database </a></li>
|
||||
<li><a href='/docs/backend/updater/'>Updater </a></li>
|
||||
<li><a href='/developers/api/'>API </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/scripts/'>Scripts </a>
|
||||
<ul>
|
||||
<li><a href='/docs/scripts/service-calls/'>Service Calls </a></li>
|
||||
<li><a href='/docs/scripts/conditions/'>Conditions </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/z-wave/'>Z-Wave </a>
|
||||
<ul>
|
||||
<li><a href='/docs/z-wave/controllers/'>Controllers </a></li>
|
||||
<li><a href='/docs/z-wave/settings/'>Modifying Settings </a></li>
|
||||
<li><a href='/docs/z-wave/device-specific/'>Device Specific </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/mqtt/'>MQTT </a>
|
||||
<ul>
|
||||
<li><a href='/docs/mqtt/broker/'>Broker </a></li>
|
||||
<li><a href='/docs/mqtt/certificate/'>Certificate </a></li>
|
||||
<li><a href='/docs/mqtt/discovery/'>Discovery </a></li>
|
||||
<li><a href='/docs/mqtt/service/'>Publish service </a></li>
|
||||
<li><a href='/docs/mqtt/birth_will/'>Birth and last will messages </a></li>
|
||||
<li><a href='/docs/mqtt/testing/'>Testing your setup </a></li>
|
||||
<li><a href='/docs/mqtt/logging/'>Logging </a></li>
|
||||
<li><a href='/docs/mqtt/processing_json/'>Processing JSON </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/'>Ecosystem </a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/autostart/'>Autostart </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/autostart/systemd/'>systemd (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/upstart/'>Upstart (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/init.d/'>init.d (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/macos/'>macOS </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/synology/'>Synology NAS </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/appdaemon/'>AppDaemon </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/appdaemon/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/configuration/'>Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/example_apps/'>Example Apps </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/running/'>Running AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/reboot/'>Starting AppDaemon at Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/operation/'>Operation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/windows/'>AppDaemon on Windows </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/updating/'>Updating AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/tutorial/'>AppDaemon Tutorial </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/api/'>AppDaemon API Reference </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/hadashboard/'>HADashboard </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/hadashboard/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/dash_config/'>Dashboard Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/hapush/'>HAPush </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/reboot/'>Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/updating/'>Updating HADashboard </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/notebooks/'>Notebooks </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/notebooks/'>Introduction </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/graph/'>Graph </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/api/'>Home Assistant API </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/database/'>Databsase </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/stats/'>Statistics </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/ios/notifications/'>iOS </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/basic/'>Basic notifications </a></li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/sounds/'>Sounds </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/architecture/'>Architecture </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/privacy_security_rate_limits/'>Privacy, rate limiting and security </a></li>
|
||||
</ul>
|
||||
<li>Advanced notifications</li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/attachments/'>Attachments </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/content_extensions/'>Dynamic content </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/actions/'>Actionable notifications </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/requesting_location_updates/'>Requesting location updates </a></li>
|
||||
</ul>
|
||||
<li><a href='/docs/ecosystem/ios/location/'>Location Tracking </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/integration/'>Integration with other apps </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</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>.<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>
|
||||
</body>
|
||||
</html>
|
||||
446
docs/installation/virtualenv/index.html
Normal file
446
docs/installation/virtualenv/index.html
Normal file
|
|
@ -0,0 +1,446 @@
|
|||
<!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>Installation in virtualenv - Home Assistant</title>
|
||||
<meta name="author" content="Home Assistant">
|
||||
<meta name="description" content="Instructions how to install Home Assistant in a virtual environment.">
|
||||
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<link rel="canonical" href="https://home-assistant.io/docs/installation/virtualenv/">
|
||||
|
||||
<meta property="fb:app_id" content="338291289691179">
|
||||
<meta property="og:title" content="Installation in virtualenv">
|
||||
<meta property="og:site_name" content="Home Assistant">
|
||||
<meta property="og:url" content="https://home-assistant.io/docs/installation/virtualenv/">
|
||||
<meta property="og:type" content="article">
|
||||
<meta property="og:description" content="Instructions how to install Home Assistant in a virtual environment.">
|
||||
<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="Installation in virtualenv">
|
||||
<meta name="twitter:description" content="Instructions how to install Home Assistant in a virtual environment.">
|
||||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||||
|
||||
<link href="/stylesheets/screen.css" media="screen, projection" 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>
|
||||
<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>
|
||||
</ul>
|
||||
</nav>
|
||||
</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">
|
||||
|
||||
|
||||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_docs/installation/virtualenv.markdown'>Edit this page on GitHub</a></div>
|
||||
|
||||
|
||||
|
||||
<header>
|
||||
<h1 class="title indent">
|
||||
Installation in Virtualenv
|
||||
</h1>
|
||||
</header>
|
||||
<hr class="divider">
|
||||
|
||||
|
||||
<p>There are several reasons why it makes sense to run Home Assistant in a virtual environment. A <a href="https://virtualenv.pypa.io/en/latest/">virtualenv</a> encapsulates all aspect of a Python environment within a single directory tree. That means the Python packages you install for Home Assistant won’t interact with the rest of your system and vice-versa. It means a random upgrade for some other program on your computer won’t break Home Assistant, and it means you don’t need to install Python packages as root.</p>
|
||||
|
||||
<p>Virtualenvs are pretty easy to setup. This example will walk through one method of setting one up (there are certainly others). We’ll be using Debian in this example (as many Home Assistant users are running Raspbian on a Raspberry Pi), but all of the Python related steps should be the same on just about any platform.</p>
|
||||
|
||||
<h3><a class="title-link" name="step-0-install-some-dependencies" href="#step-0-install-some-dependencies"></a> Step 0: Install some dependencies</h3>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo apt-get update
|
||||
<span class="gp">$ </span>sudo apt-get upgrade
|
||||
<span class="gp">$ </span>sudo apt-get install python-pip python3-dev
|
||||
<span class="gp">$ </span>sudo pip install --upgrade virtualenv
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h3><a class="title-link" name="step-1-create-a-home-assistant-user" href="#step-1-create-a-home-assistant-user"></a> Step 1: Create a Home Assistant user</h3>
|
||||
|
||||
<p>This step is optional, but it’s a good idea to give services like Home Assistant their own user. It gives you more granular control over permissions, and reduces the exposure to the rest of your system in the event there is a security related bug in Home Assistant. This is a reasonably Linux oriented step, and will look different on other operating systems (or even other Linux distributions).</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo adduser --system homeassistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Home Assistant stores its configuration in <code class="highlighter-rouge">$HOME/.homeassistant</code> by default, so in this case, it would be in <code class="highlighter-rouge">/home/homeassistant/.homeassistant</code></p>
|
||||
|
||||
<p>If you plan to use a Z-Wave controller, you will need to add this user to the <code class="highlighter-rouge">dialout</code> group</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo usermod -G dialout -a homeassistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h3><a class="title-link" name="step-2-create-a-directory-for-home-assistant" href="#step-2-create-a-directory-for-home-assistant"></a> Step 2: Create a directory for Home Assistant</h3>
|
||||
|
||||
<p>This can be anywhere you want. As example we put it in <code class="highlighter-rouge">/srv</code>. You also need to change the ownership of the directory to the user you created above (if you created one).</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo mkdir /srv/homeassistant
|
||||
<span class="gp">$ </span>sudo chown homeassistant:homeassistant /srv/homeassistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h3><a class="title-link" name="step-3-become-the-new-user" href="#step-3-become-the-new-user"></a> Step 3: Become the new user</h3>
|
||||
|
||||
<p>This is obviously only necessary if you created a <code class="highlighter-rouge">homeassistant</code> user, but if you did, be sure to switch to that user whenever you install things in your virtualenv, otherwise you’ll end up with mucked up permissions.</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo su -s /bin/bash homeassistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>The <code class="highlighter-rouge">su</code> command means ‘switch’ user. We use the ‘-s’ flag because the <code class="highlighter-rouge">homeassistant</code> user is a system user and doesn’t have a default shell by default (to prevent attackers from being able to log in as that user).</p>
|
||||
|
||||
<h3><a class="title-link" name="step-4-set-up-the-virtualenv" href="#step-4-set-up-the-virtualenv"></a> Step 4: Set up the virtualenv</h3>
|
||||
|
||||
<p>All this step does is stick a Python environment in the directory we’re using. That’s it. It’s just a directory. There’s nothing special about it, and it is entirely self-contained.</p>
|
||||
|
||||
<p>It will include a <code class="highlighter-rouge">bin</code> directory, which will contain all the executables used in the virtualenv (including hass itself). It also includes a script called <code class="highlighter-rouge">activate</code> which we will use to activate the virtualenv.</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>virtualenv -p python3 /srv/homeassistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<h3><a class="title-link" name="step-5-activate-the-virtualenv" href="#step-5-activate-the-virtualenv"></a> Step 5: Activate the virtualenv</h3>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span><span class="nb">source</span> /srv/homeassistant/bin/activate
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>After that, your prompt should include <code class="highlighter-rouge">(homeassistant)</code>.</p>
|
||||
|
||||
<h3><a class="title-link" name="step-6-install-home-assistant" href="#step-6-install-home-assistant"></a> Step 6: Install Home Assistant</h3>
|
||||
|
||||
<p>Once your virtualenv has been activated, you don’t need to <code class="highlighter-rouge">sudo</code> any of your <code class="highlighter-rouge">pip</code> commands. <code class="highlighter-rouge">pip</code> will be installing things in the virtualenv, which the <code class="highlighter-rouge">homeassistant</code> user has permission to modify.</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">(homeassistant)$ </span>pip3 install --upgrade homeassistant
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>And that’s it… you now have Home Assistant installed, and you can be sure that every bit of it is contained in <code class="highlighter-rouge">/srv/homeassistant</code>.</p>
|
||||
|
||||
<h3><a class="title-link" name="finally-run-home-assistant" href="#finally-run-home-assistant"></a> Finally… Run Home Assistant</h3>
|
||||
|
||||
<p>There are two ways to launch Home Assistant. If you are <strong>in</strong> the virtualenv, you can just run <code class="highlighter-rouge">hass</code> and it will work as normal. If the virtualenv is not activated, you just use the <code class="highlighter-rouge">hass</code> executable in the <code class="highlighter-rouge">bin</code> directory mentioned earlier. There is one caveat… Because Home Assistant stores its configuration in the user’s home directory, we need to be the user <code class="highlighter-rouge">homeassistant</code> user or specify the configuration with <code class="highlighter-rouge">-c</code>.</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo -u homeassistant -H /srv/homeassistant/bin/hass
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>The <code class="highlighter-rouge">-H</code> flag is important. It sets the <code class="highlighter-rouge">$HOME</code> environment variable to <code class="highlighter-rouge">/home/homeassistant</code> so <code class="highlighter-rouge">hass</code> can find its configuration.</p>
|
||||
|
||||
<h3><a class="title-link" name="upgrading-home-assistant" href="#upgrading-home-assistant"></a> Upgrading Home Assistant</h3>
|
||||
|
||||
<p>Upgrading Home Assistant is simple, just repeat steps 3, 5 and 6.</p>
|
||||
|
||||
<h3><a class="title-link" name="starting-home-assistant-on-boot" href="#starting-home-assistant-on-boot"></a> Starting Home Assistant on boot</h3>
|
||||
|
||||
<p>The <a href="/getting-started/autostart/">autostart instructions</a> will work just fine, just be sure to replace <code class="highlighter-rouge">/usr/bin/hass</code> with <code class="highlighter-rouge">/srv/homeassistant/bin/hass</code> and specify the <code class="highlighter-rouge">homeassistant</code> user where appropriate.</p>
|
||||
|
||||
<h3><a class="title-link" name="installing-python-openzwave-in-a-virtualenv" href="#installing-python-openzwave-in-a-virtualenv"></a> Installing python-openzwave in a virtualenv</h3>
|
||||
|
||||
<p>If you want to use Z-Wave devices, you will need to install <code class="highlighter-rouge">python-openzwave</code> in your virtualenv. This requires a small tweak to the instructions in <a href="/getting-started/z-wave/">the Z-Wave Getting Started documentation</a></p>
|
||||
|
||||
<p>Install the dependencies as normal (Note: you will need to do this as your normal user, since <code class="highlighter-rouge">homeassistant</code> isn’t a sudoer).</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>sudo apt-get install cython3 libudev-dev python3-sphinx python3-setuptools git
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Then, activate your virtualenv (steps 3 and 5 above) and upgrade cython.</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">(homeassistant)$ </span>pip3 install --upgrade <span class="nv">cython</span><span class="o">==</span>0.24.1
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
<p>Finally, get and install <code class="highlighter-rouge">python-openzwave</code>.</p>
|
||||
|
||||
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">(homeassistant)$ </span>mkdir /srv/homeassistant/src
|
||||
<span class="gp">(homeassistant)$ </span><span class="nb">cd</span> /srv/homeassistant/src
|
||||
<span class="gp">(homeassistant)$ </span>git clone https://github.com/OpenZWave/python-openzwave.git
|
||||
<span class="gp">(homeassistant)$ </span><span class="nb">cd </span>python-openzwave
|
||||
<span class="gp">(homeassistant)$ </span>git checkout python3
|
||||
<span class="gp">(homeassistant)$ </span><span class="nv">PYTHON_EXEC</span><span class="o">=</span><span class="sb">`</span>which python3<span class="sb">`</span> make build
|
||||
<span class="gp">(homeassistant)$ </span><span class="nv">PYTHON_EXEC</span><span class="o">=</span><span class="sb">`</span>which python3<span class="sb">`</span> make install
|
||||
</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
</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='section'>
|
||||
<h1 class="title delta">Topics</h1>
|
||||
<ul class='divided sidebar-menu'>
|
||||
<li>
|
||||
<a href='/docs/installation/'>Installation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/installation/python/'>Python </a></li>
|
||||
<li><a class='active' href='/docs/installation/virtualenv/'>Python Virtual Env </a></li>
|
||||
<li><a href='/docs/installation/docker/'>Docker </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi/'>Raspberry Pi </a></li>
|
||||
<li><a href='/docs/installation/raspberry-pi-all-in-one/'>Raspberrry Pi All-in-One </a></li>
|
||||
<li><a href='/docs/installation/vagrant/'>Vagrant </a></li>
|
||||
<li><a href='/docs/installation/synology/'>Synology </a></li>
|
||||
<li><a href='/docs/installation/updating/'>Updating </a></li>
|
||||
<li><a href='/docs/installation/troubleshooting/'>Troubleshooting </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/hassbian/'>Hassbian </a>
|
||||
<ul>
|
||||
<li><a href='/docs/hassbian/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/hassbian/customization/'>Customization </a></li>
|
||||
<li><a href='/docs/hassbian/common-tasks/'>Common tasks </a></li>
|
||||
<li><a href='/docs/hassbian/integrations/'>Integrations </a></li>
|
||||
<li><a href='/docs/hassbian/upgrading/'>Upgrading </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/configuration/'>Configuration </a>
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/yaml/'>YAML </a></li>
|
||||
<li><a href='/docs/configuration/basic/'>Basic information </a></li>
|
||||
<li><a href='/docs/configuration/devices/'>Setting up devices </a></li>
|
||||
<li><a href='/docs/configuration/customizing-devices/'>Customizing devices and services </a></li>
|
||||
<li><a href='/docs/configuration/presence-detection/'>Presence Detection </a></li>
|
||||
<li><a href='/docs/configuration/troubleshooting/'>Troubleshooting </a></li>
|
||||
<li><a href='/docs/configuration/securing/'>Security Check Points </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Advanced Configuration
|
||||
<ul>
|
||||
<li><a href='/docs/configuration/remote/'>Remote access </a></li>
|
||||
<li><a href='/docs/configuration/packages/'>Packages </a></li>
|
||||
<li><a href='/docs/configuration/splitting_configuration/'>Splitting up the configuration </a></li>
|
||||
<li><a href='/docs/configuration/secrets/'>Storing Secrets </a></li>
|
||||
<li><a href='/docs/configuration/templating/'>Templating </a></li>
|
||||
<li><a href='/docs/configuration/group_visibility/'>Group Visibility </a></li>
|
||||
<li><a href='/docs/configuration/events/'>Events </a></li>
|
||||
<li><a href='/docs/configuration/state_object/'>State Objects </a></li>
|
||||
<li><a href='/docs/configuration/platform_options/'>Entity component platform options </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/automation/'>Automation </a>
|
||||
<ul>
|
||||
<li><a href='/docs/automation/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/automation/trigger/'>Triggers </a></li>
|
||||
<li><a href='/docs/automation/condition/'>Conditions </a></li>
|
||||
<li><a href='/docs/automation/action/'>Actions </a></li>
|
||||
<li><a href='/docs/automation/templating/'>Templates </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/frontend/'>Frontend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/frontend/mobile/'>Android/iOS Homescreen </a></li>
|
||||
<li><a href='/docs/frontend/webserver/'>Web server fingerprint </a></li>
|
||||
<li><a href='/docs/frontend/browsers/'>Browser Compatibility List </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/backend/'>Backend </a>
|
||||
<ul>
|
||||
<li><a href='/docs/backend/database/'>Database </a></li>
|
||||
<li><a href='/docs/backend/updater/'>Updater </a></li>
|
||||
<li><a href='/developers/api/'>API </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/scripts/'>Scripts </a>
|
||||
<ul>
|
||||
<li><a href='/docs/scripts/service-calls/'>Service Calls </a></li>
|
||||
<li><a href='/docs/scripts/conditions/'>Conditions </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/z-wave/'>Z-Wave </a>
|
||||
<ul>
|
||||
<li><a href='/docs/z-wave/controllers/'>Controllers </a></li>
|
||||
<li><a href='/docs/z-wave/settings/'>Modifying Settings </a></li>
|
||||
<li><a href='/docs/z-wave/device-specific/'>Device Specific </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/mqtt/'>MQTT </a>
|
||||
<ul>
|
||||
<li><a href='/docs/mqtt/broker/'>Broker </a></li>
|
||||
<li><a href='/docs/mqtt/certificate/'>Certificate </a></li>
|
||||
<li><a href='/docs/mqtt/discovery/'>Discovery </a></li>
|
||||
<li><a href='/docs/mqtt/service/'>Publish service </a></li>
|
||||
<li><a href='/docs/mqtt/birth_will/'>Birth and last will messages </a></li>
|
||||
<li><a href='/docs/mqtt/testing/'>Testing your setup </a></li>
|
||||
<li><a href='/docs/mqtt/logging/'>Logging </a></li>
|
||||
<li><a href='/docs/mqtt/processing_json/'>Processing JSON </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/'>Ecosystem </a>
|
||||
<ul>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/autostart/'>Autostart </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/autostart/systemd/'>systemd (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/upstart/'>Upstart (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/init.d/'>init.d (Linux) </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/macos/'>macOS </a></li>
|
||||
<li><a href='/docs/ecosystem/autostart/synology/'>Synology NAS </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/appdaemon/'>AppDaemon </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/appdaemon/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/configuration/'>Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/example_apps/'>Example Apps </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/running/'>Running AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/reboot/'>Starting AppDaemon at Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/operation/'>Operation </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/windows/'>AppDaemon on Windows </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/updating/'>Updating AppDaemon </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/tutorial/'>AppDaemon Tutorial </a></li>
|
||||
<li><a href='/docs/ecosystem/appdaemon/api/'>AppDaemon API Reference </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/hadashboard/'>HADashboard </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/hadashboard/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/dash_config/'>Dashboard Configuration </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/hapush/'>HAPush </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/reboot/'>Reboot </a></li>
|
||||
<li><a href='/docs/ecosystem/hadashboard/updating/'>Updating HADashboard </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/notebooks/'>Notebooks </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/notebooks/'>Introduction </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/installation/'>Installation </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/graph/'>Graph </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/api/'>Home Assistant API </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/database/'>Databsase </a></li>
|
||||
<li><a href='/docs/ecosystem/notebooks/stats/'>Statistics </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<a href='/docs/ecosystem/ios/notifications/'>iOS </a>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/basic/'>Basic notifications </a></li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/examples/'>Examples </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/sounds/'>Sounds </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/architecture/'>Architecture </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/privacy_security_rate_limits/'>Privacy, rate limiting and security </a></li>
|
||||
</ul>
|
||||
<li>Advanced notifications</li>
|
||||
<ul>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/attachments/'>Attachments </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/content_extensions/'>Dynamic content </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/actions/'>Actionable notifications </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/notifications/requesting_location_updates/'>Requesting location updates </a></li>
|
||||
</ul>
|
||||
<li><a href='/docs/ecosystem/ios/location/'>Location Tracking </a></li>
|
||||
<li><a href='/docs/ecosystem/ios/integration/'>Integration with other apps </a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</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>.<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>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue