jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Another reorganization of the Getting Started page.

Browse Source
This commit is contained in:
Ryan Kraus 2015-09-02 23:32:50 -04:00
parent 4dea071ff8
commit 46c68f411b
3 changed files with 69 additions and 129 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
sass/custom/_paulus.scss
View File

@ -180,17 +180,17 @@ p.note {
} }
.post-instructions-container { .install-instructions-container {
#generic-post, #fedora-post, #debian-post, .post-instructions { #normal-install, #raspberry-install, #docker-install, .install-instructions {
display: none; display: none;
} }
label.menu-selector { label.menu-selector {
display: inline-block; display: inline-block;
text-align: center; text-align: center;
padding: 10px; padding: 20px;
white-space: nowrap; white-space: nowrap;
border-bottom: 2px solid $grayLight; border-bottom: 5px solid $grayLight;
transition: border-bottom-color .5s; transition: border-bottom-color .5s;
} }
@ -198,65 +198,27 @@ p.note {
margin-left: 10px; margin-left: 10px;
} }
#generic-post:checked ~ .menu-selector.generic-post, #normal-install:checked ~ .menu-selector.normal,
#fedora-post:checked ~ .menu-selector.fedora-post, #raspberry-install:checked ~ .menu-selector.raspberry,
#debian-post:checked ~ .menu-selector.debian-post #docker-install:checked ~ .menu-selector.docker
{ {
border-bottom-color: $blue; border-bottom-color: $blue;
} }
#generic-post:checked ~ .post-instructions.generic-post, #normal-install:checked ~ .install-instructions.normal,
#fedora-post:checked ~ .post-instructions.fedora-post, #raspberry-install:checked ~ .install-instructions.raspberry,
#debian-post:checked ~ .post-instructions.debian-post #docker-install:checked ~ .install-instructions.docker
{ {
display: block; display: block;
} }
.post-instructions { .install-instructions {
margin-top: 20px; margin-top: 30px;
}
}
.install-channels-container {
#prod-channel, #beta-channel, #dev-channel, .install-channels {
display: none;
}
label.menu-selector {
display: inline-block;
text-align: center;
padding: 10px;
white-space: nowrap;
border-bottom: 2px solid $grayLight;
transition: border-bottom-color .5s;
}
label.menu-selector + label.menu-selector {
margin-left: 10px;
}
#prod-channel:checked ~ .menu-selector.prodchan,
#beta-channel:checked ~ .menu-selector.betachan,
#dev-channel:checked ~ .menu-selector.devchan
{
border-bottom-color: $blue;
}
#prod-channel:checked ~ .install-channels.prodchan,
#beta-channel:checked ~ .install-channels.betachan,
#dev-channel:checked ~ .install-channels.devchan
{
display: block;
}
.install-channels {
margin-top: 20px;
} }
} }
.advanced-installs-container { .advanced-installs-container {
#docker-install, #debian-install, #fedora-install, .advanced-installs { #debian-install, #fedora-install, .advanced-installs {
display: none; display: none;
} }
@ -273,14 +235,12 @@ p.note {
margin-left: 10px; margin-left: 10px;
} }
#docker-install:checked ~ .menu-selector.docker,
#debian-install:checked ~ .menu-selector.debian, #debian-install:checked ~ .menu-selector.debian,
#fedora-install:checked ~ .menu-selector.fedora #fedora-install:checked ~ .menu-selector.fedora
{ {
border-bottom-color: $blue; border-bottom-color: $blue;
} }
#docker-install:checked ~ .advanced-installs.docker,
#debian-install:checked ~ .advanced-installs.debian, #debian-install:checked ~ .advanced-installs.debian,
#fedora-install:checked ~ .advanced-installs.fedora #fedora-install:checked ~ .advanced-installs.fedora
{ {

19
source/getting-started/advanced.markdown
View File

@ -12,28 +12,11 @@ footer: true
Here are some general tutorials on how to setup some of the more advanced deployments that are frequently requested. Here are some general tutorials on how to setup some of the more advanced deployments that are frequently requested.
<div class='advanced-installs-container'> <div class='advanced-installs-container'>
<input name='advanced-installs' type='radio' id='docker-install' checked> <input name='advanced-installs' type='radio' id='debian-install' checked>
<input name='advanced-installs' type='radio' id='debian-install'>
<input name='advanced-installs' type='radio' id='fedora-install'> <input name='advanced-installs' type='radio' id='fedora-install'>
<label class='menu-selector docker' for='docker-install'>Docker Installation</label>
<label class='menu-selector debian' for='debian-install'>Debian (Ubuntu, Raspbian) Daemon</label> <label class='menu-selector debian' for='debian-install'>Debian (Ubuntu, Raspbian) Daemon</label>
<label class='menu-selector fedora' for='fedora-install'>Fedora (RHEL, CentOS) Daemon</label> <label class='menu-selector fedora' for='fedora-install'>Fedora (RHEL, CentOS) Daemon</label>
<div class='advanced-installs docker'>
**Docker Deployment**
<p>Installation with Docker is straightforward. Adjust the following command so that <code>/path/to/your/config/</code> points at the folder where you want to store your config and run it:</p>
```bash
docker run -d --name="home-assistant" -v /path/to/your/config:/config -v /etc/localtime:/etc/localtime:ro --net=host balloob/home-assistant
```
<p>This will launch Home Assistant and serve its web interface from port 8123 on your Docker host.</p>
<p class='note'>
When using boot2docker on OS X you are unable to map the local time to your Docker container. Replace <code>-v /etc/localtime:/etc/localtime:ro</code> with <code>-e "TZ=America/Los_Angeles"</code> (replacing America/Los_Angeles with <a href='http://en.wikipedia.org/wiki/List_of_tz_database_time_zones'>your timezone</a>)
</p>
</div> <!-- DOCKER -->
<div class='advanced-installs debian'> <div class='advanced-installs debian'>
**Debian Deamon** **Debian Deamon**
<p>Debian based systems, including Ubuntu and Raspbian for the Raspberry Pi use an application called Init to manage daemon services. Init will launch init scripts that are located in the directory <code>/etc/init.d/</code>. A sample init script for Debian based systems is <a href="https://raw.githubusercontent.com/balloob/home-assistant/dev/scripts/hass-daemon">maintained in this project</a>.</p> <p>Debian based systems, including Ubuntu and Raspbian for the Raspberry Pi use an application called Init to manage daemon services. Init will launch init scripts that are located in the directory <code>/etc/init.d/</code>. A sample init script for Debian based systems is <a href="https://raw.githubusercontent.com/balloob/home-assistant/dev/scripts/hass-daemon">maintained in this project</a>.</p>

113
source/getting-started/index.markdown
View File

@ -9,79 +9,67 @@ sharing: true
footer: true footer: true
--- ---
<h3>Requirements</h3> <div class='install-instructions-container'>
<p>Home Assistant requires at least <a href="https://www.python.org/downloads/" target="_blank">Python 3.4</a>. For the Raspberry Pi, install instructions can be found <a href="http://depado.markdownblog.com/2015-03-12-short-tutorial-raspbian-python3-4-rpi-gpio" target="_blank">here</a>. Other systems generally have this bundled or contain easy to install packages.</p> <input name='install-instructions' type='radio' id='normal-install' checked>
<input name='install-instructions' type='radio' id='raspberry-install'>
<p>To ensure Python 3.4 is installed, type the following command into the console:</p> <input name='install-instructions' type='radio' id='docker-install'>
<label class='menu-selector normal' for='normal-install'>Install on local machine</label>
```bash <label class='menu-selector raspberry' for='raspberry-install'>Install on a Raspberry Pi</label>
python3 --version <label class='menu-selector docker' for='docker-install'>Install using Docker</label>
```
<h3>Installation</h3> <h3>Installation</h3>
<div class='install-channels-container'>
<input name='install-channels' type='radio' id='prod-channel' checked>
<input name='install-channels' type='radio' id='beta-channel'>
<input name='install-channels' type='radio' id='dev-channel'>
<label class='menu-selector prodchan' for='prod-channel'>Production Channel</label>
<label class='menu-selector betachan' for='beta-channel'>Beta Channel</label>
<label class='menu-selector devchan' for='dev-channel'>Development Channel</label>
<div class='install-channels prodchan'>
<p>Installing from the production channel is fast, easy, and will provide you with access to the newest stable builds. This is recommended for most users. To install, execute the following code in a console:</p> <div class='install-instructions normal'>
Installing and running Home Assistant on your local machine is easy. Make sure you have <a href='https://www.python.org/downloads/' target="_blank">Python 3.4</a> installed and execute the following code in a console:
<p>
```bash ```bash
pip3 install homeassistant pip3 install homeassistant
hass --open-ui hass --open-ui
``` ```
<p>Running these commands will: </p>
<p>Running these commands will:</p>
<ol> <ol>
<li>Install Home Assistant</li> <li>Install Home Assistant</li>
<li>Launch Home Assistant and serve web interface on <a href='http://localhost:8123'>http://localhost:8123</a></li> <li>Launch Home Assistant and serve web interface on <a href='http://localhost:8123' target="_blank">http://localhost:8123</a></li>
</ol></p> </ol>
<p>When new stable versions are released, you can upgrade to newest version by typing the following into a console:</p> </div> <!-- INSTALL-INSTRUCTIONS NORMAL -->
```bash
pip3 install --upgrade homeassistant
``` <div class='install-instructions docker'>
</div> <p>Installation with Docker is straightforward. Adjust the following command so that <code>/path/to/your/config/</code> points at the folder where you want to store your config and run it:</p>
<div class='install-channels betachan'>
<p>The beta channel will provide you with newer features sooner but at the risk of reduced stability. The brave and curious are welcomed here. To install, execute the following code in a console:</p>
```bash ```bash
pip3 install --pre homeassistant docker run -d --name="home-assistant" -v /path/to/your/config:/config -v /etc/localtime:/etc/localtime:ro --net=host balloob/home-assistant
```
<p>This will launch Home Assistant and serve its web interface from port 8123 on your Docker host.</p>
<p class='note'>
When using boot2docker on OS X you are unable to map the local time to your Docker container. Replace <code>-v /etc/localtime:/etc/localtime:ro</code> with <code>-e "TZ=America/Los_Angeles"</code> (replacing America/Los_Angeles with <a href='http://en.wikipedia.org/wiki/List_of_tz_database_time_zones' target="_blank">your timezone</a>)
</p>
</div> <!-- INSTALL-INSTRUCTIONS DOCKER -->
<div class='install-instructions raspberry'>
<p>Home Assistant uses Python 3.4 which is not shipped with the current Raspbian distibution for the Raspberry Pi. Before installing Home Assistant, you will have to <a href="http://depado.markdownblog.com/2015-03-12-short-tutorial-raspbian-python3-4-rpi-gpio"> target="_blank"install Python 3.4</a>.
Once that is complete, installing and running Home Assistant on your local machine is easy. Make sure you have <a href='https://www.python.org/downloads/' target="_blank">Python 3.4</a> installed and execute the following code in a console:
<p>
```bash
pip3 install homeassistant
hass --open-ui hass --open-ui
``` ```
<p>Running these commands will: </p>
<p>Running these commands will:</p>
<ol> <ol>
<li>Install Home Assistant</li> <li>Install Home Assistant</li>
<li>Launch Home Assistant and serve web interface on <a href='http://localhost:8123'>http://localhost:8123</a></li> <li>Launch Home Assistant and serve web interface on <a href='http://localhost:8123' target="_blank">http://localhost:8123</a></li>
</ol></p> </ol>
<p>When new a new release candidate, alpha, or beta version is released, you can upgrade to newest version by typing the following into a console:</p> </div> <!-- INSTALL-INSTRUCTIONS RASPBERRY -->
```bash
pip3 install --pre --upgrade homeassistant
```
</div>
<div class='install-channels devchan'>
<p>The development channel provides builds that are on the bleeding edge. This builds have not been fully tested or used. This is best for potential contributors and tinkerers. Subscribing to this channel is not for the faint of heart and requires significant knowledge of Git and Python.</p>
```bash
# Clone repo from git, you may want to use your own fork
git clone --recursive https://github.com/balloob/home-assistant.git
cd home-assistant
# You may want to switch to a virtual environment here
# Install Home Assistant in development mode
python3 setup.py develop
# Optionally pre-emptively install all possible dependencies
pip3 install -r requirements_all.txt
```
<p>To keep up-to-date with the development channel, you will have to fetch and merge from the dev branch in the head repository. Be careful when doing this.</p>
```bash
git fetch balloob
git merge remotes/balloob/dev
```
</div>
</div><!-- install-channels-container -->
<h3>Troubleshooting</h3> <h3>Troubleshooting</h3>
@ -96,10 +84,19 @@ git merge remotes/balloob/dev
</ul> </ul>
</p> </p>
<h3>Staying Up to Date</h3>
<p>In order to update Home Assistant to the latest stable release, simply type the following into a console:</p>
```bash
pip install --upgrade homeassistant
```
<p>If you would like to stay up to date with the newest unstable builds (alphas, betas, and release candidates), use this command:</p>
```bash
pip install --upgrade --pre homeassistant
```
<h3>What's Next</h3> <h3>What's Next</h3>
<p>If you want to see what Home Assistant can do, you can start the demo mode by running <code>hass --demo-mode</code>. Home Assistant has a few other command line flags that can be displayed by running <code>hass --help</code>.</p> <p>If you want to see what Home Assistant can do, you can start the demo mode by running <code>hass --demo-mode</code>. Home Assistant has a few other command line flags that can be displayed by running <code>hass --help</code>.</p>
<p>From here you may now start configuring Home Assistant to your liking. For more advanced users, the <a href='{{site_root}}/getting-started/advanced.html'>advanced configuration page</a> contains brief tutorials on creating more advanced installations such as installing daemons and using Docker.</p> <p>From here you may now start configuring Home Assistant to your liking. For more advanced users, the <a href='{{site_root}}/getting-started/advanced.html'>advanced configuration page</a> contains brief tutorials on creating more advanced installations.</p>
###[Next step: configuring Home Assistant &raquo;](/getting-started/configuration.html) ###[Next step: configuring Home Assistant &raquo;](/getting-started/configuration.html)