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-21 00:06:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove OS specific mentions from virtualenv guide (#9786)

Browse Source 
* Remove OS specific mentions from virtualenv guide

* Tweaks for comments.

* Update virtualenv.markdown

* Tiny tweaks now we are here anyway
This commit is contained in:
Paulus Schoutsen 2019-07-05 15:57:55 -07:00 committed by Franck Nijhof
parent 1d0890d871
commit 8faccaaaad
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
source/_docs/installation/virtualenv.markdown
View File

@ -14,12 +14,15 @@ If you already have Python 3.6 or later installed (we suggest 3.7 or later), you
It's recommended when installing Python packages that you use a [virtual environment](https://docs.python.org/3.6/library/venv.html#module-venv). This will make sure that your Python installation and Home Assistant installation won't impact one another. The following steps will work on most UNIX like systems. It's recommended when installing Python packages that you use a [virtual environment](https://docs.python.org/3.6/library/venv.html#module-venv). This will make sure that your Python installation and Home Assistant installation won't impact one another. The following steps will work on most UNIX like systems.
_(If you're on a Debian based system, you will need to install Python virtual environment support using `apt-get install python3-pip python3-venv`. You may also need to install development libraries using `apt-get install build-essential libssl-dev libffi-dev python3-dev`.)_ <p class='note'>
This is a generic guide for running Home Assistant under Python. We recommend to use [our recommended installation guides](/docs/installation/#recommended). The steps below may be shorter but some users find difficulty when applying updates and may run into issues.
<p class='Note'>
It is recommended to use the [advanced guide](/docs/installation/raspberry-pi/) which allows for the installation to run as a `homeassistant` user. The steps below may be shorter but some users find difficulty when applying updates and may run into issues.
</p> </p>
{% comment %}
This page describes installation instructions for a pure Python installation.
It should not contain any OS specific instructions.
{% endcomment %}
### Install ### Install
1. Create a virtual environment in your current directory: 1. Create a virtual environment in your current directory:
@ -34,20 +37,15 @@ It is recommended to use the [advanced guide](/docs/installation/raspberry-pi/)
``` ```
$ source bin/activate $ source bin/activate
``` ```
4. Install wheel: 4. Install Home Assistant:
```
$ python3 -m pip install wheel
```
5. Install Home Assistant:
``` ```
$ python3 -m pip install homeassistant $ python3 -m pip install homeassistant
``` ```
6. Configure it to [autostart](/docs/autostart/) 5. Run Home Assistant:
7. Or run Home Assistant manually:
``` ```
$ hass --open-ui $ hass --open-ui
``` ```
8. You can now reach the web interface on `http://ipaddress:8123/` - the first start may take up to 20 minutes before the web interface is available 6. You can now reach the web interface on `http://ipaddress:8123/` - the first start may take a couple of minutes before the web interface is available. This can take longer if you're using lower-end hardware like a Raspberry Pi Zero.
### Upgrade ### Upgrade
@ -60,7 +58,7 @@ It is recommended to use the [advanced guide](/docs/installation/raspberry-pi/)
$ python3 -m pip install --upgrade homeassistant $ python3 -m pip install --upgrade homeassistant
``` ```
3. Start Home Assistant 3. Start Home Assistant
4. You can now reach the web interface on `http://ipaddress:8123/` - the first start may take up to 20 minutes before the web interface is available 4. You can now reach the web interface on `http://ipaddress:8123/` - the first start may take some time before the web interface is available, depending on how many integrations need to be upgraded.
### Run a specific version ### Run a specific version
@ -74,7 +72,7 @@ $ pip3 install homeassistant==0.XX.X
#### Run the beta version #### Run the beta version
If you would like to test next release before anyone else, you can install the beta version released every two weeks, for example: If you would like to test next release before anyone else, you can install the beta version, for example:
```bash ```bash
$ cd homeassistant $ cd homeassistant
@ -102,6 +100,7 @@ $ pip3 install --upgrade git+git://github.com/home-assistant/home-assistant.git@
- In the future, if you want to start Home Assistant manually again, follow step 2, 3 and 5. - In the future, if you want to start Home Assistant manually again, follow step 2, 3 and 5.
- It's recommended to run Home Assistant as a dedicated user. - It's recommended to run Home Assistant as a dedicated user.
- If you want Home Assistant to automatically start at boot, check the [autostart docs](/docs/autostart/)
<p class='info'> <p class='info'>
Looking for more advanced guides? Check our [Raspbian guide](/docs/installation/raspberry-pi/) or the [other installation guides](/docs/installation/). Looking for more advanced guides? Check our [Raspbian guide](/docs/installation/raspberry-pi/) or the [other installation guides](/docs/installation/).
@ -114,4 +113,5 @@ If you've upgraded Python (for example, you were running 3.7.1 and now you've in
```bash ```bash
$ mv homeassistant homeassistant.old $ mv homeassistant homeassistant.old
``` ```
Then follow the [Install](/docs/installation/virtualenv/#install) steps again, being sure to use the newly installed version of Python.
Then follow the [Install](#install) steps again, being sure to use the newly installed version of Python.