Supported Database Types
==========================

SunPeek supports **SQLite** and **PostgreSQL** as backend databases
for storing plant configurations, collector and fluid types etc.


SQLite
-----------
For single host installs with small number of plants, SQLite should be sufficient
and this is therefore the default configuration.


PostgreSQL
------------
To use the PostgreSQL backend you can adapt the *env* files in your configuration.

In the `api.env` and `db.env` files, please add `HIT_DB_TYPE=postgresql`
and set the `HIT_DB_PW` and `POSTGRES_PASSWORD` variables to *the same* random, unique password string.

.. code-block:: console

    HIT_DB_TYPE=postgresql
    HIT_DB_PW=<PASSWORD>
    POSTGRES_PASSWORD=<PASSWORD>

The docker compose setup includes an optional postgres service,
which can be started along with the other containers with `docker compose --profile postgres up`