[Install] Refresh Venv guide #3931
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I'd be in favour of using the same location for the virtual environment as is used for Hassbian. Doing that makes it easier to help people regardless of how they've installed it. |
fabaff
reviewed
Nov 8, 2017
| date: 2016-4-16 16:40 | ||
| sidebar: true | ||
| comments: false | ||
| sharing: true | ||
| footer: true | ||
| redirect_from: /getting-started/installation-virtualenv/ | ||
| --- | ||
| <p class='note'> | ||
| Note: Beginners should check our [Getting started guide](/getting-started/) first. This is for users that require a flexible installation or want to run Home Assistant on any platform. |
There was a problem hiding this comment.
Remove Note:. Again, platform...no no differentiation about hardware or software. Better leave it out. The note addresses the beginner and shouldn't confuse them.
fabaff
reviewed
Nov 8, 2017
| @@ -1,20 +1,27 @@ | |||
| --- | |||
| layout: page | |||
| title: "Installation in virtualenv" | |||
| description: "Instructions how to install Home Assistant in a virtual environment." | |||
| title: "Installation: Python virtual envenvironment" | |||
There was a problem hiding this comment.
What's the advantage of starting to prefix the title with the section where the doc is located?
Also, there is a typo in envenvironment.
fabaff
reviewed
Nov 8, 2017
| ```bash | ||
| $ cd $HOME | ||
| $ mkdir homeassistant | ||
| $ virtualenv -p python3 homeassistant |
There was a problem hiding this comment.
I would prefer $ python3 -m venv homeassistant. As this is the same way it's described in the official Python documentation.
fabaff
reviewed
Nov 8, 2017
| date: 2016-4-16 16:40 | ||
| sidebar: true | ||
| comments: false | ||
| sharing: true | ||
| footer: true | ||
| redirect_from: /getting-started/installation-virtualenv/ | ||
| --- | ||
| <p class='note'> | ||
| Note: Beginners should check our [Getting started guide](/getting-started/) first. This is for users that require a flexible installation or want to run Home Assistant on any platform. | ||
| <p class='note'> |
There was a problem hiding this comment.
That's will lead to invalid HTML after rendering if the checks fail.
|
|
||
| ```bash | ||
| $ sudo adduser --system homeassistant | ||
| $ sudo addgroup homeassistant | ||
| ``` | ||
|
|
||
| Home Assistant stores its configuration in `$HOME/.homeassistant` by default, so in this case, it would be in `/home/homeassistant/.homeassistant` | ||
| Home Assistant stores it's configuration in `$HOME/.homeassistant` by default, so in this case, it would be in `/home/homeassistant/.homeassistant`. |
There was a problem hiding this comment.
It should be its. Here it should be a possessive pronoun.
There was a problem hiding this comment.
😢 thanks... I should refresh my english
| ### {% linkable_title Finally... Run Home Assistant %} | ||
|
|
||
| There are two ways to launch Home Assistant. If you are **in** the virtualenv, you can just run `hass` and it will work as normal. If the virtualenv is not activated, you just use the `hass` executable in the `bin` 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 `homeassistant` user or specify the configuration with `-c`. | ||
| There are two ways to launch Home Assistant. If you are **in** the virtualenv, you can just run `hass` and it will work as normal. If the virtualenv is not activated, you just use the `hass` executable in the `bin` directory mentioned earlier. There is one caveat... Because Home Assistant stores it's configuration in the user's home directory, we need to be the user `homeassistant` user or specify the configuration with `-c`. |
There was a problem hiding this comment.
stores its configuration not stores it's configuration
| ### {% linkable_title Upgrading Home Assistant %} | ||
|
|
||
| Upgrading Home Assistant is simple, just repeat steps 3, 5 and 6. | ||
| The `-H` flag is important. It sets the `$HOME` environment variable to `/home/homeassistant` so `hass` can find it's configuration. |
| @@ -94,13 +94,13 @@ $ source /srv/homeassistant/bin/activate | |||
|
|
|||
| ## {% linkable_title Run Home Assistant (Basic guide step 4) %} | |||
|
|
|||
| There are two ways to launch Home Assistant. If you are **in** the virtualenv, you can just run `hass` and it will work as normal. If the virtualenv is not activated, you just use the `hass` executable in the `bin` directory mentioned earlier. There is one caveat... Because Home Assistant stores it's configuration in the user's home directory, we need to be the user `homeassistant` user or specify the configuration with `-c`. | |||
| There are two ways to launch Home Assistant. If you are **in** the virtualenv, you can just run `hass` and it will work as normal. If the virtualenv is not activated, you just use the `hass` executable in the `bin` 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 `homeassistant` user or specify the configuration with `-c`. | |||
There was a problem hiding this comment.
There's an extra user before homeassistant.
| ### {% linkable_title Step 0: Install some dependencies %} | ||
| ### {% linkable_title Basic guide %} | ||
|
|
||
| The basic guide is for testing Home Assistant. Also check the advanced guide below for productional instances. |
There was a problem hiding this comment.
"...for instances used in production."
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#3929