search

home-assistant / architecture

Repo to discuss Home Assistant architecture
315 stars 99 forks source link

ADR-16: Home Assistant Core installation method #407

Closed balloob closed 4 years ago

balloob commented 4 years ago

And finally, the last one :)

Initially I was planning on redirecting users that want to try this installation method to the developer documentation. However, the dev docs talk about cloning the repository versus HA Core which is installed from PyPI. Therefore I have removed that clause.

CoMPaTech commented 4 years ago

Just as a thought, like the 'security patching of the os' maybe exclude handling of AppArmor/SElinux, ufw/firewalld and the like? So you'll heads-up the potential user on that as well?

balloob commented 4 years ago

@CoMPaTech I think that bring your own OS should be clear enough that the user is responsible for everything.

frenck commented 4 years ago

I think we need to add a section on what is going to be documented. Obviously we need installation guides (which is in the current ADR).

But do we want to impose a limit on things like documenting dependencies and such?

As for our current documentation, it is riddled with exceptions on additional packages/dependencies to install and a-like. Considering the experience level set, is that really needed? Imho it confuses a lot in the docs. And was one of the main reasons we initially wanted it to move to the dev docs.

DubhAd commented 4 years ago

I think we need to add a section on what is going to be documented. Obviously we need installation guides (which is in the current ADR).

But do we want to impose a limit on things like documenting dependencies and such?

I think we should document depedencies, but it should be clearly tagged as only applying to the Core install, and probably at the end of the page. I don't think it needs to be detailed, though it would help. As a minimum, for stream for example:

Core install dependencies

Users of the core install method will need to install FFmpeg 4.0 or later. Other install methods include all required dependencies already.

or for the bluetooth_tracker:

Core install dependencies

Users of the core install method will need to install Bluetooth development libraries for their operating system, to enable pybluez to be installed. Other install methods include all required dependencies already.

That provides enough information that the user can identify what needs to be installed

balloob commented 4 years ago

Okidoki, what about this @DubhAd & @frenck ?