Installation
============


There is 3 main way to install OpenHEMS server. See chapters below, classed by dificulty. Once the server is installed, please see :doc:`configure` page to configure it.

Buy it
------

You can bye a pre-installed system on [OpenHEMS server on OpenHomeSystem](https://openhomesystem.com/product/openhems-server/).
Then plug theelectric power cable and the ethenet one. It should be available from local network on http://192.168.1.202:8123/ and http://192.168.1.202:8000/.

Install on Home-AssistantOS as add-on
-------------------------------------

This is the easiest way to install it manually. You need a installed Home-AssistantOS. On parameters menu, click on "Add-on store" (bottom right). On top right, click on parameters symbol (3 point button) and select "Store" to open a popup. In the field paste "https://github.com/abriotde/openhems-addon" aand click "Add" button. Close the popup and refresh the store page. You should see "OpenHEMS" in the list. Click on it and then install it.

Then you will need to configure it. See dedicated page :doc:`configure`. After configured, restart at least OpenHEMS add-on.

Install from docker
-------------------

This is a modern, quick and secure way to install it but it is not for people who want to developp it.

Prerequisites
~~~~~~~~~~~~~

* A Linux server

* Home-Assistant installed. You can [install](https://www.home-assistant.io/installation/linux) it as docker too. NB: We recommand to install it on the same server as OpenHEMS but it is not mandatory.


Configure
~~~~~~~~~

You need 3 parameters :

* $OPENHEMS_CONFIGPATH : A folder to store openhems.yaml configuration file.

* $OPENHEMS_LOGPATH : A folder to store logs.

* $MY_TIME_ZONE : find your time-zone

In $OPENHEMS_CONFIGPATH you will put openhems.yaml. This is the configuration file of OpenHEMS. 
This configuration is not critical to start OpenHEMS you can start the application and use its helper. But it's important to connect it to Home-Assistant to OpenHEMS. To do this, fill "api" section on openhems.yaml, refer you to chapter installation on :doc:`installation_from_scratch`.
You can find documentation for this on :doc:`configure` but there is an example on [repository](https://raw.githubusercontent.com/abriotde/openhems-sample/refs/heads/main/config/openhems.yaml) to help you. 

On a Linux server run :

Test
~~~~

.. code-block:: bash

 docker run -d \
 	--name openhems \
 	--privileged \
 	--restart=unless-stopped \
 	-v $OPENHEMS_CONFIGPATH:/app/config \
 	-v $OPENHEMS_LOGPATH:/log \
 	-v /data:/opt \
 	-e TZ=$MY_TIME_ZONE \
 	-p 8000:8000 \
 	ghcr.io/abriotde/openhems-sample:latest

Installation
~~~~~~~~~~~~

For a complete installation with an installation of docker and a persistant start of docker, see :doc:`installation_from_scratch` page and configure it to use docker.

Install from scratch
--------------------

This way is reserved to aknowledged people. See dedicated page :doc:`installation_from_scratch`.