From 79af417b4f99330f101aa4789a4e1fa23ddd2ff4 Mon Sep 17 00:00:00 2001
From: Thomas Basler <thomas@familie-basler.net>
Date: Wed, 2 Oct 2024 21:02:01 +0200
Subject: [PATCH 01/13] homeassistant: Create empty role for further
 development

---
 roles/homeassistant/meta/main.yml  | 11 +++++++++++
 roles/homeassistant/tasks/main.yml |  1 +
 site.yml                           |  5 +++++
 3 files changed, 17 insertions(+)
 create mode 100644 roles/homeassistant/meta/main.yml
 create mode 100644 roles/homeassistant/tasks/main.yml

diff --git a/roles/homeassistant/meta/main.yml b/roles/homeassistant/meta/main.yml
new file mode 100644
index 0000000..eb29279
--- /dev/null
+++ b/roles/homeassistant/meta/main.yml
@@ -0,0 +1,11 @@
+---
+
+galaxy_info:
+  author: Thomas Basler
+  description: Install HomeAssistant environment
+  license: None
+  platforms:
+    - name: Debian
+  min_ansible_version: "2.4"
+
+dependencies: []
diff --git a/roles/homeassistant/tasks/main.yml b/roles/homeassistant/tasks/main.yml
new file mode 100644
index 0000000..ed97d53
--- /dev/null
+++ b/roles/homeassistant/tasks/main.yml
@@ -0,0 +1 @@
+---
diff --git a/site.yml b/site.yml
index fe1f123..25493a8 100644
--- a/site.yml
+++ b/site.yml
@@ -172,3 +172,8 @@
   hosts: barium.binary-kitchen.net
   roles:
   - workadventure
+
+- name: Setup HomeAssistant server
+  hosts: lasagne.binary.kitchen
+  roles:
+  - homeassistant
\ No newline at end of file
-- 
2.39.5


From 42538dc0190ffea5e74bd5adbec739bb1b7953f1 Mon Sep 17 00:00:00 2001
From: Thomas Basler <thomas@familie-basler.net>
Date: Wed, 2 Oct 2024 21:09:02 +0200
Subject: [PATCH 02/13] mosquitto: Add role to install and configure mosquitto

---
 roles/mosquitto/README.md                     |  4 ++
 roles/mosquitto/defaults/main.yml             | 46 +++++++++++++++++++
 .../filter_plugins/mosquitto_passwd.py        | 34 ++++++++++++++
 roles/mosquitto/handlers/main.yml             |  6 +++
 roles/mosquitto/meta/main.yml                 | 11 +++++
 roles/mosquitto/tasks/main.yml                | 35 ++++++++++++++
 roles/mosquitto/templates/acl.j2              | 28 +++++++++++
 roles/mosquitto/templates/mosquitto.conf.j2   | 36 +++++++++++++++
 roles/mosquitto/templates/users.j2            |  5 ++
 9 files changed, 205 insertions(+)
 create mode 100644 roles/mosquitto/README.md
 create mode 100644 roles/mosquitto/defaults/main.yml
 create mode 100644 roles/mosquitto/filter_plugins/mosquitto_passwd.py
 create mode 100644 roles/mosquitto/handlers/main.yml
 create mode 100644 roles/mosquitto/meta/main.yml
 create mode 100644 roles/mosquitto/tasks/main.yml
 create mode 100644 roles/mosquitto/templates/acl.j2
 create mode 100644 roles/mosquitto/templates/mosquitto.conf.j2
 create mode 100644 roles/mosquitto/templates/users.j2

diff --git a/roles/mosquitto/README.md b/roles/mosquitto/README.md
new file mode 100644
index 0000000..ce8e5a4
--- /dev/null
+++ b/roles/mosquitto/README.md
@@ -0,0 +1,4 @@
+Ansible Role: Mosquitto
+=========
+
+Install and configure [Mosquitto](https://mosquitto.org/) MQTT message broker.
diff --git a/roles/mosquitto/defaults/main.yml b/roles/mosquitto/defaults/main.yml
new file mode 100644
index 0000000..c833435
--- /dev/null
+++ b/roles/mosquitto/defaults/main.yml
@@ -0,0 +1,46 @@
+---
+
+mosquitto_packages:
+  - mosquitto
+  - mosquitto-clients
+
+mosquitto_listeners:
+  # Listeners for Mosquitto MQTT Broker
+  - name: "default"
+    listener: "1883 localhost"
+    protocol: "mqtt"
+    use_username_as_clientid: "true"
+    allow_zero_length_clientid: "true"
+    allow_anonymous: "false"
+    users: []
+      # Users for Mosquitto MQTT Broker
+      # Type: Arrays of Objects with following parameters defined:
+      #   - username: <string>
+      #     password: <string>
+      #     acl: <Array> of Objects as follows:
+      #       - permissions: <string> Acceptable Value: either `read`, `readwrite`, `write`, `deny`
+      #       - topic: <string> Acceptable Value: your/mqtt/topic (wildcards `+`, and `*` allowed)
+    auth_anonymous: []
+      # Topics which are accessable with anonymous access
+      # Example
+      #   - "topic read topic_name"
+    auth_patterns: []
+      # %c to match the client id of the client
+      # %u to match the username of the client
+      # Example
+      #  - "pattern write $SYS/broker/connection/%c/state"
+
+mosquitto_bridges: []
+  # Bridges for Mosquitto MQTT Broker
+  # Type: Arrays of Objects with following parameters defined:
+    #   - connection: <string>
+    #     address: <string>
+    #     bridge_insecure: <boolean>
+    #     bridge_capath: <string>
+    #     remote_password: <string>
+    #     remote_username: <string>
+    #     remote_clientid: <string>
+    #     try_private: <boolean>
+    #     topics:
+    #       - topic: # in 0 down/ to-level/02/line/
+    #       - topic: # out 0 up/ from-level/02/line/
diff --git a/roles/mosquitto/filter_plugins/mosquitto_passwd.py b/roles/mosquitto/filter_plugins/mosquitto_passwd.py
new file mode 100644
index 0000000..3b2b8aa
--- /dev/null
+++ b/roles/mosquitto/filter_plugins/mosquitto_passwd.py
@@ -0,0 +1,34 @@
+# mosquitto_passwd.py: Custom Jinja2 filter plugin to generate valid PBKDF2_SHA512
+#                      hash digests for plain-text passwords in `users` file for
+#                      Eclipse Mosquitto Broker
+
+
+from ansible.errors import AnsibleError
+
+
+def mosquitto_passwd(passwd):
+    try:
+        import passlib.hash
+    except Exception as e:
+        raise AnsibleError(
+            'mosquitto_passlib custom filter requires the passlib pip package installed')
+
+    SALT_SIZE = 12
+    ITERATIONS = 101
+    salt = passwd[:SALT_SIZE]
+    salt =  bytes(salt, 'utf-8')
+    salt += b"0" * (SALT_SIZE - len(salt))
+
+    digest = passlib.hash.pbkdf2_sha512.using(salt_size=SALT_SIZE, rounds=ITERATIONS, salt=salt) \
+        .hash(passwd) \
+        .replace("pbkdf2-sha512", "7") \
+        .replace(".", "+")
+
+    return digest + "=="
+
+
+class FilterModule(object):
+    def filters(self):
+        return {
+            'mosquitto_passwd': mosquitto_passwd,
+        }
diff --git a/roles/mosquitto/handlers/main.yml b/roles/mosquitto/handlers/main.yml
new file mode 100644
index 0000000..03a1edb
--- /dev/null
+++ b/roles/mosquitto/handlers/main.yml
@@ -0,0 +1,6 @@
+---
+
+- name: Restart Mosquitto
+  ansible.builtin.service:
+    name: mosquitto
+    state: restarted
diff --git a/roles/mosquitto/meta/main.yml b/roles/mosquitto/meta/main.yml
new file mode 100644
index 0000000..90e4265
--- /dev/null
+++ b/roles/mosquitto/meta/main.yml
@@ -0,0 +1,11 @@
+---
+
+galaxy_info:
+  author: Thomas Basler
+  description: Install Mosquitto
+  license: None
+  platforms:
+    - name: Debian
+  min_ansible_version: "2.4"
+
+dependencies: []
diff --git a/roles/mosquitto/tasks/main.yml b/roles/mosquitto/tasks/main.yml
new file mode 100644
index 0000000..822e560
--- /dev/null
+++ b/roles/mosquitto/tasks/main.yml
@@ -0,0 +1,35 @@
+---
+
+- name: Mosquitto | Install Mosquitto packages
+  ansible.builtin.apt:
+    name: "{{ item }}"
+    state: present
+  with_items: "{{ mosquitto_packages }}"
+  notify: Restart Mosquitto
+
+- name: Mosquitto | Generating Configuration File
+  ansible.builtin.template:
+    src: mosquitto.conf.j2
+    dest: /etc/mosquitto/conf.d/mosquitto.conf
+    mode: "0755"
+  notify: Restart Mosquitto
+
+- name: Mosquitto | Generating Authentication Users File
+  ansible.builtin.template:
+    src: users.j2
+    dest: "/etc/mosquitto/users_{{ item.name }}"
+    mode: "0755"
+  vars:
+    mosquitto_users: "{{ item.users }}"
+  with_items: "{{ mosquitto_listeners }}"
+  notify: Restart Mosquitto
+
+- name: Mosquitto | Generating Access Control List File
+  ansible.builtin.template:
+    src: acl.j2
+    dest: "/etc/mosquitto/acl_{{ item.name }}"
+    mode: "0755"
+  vars:
+    listener: "{{ item }}"
+  with_items: "{{ mosquitto_listeners }}"
+  notify: Restart Mosquitto
diff --git a/roles/mosquitto/templates/acl.j2 b/roles/mosquitto/templates/acl.j2
new file mode 100644
index 0000000..a6a9293
--- /dev/null
+++ b/roles/mosquitto/templates/acl.j2
@@ -0,0 +1,28 @@
+{{ ansible_managed | comment }}
+
+{% for entry in listener.auth_anonymous | default([]) %}
+{% if loop.first %}
+# Anonymous access
+{% endif %}
+{{ entry }}
+{% endfor %}
+
+{% for user in listener.users %}
+{% if loop.first %}
+# User access
+{% endif %}
+user {{ user.username }}
+{% for access_list in user.acl | default([]) %}
+topic {{ access_list.permissions }} {{ access_list.topic }}
+{% if loop.last %}
+
+{% endif %}
+{% endfor %}
+{% endfor %}
+
+{% for entry in listener.auth_patterns | default([]) %}
+{% if loop.first %}
+# Global patterns
+{% endif %}
+{{ entry }}
+{% endfor %}
diff --git a/roles/mosquitto/templates/mosquitto.conf.j2 b/roles/mosquitto/templates/mosquitto.conf.j2
new file mode 100644
index 0000000..c96c10a
--- /dev/null
+++ b/roles/mosquitto/templates/mosquitto.conf.j2
@@ -0,0 +1,36 @@
+{{ ansible_managed | comment }}
+
+# Logging Configuration
+log_timestamp true
+log_type all
+
+# Listener
+per_listener_settings true
+
+{% for elem in mosquitto_listeners %}
+### Listener '{{ elem.name }}'
+listener {{ elem.listener }}
+{% for key, value in elem | dictsort %}
+{% if key not in ["listener", "name", "users", "auth_anonymous", "auth_patterns"] %}
+{{ key }} {{ value }}
+{% endif %}
+{% endfor %}
+password_file   /etc/mosquitto/users_{{ elem.name }}
+acl_file        /etc/mosquitto/acl_{{ elem.name }}
+
+{% endfor %}
+
+{% for elem in mosquitto_bridges %}
+{% if loop.first %}
+# Bridges
+{% endif %}
+connection {{ elem.connection }}
+{% for key, value in elem | dictsort %}
+{% if key not in ["connection", "topics"] %}
+{{ key }} {{ value }}
+{% endif %}
+{% endfor %}
+{% for topic in elem.topics %}
+topic {{ topic.topic }}
+{% endfor %}
+{% endfor %}
diff --git a/roles/mosquitto/templates/users.j2 b/roles/mosquitto/templates/users.j2
new file mode 100644
index 0000000..d1107d0
--- /dev/null
+++ b/roles/mosquitto/templates/users.j2
@@ -0,0 +1,5 @@
+{{ ansible_managed | comment }}
+
+{% for user in mosquitto_users %}
+{{ user.username }}:{{ user.password | mosquitto_passwd }}
+{% endfor %}
-- 
2.39.5


From a9c66ab0e3eb6f6a60fb89a6e025caccab5f9115 Mon Sep 17 00:00:00 2001
From: Thomas Basler <thomas@familie-basler.net>
Date: Wed, 2 Oct 2024 21:13:55 +0200
Subject: [PATCH 03/13] homeassistant: Install basic mosquitto instance

---
 host_vars/lasagne.binary.kitchen  | 21 +++++++++++++++++++++
 roles/homeassistant/meta/main.yml |  3 ++-
 2 files changed, 23 insertions(+), 1 deletion(-)

diff --git a/host_vars/lasagne.binary.kitchen b/host_vars/lasagne.binary.kitchen
index b480848..b49b471 100644
--- a/host_vars/lasagne.binary.kitchen
+++ b/host_vars/lasagne.binary.kitchen
@@ -9,3 +9,24 @@ root_keys_host:
 - "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIC0Wq37DP89UO6MiJvvRbsXEcEV9d5/JJb7K2R0WHsHa sct39667@m-mob-062"
 
 uau_reboot: "false"
+
+mosquitto_listeners:
+  # Listeners for Mosquitto MQTT Broker
+  - name: "default"
+    listener: "1883"
+    protocol: "mqtt"
+    use_username_as_clientid: "false"
+    allow_zero_length_clientid: "true"
+    allow_anonymous: "false"
+    users:
+      - username: admin
+        password: "{{ vault_mosquitto_arwen_admin_passwd }}"
+        acl:
+          - permissions: readwrite
+            topic: "#"
+
+      - username: homeassistant
+        password: "{{ vault_mosquitto_arwen_homeassistant_passwd }}"
+        acl:
+          - permissions: readwrite
+            topic: "#"
diff --git a/roles/homeassistant/meta/main.yml b/roles/homeassistant/meta/main.yml
index eb29279..9a715bd 100644
--- a/roles/homeassistant/meta/main.yml
+++ b/roles/homeassistant/meta/main.yml
@@ -8,4 +8,5 @@ galaxy_info:
     - name: Debian
   min_ansible_version: "2.4"
 
-dependencies: []
+dependencies:
+  - { role: mosquitto }
-- 
2.39.5


From c7c56f212e43919fad28f406eed0ea4329043f5b Mon Sep 17 00:00:00 2001
From: Thomas Basler <thomas@familie-basler.net>
Date: Wed, 2 Oct 2024 21:19:28 +0200
Subject: [PATCH 04/13] homeassistant: Add MQTT bridge to pizza

---
 host_vars/lasagne.binary.kitchen | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/host_vars/lasagne.binary.kitchen b/host_vars/lasagne.binary.kitchen
index b49b471..05ac66c 100644
--- a/host_vars/lasagne.binary.kitchen
+++ b/host_vars/lasagne.binary.kitchen
@@ -30,3 +30,10 @@ mosquitto_listeners:
         acl:
           - permissions: readwrite
             topic: "#"
+
+mosquitto_bridges:
+  - connection: pizza
+    address: 172.23.4.6:1883
+    topics:
+      - topic: "# out 0"
+      - topic: "# in 0"
\ No newline at end of file
-- 
2.39.5


From 389331e59a541731c9cdcb0a4a8718ccf1bd559a Mon Sep 17 00:00:00 2001
From: Thomas Basler <thomas@familie-basler.net>
Date: Wed, 2 Oct 2024 21:20:39 +0200
Subject: [PATCH 05/13] Add .pyc files to .gitignore

---
 .gitignore | 1 +
 1 file changed, 1 insertion(+)

diff --git a/.gitignore b/.gitignore
index 83cf9dd..3392089 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,4 @@
 site.retry
 ansible.log
 *.swp
+*.pyc
-- 
2.39.5


From b629b62974481f76ef4067b8281064d8516cfa19 Mon Sep 17 00:00:00 2001
From: Thomas Basler <thomas@familie-basler.net>
Date: Wed, 2 Oct 2024 21:59:04 +0200
Subject: [PATCH 06/13] homeassistant: Install newer python version if required

---
 roles/homeassistant/defaults/main.yml    |  3 +++
 roles/homeassistant/tasks/main.yml       |  4 ++++
 roles/homeassistant/tasks/python_312.yml | 26 ++++++++++++++++++++++++
 roles/homeassistant/vars/main.yml        |  6 ++++++
 4 files changed, 39 insertions(+)
 create mode 100644 roles/homeassistant/defaults/main.yml
 create mode 100644 roles/homeassistant/tasks/python_312.yml
 create mode 100644 roles/homeassistant/vars/main.yml

diff --git a/roles/homeassistant/defaults/main.yml b/roles/homeassistant/defaults/main.yml
new file mode 100644
index 0000000..11d0f72
--- /dev/null
+++ b/roles/homeassistant/defaults/main.yml
@@ -0,0 +1,3 @@
+---
+
+ha_python_version: '3.12'
diff --git a/roles/homeassistant/tasks/main.yml b/roles/homeassistant/tasks/main.yml
index ed97d53..87982b2 100644
--- a/roles/homeassistant/tasks/main.yml
+++ b/roles/homeassistant/tasks/main.yml
@@ -1 +1,5 @@
 ---
+
+- name: Install python if required
+  ansible.builtin.include_tasks: python_312.yml
+  when: ha_python_version == '3.12'
diff --git a/roles/homeassistant/tasks/python_312.yml b/roles/homeassistant/tasks/python_312.yml
new file mode 100644
index 0000000..cb9cfc2
--- /dev/null
+++ b/roles/homeassistant/tasks/python_312.yml
@@ -0,0 +1,26 @@
+---
+
+- name: Python 3.12 | add GPG signing key
+  become: true
+  ansible.builtin.apt_key:
+    url: "https://pascalroeleven.nl/deb-pascalroeleven.gpg"
+    state: present
+    validate_certs: true
+  tags: install
+
+- name: Python 3.12 | add official repository
+  become: true
+  ansible.builtin.apt_repository:
+    repo: "deb http://deb.pascalroeleven.nl/python3.12 bookworm-backports main"
+    state: present
+    filename: python312
+    update_cache: true
+  tags: install
+
+- name: Python 3.12 | establish dependencies
+  become: true
+  ansible.builtin.apt:
+    name: "{{ item }}"
+    state: present
+  loop: "{{ python312_dependencies }}"
+  tags: install
diff --git a/roles/homeassistant/vars/main.yml b/roles/homeassistant/vars/main.yml
new file mode 100644
index 0000000..7209b3e
--- /dev/null
+++ b/roles/homeassistant/vars/main.yml
@@ -0,0 +1,6 @@
+---
+
+python312_dependencies:
+  - python3.12
+  - python3.12-venv
+  - python3.12-dev
-- 
2.39.5


From 3b8cc7d1ea5b122b850d4f9942e542a40cf3643a Mon Sep 17 00:00:00 2001
From: Thomas Basler <thomas@familie-basler.net>
Date: Wed, 2 Oct 2024 22:09:54 +0200
Subject: [PATCH 07/13] homeassistant: Prepare system for installation (install
 packages, create directories)

---
 roles/homeassistant/defaults/main.yml     | 10 ++++++
 roles/homeassistant/tasks/main.yml        |  5 +++
 roles/homeassistant/tasks/preparation.yml | 41 +++++++++++++++++++++++
 3 files changed, 56 insertions(+)
 create mode 100644 roles/homeassistant/tasks/preparation.yml

diff --git a/roles/homeassistant/defaults/main.yml b/roles/homeassistant/defaults/main.yml
index 11d0f72..8565fda 100644
--- a/roles/homeassistant/defaults/main.yml
+++ b/roles/homeassistant/defaults/main.yml
@@ -1,3 +1,13 @@
 ---
 
+# Python version required for home assistant
 ha_python_version: '3.12'
+
+# The location of the config directory
+ha_conf_dir: /etc/homeassistant
+
+# The location of the installatin directory
+ha_venv_dir: "/opt/homeassistant"
+
+# The default user
+ha_user: homeassistant
diff --git a/roles/homeassistant/tasks/main.yml b/roles/homeassistant/tasks/main.yml
index 87982b2..bd2e656 100644
--- a/roles/homeassistant/tasks/main.yml
+++ b/roles/homeassistant/tasks/main.yml
@@ -3,3 +3,8 @@
 - name: Install python if required
   ansible.builtin.include_tasks: python_312.yml
   when: ha_python_version == '3.12'
+
+- name: Include sub-tasks
+  ansible.builtin.include_tasks: '{{ item }}'
+  loop:
+    - preparation.yml
diff --git a/roles/homeassistant/tasks/preparation.yml b/roles/homeassistant/tasks/preparation.yml
new file mode 100644
index 0000000..1c74213
--- /dev/null
+++ b/roles/homeassistant/tasks/preparation.yml
@@ -0,0 +1,41 @@
+---
+
+- name: Install commonly-named packages
+  ansible.builtin.package:
+    name: "{{ item }}"
+    state: present
+  loop:
+    - python3
+    - python3-dev
+    - python3-venv
+    - python3-pip
+    - libffi-dev
+    - libssl-dev
+    - libjpeg-dev
+    - zlib1g-dev
+    - autoconf
+    - build-essential
+    - libopenjp2-7
+    - libtiff6
+    - libturbojpeg0
+    - tzdata
+    - git
+    - ffmpeg
+
+- name: Create user
+  ansible.builtin.user:
+    name: "{{ ha_user }}"
+    comment: "Home Assistant"
+    system: true
+    shell: "/sbin/nologin"
+
+- name: Create directory
+  ansible.builtin.file:
+    path: "{{ item }}"
+    state: directory
+    mode: "02775"
+    owner: "{{ ha_user }}"
+    group: "{{ ha_user }}"
+  loop:
+    - "{{ ha_conf_dir }}"
+    - "{{ ha_venv_dir }}"
-- 
2.39.5


From 552c9d71b36a03dcb2bb03928fd195ae4328553d Mon Sep 17 00:00:00 2001
From: Thomas Basler <thomas@familie-basler.net>
Date: Wed, 2 Oct 2024 22:26:46 +0200
Subject: [PATCH 08/13] homeassistant: Added install procedure for postgres
 database

---
 host_vars/lasagne.binary.kitchen       |  4 +-
 roles/homeassistant/defaults/main.yml  |  5 +++
 roles/homeassistant/handlers/main.yml  |  6 +++
 roles/homeassistant/tasks/main.yml     |  1 +
 roles/homeassistant/tasks/postgres.yml | 54 ++++++++++++++++++++++++++
 5 files changed, 69 insertions(+), 1 deletion(-)
 create mode 100644 roles/homeassistant/handlers/main.yml
 create mode 100644 roles/homeassistant/tasks/postgres.yml

diff --git a/host_vars/lasagne.binary.kitchen b/host_vars/lasagne.binary.kitchen
index 05ac66c..4871259 100644
--- a/host_vars/lasagne.binary.kitchen
+++ b/host_vars/lasagne.binary.kitchen
@@ -36,4 +36,6 @@ mosquitto_bridges:
     address: 172.23.4.6:1883
     topics:
       - topic: "# out 0"
-      - topic: "# in 0"
\ No newline at end of file
+      - topic: "# in 0"
+
+ha_pg_db_pass: "{{ vault_ha_pg_db_pass }}"
\ No newline at end of file
diff --git a/roles/homeassistant/defaults/main.yml b/roles/homeassistant/defaults/main.yml
index 8565fda..b7a786f 100644
--- a/roles/homeassistant/defaults/main.yml
+++ b/roles/homeassistant/defaults/main.yml
@@ -11,3 +11,8 @@ ha_venv_dir: "/opt/homeassistant"
 
 # The default user
 ha_user: homeassistant
+
+ha_pg_db_version: 15
+ha_pg_db_name: homeassistant
+ha_pg_db_user: homeassistant
+ha_pg_db_pass: xxxxx
diff --git a/roles/homeassistant/handlers/main.yml b/roles/homeassistant/handlers/main.yml
new file mode 100644
index 0000000..8cb9a93
--- /dev/null
+++ b/roles/homeassistant/handlers/main.yml
@@ -0,0 +1,6 @@
+---
+
+- name: Restart postgresql
+  ansible.builtin.service:
+    name: postgresql
+    state: restarted
diff --git a/roles/homeassistant/tasks/main.yml b/roles/homeassistant/tasks/main.yml
index bd2e656..ee248b2 100644
--- a/roles/homeassistant/tasks/main.yml
+++ b/roles/homeassistant/tasks/main.yml
@@ -8,3 +8,4 @@
   ansible.builtin.include_tasks: '{{ item }}'
   loop:
     - preparation.yml
+    - postgres.yml
diff --git a/roles/homeassistant/tasks/postgres.yml b/roles/homeassistant/tasks/postgres.yml
new file mode 100644
index 0000000..eee0f56
--- /dev/null
+++ b/roles/homeassistant/tasks/postgres.yml
@@ -0,0 +1,54 @@
+---
+
+- name: Postgres | establish dependencies
+  ansible.builtin.package:
+    name: "{{ item }}"
+    state: present
+  loop:
+    - postgresql-{{ ha_pg_db_version }}
+    - libpq-dev
+    - python3-psycopg2
+
+- name: Postgres | Configure PostgreSQL database
+  community.general.postgresql_db:
+    name: "{{ ha_pg_db_name }}"
+    template: template0
+    encoding: utf8
+  become: true
+  become_user: postgres
+
+- name: Postgres | Configure PostgreSQL user
+  community.general.postgresql_user:
+    db: "{{ ha_pg_db_name }}"
+    name: "{{ ha_pg_db_user }}"
+    password: "{{ ha_pg_db_pass }}"
+  become: true
+  become_user: postgres
+
+- name: Postgres | GRANT ALL PRIVILEGES ON SCHEMA public TO {{ ha_pg_db_user }}
+  community.postgresql.postgresql_privs:
+    db: "{{ ha_pg_db_user }}"
+    privs: ALL
+    type: schema
+    objs: public
+    role: "{{ ha_pg_db_user }}"
+  become: true
+  become_user: postgres
+
+- name: Postgres | Grant all users access to all dbs
+  community.general.postgresql_pg_hba:
+    dest: /etc/postgresql/{{ ha_pg_db_version }}/main/pg_hba.conf
+    contype: host
+    users: all
+    databases: all
+    method: scram-sha-256
+    source: 0.0.0.0/0
+  notify: Restart postgresql
+
+- name: Postgres | Listen to external interfaces
+  community.general.postgresql_set:
+    name: listen_addresses
+    value: "*"
+  become: true
+  become_user: postgres
+  notify: Restart postgresql
-- 
2.39.5


From 6bfff16a4b2094699ff840fbe132b35660c8b5d7 Mon Sep 17 00:00:00 2001
From: Thomas Basler <thomas@familie-basler.net>
Date: Wed, 2 Oct 2024 23:07:09 +0200
Subject: [PATCH 09/13] homeassistant: Add installation procedures for
 homeassistant

---
 roles/homeassistant/handlers/main.yml         |  5 +++
 roles/homeassistant/tasks/installation.yml    | 33 +++++++++++++++++++
 roles/homeassistant/tasks/main.yml            |  2 ++
 roles/homeassistant/tasks/systemd.yml         | 17 ++++++++++
 .../templates/home-assistant.service.j2       | 14 ++++++++
 5 files changed, 71 insertions(+)
 create mode 100644 roles/homeassistant/tasks/installation.yml
 create mode 100644 roles/homeassistant/tasks/systemd.yml
 create mode 100644 roles/homeassistant/templates/home-assistant.service.j2

diff --git a/roles/homeassistant/handlers/main.yml b/roles/homeassistant/handlers/main.yml
index 8cb9a93..69cfebc 100644
--- a/roles/homeassistant/handlers/main.yml
+++ b/roles/homeassistant/handlers/main.yml
@@ -4,3 +4,8 @@
   ansible.builtin.service:
     name: postgresql
     state: restarted
+
+- name: Restart homeassistant
+  ansible.builtin.service:
+    name: home-assistant
+    state: restarted
diff --git a/roles/homeassistant/tasks/installation.yml b/roles/homeassistant/tasks/installation.yml
new file mode 100644
index 0000000..64d88af
--- /dev/null
+++ b/roles/homeassistant/tasks/installation.yml
@@ -0,0 +1,33 @@
+---
+
+- name: Install defined version of Home Assistant
+  ansible.builtin.pip:
+    name:
+      - wheel
+      - psycopg2
+      - packaging
+      - uv
+      - netifaces
+      - homeassistant=={{ ha_version }}
+    virtualenv: '{{ ha_venv_dir }}'
+    virtualenv_command: 'python{{ ha_python_version }} -m venv'
+  when: ha_version is defined
+  become: true
+  become_user: "{{ ha_user }}"
+  notify: Restart homeassistant
+
+- name: Install latest version of Home Assistant
+  ansible.builtin.pip:
+    name:
+      - wheel
+      - psycopg2
+      - packaging
+      - uv
+      - homeassistant
+    extra_args: "--upgrade"
+    virtualenv: "{{ ha_venv_dir }}"
+    virtualenv_command: 'python{{ ha_python_version }} -m venv'
+  when: ha_version is undefined
+  become: true
+  become_user: "{{ ha_user }}"
+  notify: Restart homeassistant
diff --git a/roles/homeassistant/tasks/main.yml b/roles/homeassistant/tasks/main.yml
index ee248b2..b200556 100644
--- a/roles/homeassistant/tasks/main.yml
+++ b/roles/homeassistant/tasks/main.yml
@@ -9,3 +9,5 @@
   loop:
     - preparation.yml
     - postgres.yml
+    - systemd.yml
+    - installation.yml
diff --git a/roles/homeassistant/tasks/systemd.yml b/roles/homeassistant/tasks/systemd.yml
new file mode 100644
index 0000000..2c6c63f
--- /dev/null
+++ b/roles/homeassistant/tasks/systemd.yml
@@ -0,0 +1,17 @@
+---
+
+- name: Install systemd unit file
+  ansible.builtin.template:
+    src: home-assistant.service.j2
+    dest: "/etc/systemd/system/home-assistant.service"
+    owner: root
+    group: root
+    mode: "0644"
+  notify: Restart homeassistant
+
+- name: Enable home assistant service
+  ansible.builtin.systemd:
+    name: home-assistant
+    daemon_reload: true
+    enabled: true
+  notify: Restart homeassistant
\ No newline at end of file
diff --git a/roles/homeassistant/templates/home-assistant.service.j2 b/roles/homeassistant/templates/home-assistant.service.j2
new file mode 100644
index 0000000..fc6caff
--- /dev/null
+++ b/roles/homeassistant/templates/home-assistant.service.j2
@@ -0,0 +1,14 @@
+[Unit]
+Description=Home Assistant
+After=network.target postgresql.service
+
+[Service]
+Type=simple
+User={{ ha_user }}
+Environment="PATH=/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:{{ ha_venv_dir }}/bin"
+ExecStart={{ ha_venv_dir }}/bin/hass --config {{ ha_conf_dir }}
+Restart=always
+RestartSec=3
+
+[Install]
+WantedBy=multi-user.target
-- 
2.39.5


From 838d881480f76a79f52cb40449d63a0a6f0f0543 Mon Sep 17 00:00:00 2001
From: Thomas Basler <thomas@familie-basler.net>
Date: Wed, 2 Oct 2024 23:19:54 +0200
Subject: [PATCH 10/13] pgadmin4: Add role to install and configure pgadmin4

---
 roles/pgadmin4/defaults/main.yml             |  10 ++
 roles/pgadmin4/handlers/main.yml             |   6 +
 roles/pgadmin4/meta/main.yml                 |  11 ++
 roles/pgadmin4/tasks/main.yml                | 119 +++++++++++++++++++
 roles/pgadmin4/templates/config_system.py.j2 |   4 +
 roles/pgadmin4/templates/pgadmin4.service.j2 |  29 +++++
 6 files changed, 179 insertions(+)
 create mode 100644 roles/pgadmin4/defaults/main.yml
 create mode 100644 roles/pgadmin4/handlers/main.yml
 create mode 100644 roles/pgadmin4/meta/main.yml
 create mode 100644 roles/pgadmin4/tasks/main.yml
 create mode 100644 roles/pgadmin4/templates/config_system.py.j2
 create mode 100644 roles/pgadmin4/templates/pgadmin4.service.j2

diff --git a/roles/pgadmin4/defaults/main.yml b/roles/pgadmin4/defaults/main.yml
new file mode 100644
index 0000000..7da5e34
--- /dev/null
+++ b/roles/pgadmin4/defaults/main.yml
@@ -0,0 +1,10 @@
+---
+
+pgadmin4_user: pgadmin4
+pgadmin4_db_database: pgadmin4
+pgadmin4_db_user: pgadmin4
+pgadmin4_db_password: xxxxx
+pgadmin4_conf_dir: /etc/pgadmin
+
+pgadmin4_initial_user_email: admin@admin.com
+pgadmin4_initial_user_password: admin42
diff --git a/roles/pgadmin4/handlers/main.yml b/roles/pgadmin4/handlers/main.yml
new file mode 100644
index 0000000..c0bf955
--- /dev/null
+++ b/roles/pgadmin4/handlers/main.yml
@@ -0,0 +1,6 @@
+---
+
+- name: Restart pgadmin4
+  ansible.builtin.service:
+    name: pgadmin4
+    state: restarted
diff --git a/roles/pgadmin4/meta/main.yml b/roles/pgadmin4/meta/main.yml
new file mode 100644
index 0000000..1cf895d
--- /dev/null
+++ b/roles/pgadmin4/meta/main.yml
@@ -0,0 +1,11 @@
+---
+
+galaxy_info:
+  author: Thomas Basler
+  description: Install PgAdmin4
+  license: None
+  platforms:
+    - name: Debian
+  min_ansible_version: "2.4"
+
+dependencies: []
diff --git a/roles/pgadmin4/tasks/main.yml b/roles/pgadmin4/tasks/main.yml
new file mode 100644
index 0000000..3a6355e
--- /dev/null
+++ b/roles/pgadmin4/tasks/main.yml
@@ -0,0 +1,119 @@
+---
+
+- name: PgAdmin 4 | add GPG signing key
+  become: true
+  ansible.builtin.apt_key:
+    url: "https://www.pgadmin.org/static/packages_pgadmin_org.pub"
+    state: present
+    validate_certs: true
+  tags: install
+
+- name: PgAdmin 4 | add official repository
+  become: true
+  ansible.builtin.apt_repository:
+    repo: "deb https://ftp.postgresql.org/pub/pgadmin/pgadmin4/apt/bookworm pgadmin4 main"
+    state: present
+    filename: pgadmin4
+    update_cache: true
+  tags: install
+
+- name: PgAdmin 4 | establish dependencies
+  become: true
+  ansible.builtin.apt:
+    name: "{{ item }}"
+    state: present
+  tags: install
+  loop: ["pgadmin4-server", "uwsgi-core", "uwsgi-plugin-python3", "python3-pexpect"]
+
+- name: PgAdmin 4 | Configure PostgreSQL database
+  community.general.postgresql_db:
+    name: "{{ pgadmin4_db_database }}"
+    template: template0
+    encoding: utf8
+  become: true
+  become_user: postgres
+  register: pgadmin4_db
+
+- name: PgAdmin 4 | Configure PostgreSQL user
+  community.general.postgresql_user:
+    db: "{{ pgadmin4_db_database }}"
+    name: "{{ pgadmin4_db_user }}"
+    password: "{{ pgadmin4_db_password }}"
+  become: true
+  become_user: postgres
+
+- name: PgAdmin 4 | Configure PostgreSQL user privileges
+  community.postgresql.postgresql_privs:
+    database: "{{ pgadmin4_db_database }}"
+    state: present
+    privs: ALL
+    type: database
+    role: "{{ pgadmin4_db_user }}"
+  become: true
+  become_user: postgres
+
+- name: PgAdmin 4 | GRANT ALL PRIVILEGES ON SCHEMA public TO {{ pgadmin4_db_user }}
+  community.postgresql.postgresql_privs:
+    db: "{{ pgadmin4_db_database }}"
+    privs: ALL
+    type: schema
+    objs: public
+    role: "{{ pgadmin4_db_user }}"
+  become: true
+  become_user: postgres
+
+- name: Create user
+  ansible.builtin.user:
+    name: "{{ pgadmin4_user }}"
+    comment: "pgAdmin 4"
+    createhome: false
+    system: true
+    shell: "/sbin/nologin"
+
+- name: PgAdmin 4 | create config directory
+  ansible.builtin.file:
+    path: "{{ item }}"
+    state: directory
+    mode: "02775"
+    owner: "root"
+    group: "root"
+  with_items:
+    - "{{ pgadmin4_conf_dir }}"
+
+- name: PgAdmin 4 | install config file
+  ansible.builtin.template:
+    src: config_system.py.j2
+    dest: "{{ pgadmin4_conf_dir }}/config_system.py"
+    owner: root
+    group: root
+    mode: "0644"
+  notify: Restart pgadmin4
+
+- name: PgAdmin 4 | install systemd unit file
+  ansible.builtin.template:
+    src: pgadmin4.service.j2
+    dest: "/etc/systemd/system/pgadmin4.service"
+    owner: root
+    group: root
+    mode: "0644"
+  notify: Restart pgadmin4
+
+- name: PgAdmin 4 | enable service
+  ansible.builtin.service:
+    name: pgadmin4
+    enabled: true
+
+- name: PgAdmin 4 | setup pgadmin # noqa: no-handler
+  ansible.builtin.expect:
+    command: /bin/bash -c "/usr/pgadmin4/venv/bin/python3 /usr/pgadmin4/web/setup.py setup-db"
+    chdir: /usr/pgadmin4/web/
+    echo: true
+    timeout: 300
+    responses:
+      'Email\ address:': "{{ pgadmin4_initial_user_email | trim }}"
+      'Password:': "{{ pgadmin4_initial_user_password | trim }}"
+      'Retype\ password:': "{{ pgadmin4_initial_user_password | trim }}"
+      'Do\ you\ wish\ to\ continue\ \(y/n\)\?': "y"
+      'Would\ you\ like\ to\ continue\ \(y/n\)\?': "y"
+  when: pgadmin4_db.changed
+  notify: Restart pgadmin4
diff --git a/roles/pgadmin4/templates/config_system.py.j2 b/roles/pgadmin4/templates/config_system.py.j2
new file mode 100644
index 0000000..5a56136
--- /dev/null
+++ b/roles/pgadmin4/templates/config_system.py.j2
@@ -0,0 +1,4 @@
+LOG_FILE = '/var/log/pgadmin/pgadmin4.log'
+CONFIG_DATABASE_URI = 'postgresql://{{ pgadmin4_db_user }}:{{ pgadmin4_db_password }}@localhost:5432/{{ pgadmin4_db_database }}'
+SESSION_DB_PATH = '/var/lib/pgadmin/sessions'
+STORAGE_DIR = '/var/lib/pgadmin/storage'
\ No newline at end of file
diff --git a/roles/pgadmin4/templates/pgadmin4.service.j2 b/roles/pgadmin4/templates/pgadmin4.service.j2
new file mode 100644
index 0000000..cfa45aa
--- /dev/null
+++ b/roles/pgadmin4/templates/pgadmin4.service.j2
@@ -0,0 +1,29 @@
+[Unit]
+Description = PgAdmin4 uwsgi Service
+After = network.target network-online.target
+Wants = network-online.target
+
+[Service]
+User={{ pgadmin4_user }}
+StateDirectory=pgadmin
+RuntimeDirectory=pgadmin4
+LogsDirectory=pgadmin
+ExecStart=uwsgi \
+      --socket /run/pgadmin4/pgadmin4.sock --chmod-socket=666 \
+      --plugin python3 \
+      -H /usr/pgadmin4/venv \
+      --processes 1 \
+      --threads 25 \
+      --chdir /usr/pgadmin4/web/ \
+      --manage-script-name \
+      --mount /pgadmin4=pgAdmin4:app
+ExecReload=/bin/kill -HUP $MAINPID
+ExecStop=/bin/kill -INT $MAINPID
+Restart=always
+Type=notify
+StandardError=syslog
+NotifyAccess=all
+KillSignal=SIGQUIT
+
+[Install]
+WantedBy = multi-user.target
\ No newline at end of file
-- 
2.39.5


From 3e87601013fd64a53e5e022bab7b3ac21f934d54 Mon Sep 17 00:00:00 2001
From: Thomas Basler <thomas@familie-basler.net>
Date: Wed, 2 Oct 2024 23:20:43 +0200
Subject: [PATCH 11/13] homeassistant: Install pgadmin4

---
 host_vars/lasagne.binary.kitchen  | 5 ++++-
 roles/homeassistant/meta/main.yml | 1 +
 2 files changed, 5 insertions(+), 1 deletion(-)

diff --git a/host_vars/lasagne.binary.kitchen b/host_vars/lasagne.binary.kitchen
index 4871259..aecfaff 100644
--- a/host_vars/lasagne.binary.kitchen
+++ b/host_vars/lasagne.binary.kitchen
@@ -38,4 +38,7 @@ mosquitto_bridges:
       - topic: "# out 0"
       - topic: "# in 0"
 
-ha_pg_db_pass: "{{ vault_ha_pg_db_pass }}"
\ No newline at end of file
+ha_pg_db_pass: "{{ vault_ha_pg_db_pass }}"
+pgadmin4_db_password: "{{ vault_pgadmin4_db_password }}"
+pgadmin4_initial_user_email: noby@binary-kitchen.de
+pgadmin4_initial_user_password: "{{ vault_pgadmin4_initial_user_password }}"
\ No newline at end of file
diff --git a/roles/homeassistant/meta/main.yml b/roles/homeassistant/meta/main.yml
index 9a715bd..9b650cd 100644
--- a/roles/homeassistant/meta/main.yml
+++ b/roles/homeassistant/meta/main.yml
@@ -10,3 +10,4 @@ galaxy_info:
 
 dependencies:
   - { role: mosquitto }
+  - { role: pgadmin4 }
-- 
2.39.5


From 6e55e4ff7824a2ed9b753886805256a2ca68f420 Mon Sep 17 00:00:00 2001
From: Thomas Basler <thomas@familie-basler.net>
Date: Thu, 3 Oct 2024 00:48:58 +0200
Subject: [PATCH 12/13] homeassistant: Add installation procedures for grafana

---
 host_vars/lasagne.binary.kitchen             |    3 +-
 roles/homeassistant/defaults/main.yml        |    4 +
 roles/homeassistant/handlers/main.yml        |    5 +
 roles/homeassistant/tasks/grafana.yml        |   77 ++
 roles/homeassistant/tasks/main.yml           |    1 +
 roles/homeassistant/templates/grafana.ini.j2 | 1082 ++++++++++++++++++
 6 files changed, 1171 insertions(+), 1 deletion(-)
 create mode 100644 roles/homeassistant/tasks/grafana.yml
 create mode 100644 roles/homeassistant/templates/grafana.ini.j2

diff --git a/host_vars/lasagne.binary.kitchen b/host_vars/lasagne.binary.kitchen
index aecfaff..52b25cf 100644
--- a/host_vars/lasagne.binary.kitchen
+++ b/host_vars/lasagne.binary.kitchen
@@ -41,4 +41,5 @@ mosquitto_bridges:
 ha_pg_db_pass: "{{ vault_ha_pg_db_pass }}"
 pgadmin4_db_password: "{{ vault_pgadmin4_db_password }}"
 pgadmin4_initial_user_email: noby@binary-kitchen.de
-pgadmin4_initial_user_password: "{{ vault_pgadmin4_initial_user_password }}"
\ No newline at end of file
+pgadmin4_initial_user_password: "{{ vault_pgadmin4_initial_user_password }}"
+ha_pg_grafana_db_pass: "{{ vault_ha_pg_grafana_db_pass }}"
diff --git a/roles/homeassistant/defaults/main.yml b/roles/homeassistant/defaults/main.yml
index b7a786f..099a1c2 100644
--- a/roles/homeassistant/defaults/main.yml
+++ b/roles/homeassistant/defaults/main.yml
@@ -16,3 +16,7 @@ ha_pg_db_version: 15
 ha_pg_db_name: homeassistant
 ha_pg_db_user: homeassistant
 ha_pg_db_pass: xxxxx
+
+ha_pg_grafana_db_name: grafana
+ha_pg_grafana_db_user: grafana
+ha_pg_grafana_db_pass: xxxxx
diff --git a/roles/homeassistant/handlers/main.yml b/roles/homeassistant/handlers/main.yml
index 69cfebc..6728c1d 100644
--- a/roles/homeassistant/handlers/main.yml
+++ b/roles/homeassistant/handlers/main.yml
@@ -9,3 +9,8 @@
   ansible.builtin.service:
     name: home-assistant
     state: restarted
+
+- name: Restart grafana
+  ansible.builtin.service:
+    name: grafana-server
+    state: restarted
diff --git a/roles/homeassistant/tasks/grafana.yml b/roles/homeassistant/tasks/grafana.yml
new file mode 100644
index 0000000..819a5e9
--- /dev/null
+++ b/roles/homeassistant/tasks/grafana.yml
@@ -0,0 +1,77 @@
+---
+
+- name: Grafana | add GPG signing key
+  become: true
+  ansible.builtin.apt_key:
+    url: "https://apt.grafana.com/gpg.key"
+    state: present
+    validate_certs: true
+
+- name: Grafana | add official repository
+  become: true
+  ansible.builtin.apt_repository:
+    repo: "deb https://apt.grafana.com stable main"
+    state: present
+    filename: grafana
+    update_cache: true
+  tags: install
+
+- name: Grafana | establish dependencies
+  become: true
+  ansible.builtin.apt:
+    name: "{{ item }}"
+    state: present
+  loop: ["grafana"]
+  tags: install
+
+- name: Grafana | Configure PostgreSQL database
+  community.general.postgresql_db:
+    name: "{{ ha_pg_grafana_db_name }}"
+    template: template0
+    encoding: utf8
+  become: true
+  become_user: postgres
+
+- name: Grafana | Configure PostgreSQL user
+  community.general.postgresql_user:
+    db: "{{ ha_pg_grafana_db_name }}"
+    name: "{{ ha_pg_grafana_db_user }}"
+    password: "{{ ha_pg_grafana_db_pass }}"
+  become: true
+  become_user: postgres
+
+- name: Grafana | GRANT ALL PRIVILEGES ON SCHEMA public TO {{ pgadmin4_db_user }}
+  community.postgresql.postgresql_privs:
+    db: "{{ ha_pg_grafana_db_name }}"
+    privs: ALL
+    type: schema
+    objs: public
+    role: "{{ ha_pg_grafana_db_user }}"
+  become: true
+  become_user: postgres
+
+- name: GRANT SELECT PRIVILEGES ON DATABASE {{ ha_pg_db_name }} TO {{ ha_pg_grafana_db_user }}
+  community.general.postgresql_privs:
+    db: "{{ ha_pg_db_name }}"
+    privs: SELECT
+    type: table
+    objs: statistics,statistics_meta
+    role: "{{ ha_pg_grafana_db_user }}"
+  become: true
+  become_user: postgres
+  ignore_errors: true
+
+- name: Grafana | install config file
+  ansible.builtin.template:
+    src: grafana.ini.j2
+    dest: "/etc/grafana/grafana.ini"
+    owner: root
+    group: root
+    mode: "0644"
+  notify: Restart grafana
+
+- name: Grafana | Start service
+  ansible.builtin.service:
+    name: grafana-server
+    state: started
+    enabled: true
diff --git a/roles/homeassistant/tasks/main.yml b/roles/homeassistant/tasks/main.yml
index b200556..7259630 100644
--- a/roles/homeassistant/tasks/main.yml
+++ b/roles/homeassistant/tasks/main.yml
@@ -11,3 +11,4 @@
     - postgres.yml
     - systemd.yml
     - installation.yml
+    - grafana.yml
diff --git a/roles/homeassistant/templates/grafana.ini.j2 b/roles/homeassistant/templates/grafana.ini.j2
new file mode 100644
index 0000000..9ab8426
--- /dev/null
+++ b/roles/homeassistant/templates/grafana.ini.j2
@@ -0,0 +1,1082 @@
+{{ ansible_managed | comment }}
+
+##################### Grafana Configuration Example #####################
+#
+# Everything has defaults so you only need to uncomment things you want to
+# change
+
+# possible values : production, development
+;app_mode = production
+
+# instance name, defaults to HOSTNAME environment variable value or hostname if HOSTNAME var is empty
+;instance_name = ${HOSTNAME}
+
+#################################### Paths ####################################
+[paths]
+# Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used)
+;data = /var/lib/grafana
+
+# Temporary files in `data` directory older than given duration will be removed
+;temp_data_lifetime = 24h
+
+# Directory where grafana can store logs
+;logs = /var/log/grafana
+
+# Directory where grafana will automatically scan and look for plugins
+;plugins = /var/lib/grafana/plugins
+
+# folder that contains provisioning config files that grafana will apply on startup and while running.
+;provisioning = conf/provisioning
+
+#################################### Server ####################################
+[server]
+# Protocol (http, https, h2, socket)
+;protocol = http
+
+# The ip address to bind to, empty will bind to all interfaces
+;http_addr =
+
+# The http port  to use
+;http_port = 3000
+
+# The public facing domain name used to access grafana from a browser
+;domain = localhost
+
+# Redirect to correct domain if host header does not match domain
+# Prevents DNS rebinding attacks
+;enforce_domain = false
+
+# The full public facing url you use in browser, used for redirects and emails
+# If you use reverse proxy and sub path specify full url (with sub path)
+root_url = %(protocol)s://%(domain)s:%(http_port)s/grafana/
+
+# Serve Grafana from subpath specified in `root_url` setting. By default it is set to `false` for compatibility reasons.
+serve_from_sub_path = true
+
+# Log web requests
+;router_logging = false
+
+# the path relative working path
+;static_root_path = public
+
+# enable gzip
+;enable_gzip = false
+
+# https certs & key file
+;cert_file =
+;cert_key =
+
+# Unix socket path
+;socket =
+
+# CDN Url
+;cdn_url =
+
+# Sets the maximum time using a duration format (5s/5m/5ms) before timing out read of an incoming request and closing idle connections.
+# `0` means there is no timeout for reading the request.
+;read_timeout = 0
+
+#################################### Database ####################################
+[database]
+# You can configure the database connection by specifying type, host, name, user and password
+# as separate properties or as on string using the url properties.
+
+# Either "mysql", "postgres" or "sqlite3", it's your choice
+;type = sqlite3
+;host = 127.0.0.1:3306
+;name = grafana
+;user = root
+# If the password contains # or ; you have to wrap it with triple quotes. Ex """#password;"""
+;password =
+
+# Use either URL or the previous fields to configure the database
+# Example: mysql://user:secret@host:port/database
+url = postgres://{{ ha_pg_grafana_db_user }}:{{ ha_pg_grafana_db_pass }}@/{{ ha_pg_grafana_db_name }}
+
+# For "postgres" only, either "disable", "require" or "verify-full"
+;ssl_mode = disable
+
+# Database drivers may support different transaction isolation levels.
+# Currently, only "mysql" driver supports isolation levels.
+# If the value is empty - driver's default isolation level is applied.
+# For "mysql" use "READ-UNCOMMITTED", "READ-COMMITTED", "REPEATABLE-READ" or "SERIALIZABLE".
+;isolation_level =
+
+;ca_cert_path =
+;client_key_path =
+;client_cert_path =
+;server_cert_name =
+
+# For "sqlite3" only, path relative to data_path setting
+;path = grafana.db
+
+# Max idle conn setting default is 2
+;max_idle_conn = 2
+
+# Max conn setting default is 0 (mean not set)
+;max_open_conn =
+
+# Connection Max Lifetime default is 14400 (means 14400 seconds or 4 hours)
+;conn_max_lifetime = 14400
+
+# Set to true to log the sql calls and execution times.
+;log_queries =
+
+# For "sqlite3" only. cache mode setting used for connecting to the database. (private, shared)
+;cache_mode = private
+
+################################### Data sources #########################
+[datasources]
+# Upper limit of data sources that Grafana will return. This limit is a temporary configuration and it will be deprecated when pagination will be introduced on the list data sources API.
+;datasource_limit = 5000
+
+#################################### Cache server #############################
+[remote_cache]
+# Either "redis", "memcached" or "database" default is "database"
+;type = database
+
+# cache connectionstring options
+# database: will use Grafana primary database.
+# redis: config like redis server e.g. `addr=127.0.0.1:6379,pool_size=100,db=0,ssl=false`. Only addr is required. ssl may be 'true', 'false', or 'insecure'.
+# memcache: 127.0.0.1:11211
+;connstr =
+
+#################################### Data proxy ###########################
+[dataproxy]
+
+# This enables data proxy logging, default is false
+;logging = false
+
+# How long the data proxy waits to read the headers of the response before timing out, default is 30 seconds.
+# This setting also applies to core backend HTTP data sources where query requests use an HTTP client with timeout set.
+;timeout = 30
+
+# How long the data proxy waits to establish a TCP connection before timing out, default is 10 seconds.
+;dialTimeout = 10
+
+# How many seconds the data proxy waits before sending a keepalive probe request.
+;keep_alive_seconds = 30
+
+# How many seconds the data proxy waits for a successful TLS Handshake before timing out.
+;tls_handshake_timeout_seconds = 10
+
+# How many seconds the data proxy will wait for a server's first response headers after
+# fully writing the request headers if the request has an "Expect: 100-continue"
+# header. A value of 0 will result in the body being sent immediately, without
+# waiting for the server to approve.
+;expect_continue_timeout_seconds = 1
+
+# Optionally limits the total number of connections per host, including connections in the dialing,
+# active, and idle states. On limit violation, dials will block.
+# A value of zero (0) means no limit.
+;max_conns_per_host = 0
+
+# The maximum number of idle connections that Grafana will keep alive.
+;max_idle_connections = 100
+
+# How many seconds the data proxy keeps an idle connection open before timing out.
+;idle_conn_timeout_seconds = 90
+
+# If enabled and user is not anonymous, data proxy will add X-Grafana-User header with username into the request, default is false.
+;send_user_header = false
+
+# Limit the amount of bytes that will be read/accepted from responses of outgoing HTTP requests.
+;response_limit = 0
+
+# Limits the number of rows that Grafana will process from SQL data sources.
+;row_limit = 1000000
+
+#################################### Analytics ####################################
+[analytics]
+# Server reporting, sends usage counters to stats.grafana.org every 24 hours.
+# No ip addresses are being tracked, only simple counters to track
+# running instances, dashboard and error counts. It is very helpful to us.
+# Change this option to false to disable reporting.
+;reporting_enabled = true
+
+# The name of the distributor of the Grafana instance. Ex hosted-grafana, grafana-labs
+;reporting_distributor = grafana-labs
+
+# Set to false to disable all checks to https://grafana.net
+# for new versions (grafana itself and plugins), check is used
+# in some UI views to notify that grafana or plugin update exists
+# This option does not cause any auto updates, nor send any information
+# only a GET request to http://grafana.com to get latest versions
+;check_for_updates = true
+
+# Google Analytics universal tracking code, only enabled if you specify an id here
+;google_analytics_ua_id =
+
+# Google Tag Manager ID, only enabled if you specify an id here
+;google_tag_manager_id =
+
+#################################### Security ####################################
+[security]
+# disable creation of admin user on first start of grafana
+;disable_initial_admin_creation = false
+
+# default admin user, created on startup
+;admin_user = admin
+
+# default admin password, can be changed before first start of grafana,  or in profile settings
+;admin_password = admin
+
+# used for signing
+;secret_key = SW2YcwTIb9zpOOhoPsMm
+
+# current key provider used for envelope encryption, default to static value specified by secret_key
+;encryption_provider = secretKey
+
+# list of configured key providers, space separated (Enterprise only): e.g., awskms.v1 azurekv.v1
+;available_encryption_providers =
+
+# disable gravatar profile images
+;disable_gravatar = false
+
+# data source proxy whitelist (ip_or_domain:port separated by spaces)
+;data_source_proxy_whitelist =
+
+# disable protection against brute force login attempts
+;disable_brute_force_login_protection = false
+
+# set to true if you host Grafana behind HTTPS. default is false.
+;cookie_secure = false
+
+# set cookie SameSite attribute. defaults to `lax`. can be set to "lax", "strict", "none" and "disabled"
+;cookie_samesite = lax
+
+# set to true if you want to allow browsers to render Grafana in a <frame>, <iframe>, <embed> or <object>. default is false.
+allow_embedding = true
+
+# Set to true if you want to enable http strict transport security (HSTS) response header.
+# This is only sent when HTTPS is enabled in this configuration.
+# HSTS tells browsers that the site should only be accessed using HTTPS.
+;strict_transport_security = false
+
+# Sets how long a browser should cache HSTS. Only applied if strict_transport_security is enabled.
+;strict_transport_security_max_age_seconds = 86400
+
+# Set to true if to enable HSTS preloading option. Only applied if strict_transport_security is enabled.
+;strict_transport_security_preload = false
+
+# Set to true if to enable the HSTS includeSubDomains option. Only applied if strict_transport_security is enabled.
+;strict_transport_security_subdomains = false
+
+# Set to true to enable the X-Content-Type-Options response header.
+# The X-Content-Type-Options response HTTP header is a marker used by the server to indicate that the MIME types advertised
+# in the Content-Type headers should not be changed and be followed.
+;x_content_type_options = true
+
+# Set to true to enable the X-XSS-Protection header, which tells browsers to stop pages from loading
+# when they detect reflected cross-site scripting (XSS) attacks.
+;x_xss_protection = true
+
+# Enable adding the Content-Security-Policy header to your requests.
+# CSP allows to control resources the user agent is allowed to load and helps prevent XSS attacks.
+;content_security_policy = false
+
+# Set Content Security Policy template used when adding the Content-Security-Policy header to your requests.
+# $NONCE in the template includes a random nonce.
+# $ROOT_PATH is server.root_url without the protocol.
+;content_security_policy_template = """script-src 'self' 'unsafe-eval' 'unsafe-inline' 'strict-dynamic' $NONCE;object-src 'none';font-src 'self';style-src 'self' 'unsafe-inline' blob:;img-src * data:;base-uri 'self';connect-src 'self' grafana.com ws://$ROOT_PATH wss://$ROOT_PATH;manifest-src 'self';media-src 'none';form-action 'self';"""
+
+#################################### Snapshots ###########################
+[snapshots]
+# snapshot sharing options
+;external_enabled = true
+;external_snapshot_url = https://snapshots-origin.raintank.io
+;external_snapshot_name = Publish to snapshot.raintank.io
+
+# Set to true to enable this Grafana instance act as an external snapshot server and allow unauthenticated requests for
+# creating and deleting snapshots.
+;public_mode = false
+
+# remove expired snapshot
+;snapshot_remove_expired = true
+
+#################################### Dashboards History ##################
+[dashboards]
+# Number dashboard versions to keep (per dashboard). Default: 20, Minimum: 1
+;versions_to_keep = 20
+
+# Minimum dashboard refresh interval. When set, this will restrict users to set the refresh interval of a dashboard lower than given interval. Per default this is 5 seconds.
+# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
+;min_refresh_interval = 5s
+
+# Path to the default home dashboard. If this value is empty, then Grafana uses StaticRootPath + "dashboards/home.json"
+;default_home_dashboard_path =
+
+#################################### Users ###############################
+[users]
+# disable user signup / registration
+;allow_sign_up = true
+
+# Allow non admin users to create organizations
+;allow_org_create = true
+
+# Set to true to automatically assign new users to the default organization (id 1)
+;auto_assign_org = true
+
+# Set this value to automatically add new users to the provided organization (if auto_assign_org above is set to true)
+;auto_assign_org_id = 1
+
+# Default role new users will be automatically assigned (if disabled above is set to true)
+;auto_assign_org_role = Viewer
+
+# Require email validation before sign up completes
+;verify_email_enabled = false
+
+# Background text for the user field on the login page
+;login_hint = email or username
+;password_hint = password
+
+# Default UI theme ("dark" or "light")
+;default_theme = dark
+
+# Path to a custom home page. Users are only redirected to this if the default home dashboard is used. It should match a frontend route and contain a leading slash.
+; home_page =
+
+# External user management, these options affect the organization users view
+;external_manage_link_url =
+;external_manage_link_name =
+;external_manage_info =
+
+# Viewers can edit/inspect dashboard settings in the browser. But not save the dashboard.
+;viewers_can_edit = false
+
+# Editors can administrate dashboard, folders and teams they create
+;editors_can_admin = false
+
+# The duration in time a user invitation remains valid before expiring. This setting should be expressed as a duration. Examples: 6h (hours), 2d (days), 1w (week). Default is 24h (24 hours). The minimum supported duration is 15m (15 minutes).
+;user_invite_max_lifetime_duration = 24h
+
+# Enter a comma-separated list of users login to hide them in the Grafana UI. These users are shown to Grafana admins and themselves.
+; hidden_users =
+
+[auth]
+# Login cookie name
+;login_cookie_name = grafana_session
+
+# The maximum lifetime (duration) an authenticated user can be inactive before being required to login at next visit. Default is 7 days (7d). This setting should be expressed as a duration, e.g. 5m (minutes), 6h (hours), 10d (days), 2w (weeks), 1M (month). The lifetime resets at each successful token rotation.
+;login_maximum_inactive_lifetime_duration =
+
+# The maximum lifetime (duration) an authenticated user can be logged in since login time before being required to login. Default is 30 days (30d). This setting should be expressed as a duration, e.g. 5m (minutes), 6h (hours), 10d (days), 2w (weeks), 1M (month).
+;login_maximum_lifetime_duration =
+
+# How often should auth tokens be rotated for authenticated users when being active. The default is each 10 minutes.
+;token_rotation_interval_minutes = 10
+
+# Set to true to disable (hide) the login form, useful if you use OAuth, defaults to false
+;disable_login_form = false
+
+# Set to true to disable the sign out link in the side menu. Useful if you use auth.proxy or auth.jwt, defaults to false
+;disable_signout_menu = false
+
+# URL to redirect the user to after sign out
+;signout_redirect_url =
+
+# Set to true to attempt login with OAuth automatically, skipping the login screen.
+# This setting is ignored if multiple OAuth providers are configured.
+;oauth_auto_login = false
+
+# OAuth state max age cookie duration in seconds. Defaults to 600 seconds.
+;oauth_state_cookie_max_age = 600
+
+# limit of api_key seconds to live before expiration
+;api_key_max_seconds_to_live = -1
+
+# Set to true to enable SigV4 authentication option for HTTP-based datasources.
+;sigv4_auth_enabled = false
+
+#################################### Anonymous Auth ######################
+[auth.anonymous]
+# enable anonymous access
+enabled = true
+
+# specify organization name that should be used for unauthenticated users
+;org_name = Main Org.
+
+# specify role for unauthenticated users
+;org_role = Viewer
+
+# mask the Grafana version number for unauthenticated users
+;hide_version = false
+
+#################################### GitHub Auth ##########################
+[auth.github]
+;enabled = false
+;allow_sign_up = true
+;client_id = some_id
+;client_secret = some_secret
+;scopes = user:email,read:org
+;auth_url = https://github.com/login/oauth/authorize
+;token_url = https://github.com/login/oauth/access_token
+;api_url = https://api.github.com/user
+;allowed_domains =
+;team_ids =
+;allowed_organizations =
+
+#################################### GitLab Auth #########################
+[auth.gitlab]
+;enabled = false
+;allow_sign_up = true
+;client_id = some_id
+;client_secret = some_secret
+;scopes = api
+;auth_url = https://gitlab.com/oauth/authorize
+;token_url = https://gitlab.com/oauth/token
+;api_url = https://gitlab.com/api/v4
+;allowed_domains =
+;allowed_groups =
+
+#################################### Google Auth ##########################
+[auth.google]
+;enabled = false
+;allow_sign_up = true
+;client_id = some_client_id
+;client_secret = some_client_secret
+;scopes = https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email
+;auth_url = https://accounts.google.com/o/oauth2/auth
+;token_url = https://accounts.google.com/o/oauth2/token
+;api_url = https://www.googleapis.com/oauth2/v1/userinfo
+;allowed_domains =
+;hosted_domain =
+
+#################################### Grafana.com Auth ####################
+[auth.grafana_com]
+;enabled = false
+;allow_sign_up = true
+;client_id = some_id
+;client_secret = some_secret
+;scopes = user:email
+;allowed_organizations =
+
+#################################### Azure AD OAuth #######################
+[auth.azuread]
+;name = Azure AD
+;enabled = false
+;allow_sign_up = true
+;client_id = some_client_id
+;client_secret = some_client_secret
+;scopes = openid email profile
+;auth_url = https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/authorize
+;token_url = https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/token
+;allowed_domains =
+;allowed_groups =
+
+#################################### Okta OAuth #######################
+[auth.okta]
+;name = Okta
+;enabled = false
+;allow_sign_up = true
+;client_id = some_id
+;client_secret = some_secret
+;scopes = openid profile email groups
+;auth_url = https://<tenant-id>.okta.com/oauth2/v1/authorize
+;token_url = https://<tenant-id>.okta.com/oauth2/v1/token
+;api_url = https://<tenant-id>.okta.com/oauth2/v1/userinfo
+;allowed_domains =
+;allowed_groups =
+;role_attribute_path =
+;role_attribute_strict = false
+
+#################################### Generic OAuth ##########################
+[auth.generic_oauth]
+;enabled = false
+;name = OAuth
+;allow_sign_up = true
+;client_id = some_id
+;client_secret = some_secret
+;scopes = user:email,read:org
+;empty_scopes = false
+;email_attribute_name = email:primary
+;email_attribute_path =
+;login_attribute_path =
+;name_attribute_path =
+;id_token_attribute_name =
+;auth_url = https://foo.bar/login/oauth/authorize
+;token_url = https://foo.bar/login/oauth/access_token
+;api_url = https://foo.bar/user
+;teams_url =
+;allowed_domains =
+;team_ids =
+;allowed_organizations =
+;role_attribute_path =
+;role_attribute_strict = false
+;groups_attribute_path =
+;team_ids_attribute_path =
+;tls_skip_verify_insecure = false
+;tls_client_cert =
+;tls_client_key =
+;tls_client_ca =
+;use_pkce = false
+
+#################################### Basic Auth ##########################
+[auth.basic]
+;enabled = true
+
+#################################### Auth Proxy ##########################
+[auth.proxy]
+;enabled = false
+;header_name = X-WEBAUTH-USER
+;header_property = username
+;auto_sign_up = true
+;sync_ttl = 60
+;whitelist = 192.168.1.1, 192.168.2.1
+;headers = Email:X-User-Email, Name:X-User-Name
+# Read the auth proxy docs for details on what the setting below enables
+;enable_login_token = false
+
+#################################### Auth JWT ##########################
+[auth.jwt]
+;enabled = true
+;header_name = X-JWT-Assertion
+;email_claim = sub
+;username_claim = sub
+;jwk_set_url = https://foo.bar/.well-known/jwks.json
+;jwk_set_file = /path/to/jwks.json
+;cache_ttl = 60m
+;expected_claims = {"aud": ["foo", "bar"]}
+;key_file = /path/to/key/file
+
+#################################### Auth LDAP ##########################
+[auth.ldap]
+;enabled = false
+;config_file = /etc/grafana/ldap.toml
+;allow_sign_up = true
+
+# LDAP background sync (Enterprise only)
+# At 1 am every day
+;sync_cron = "0 0 1 * * *"
+;active_sync_enabled = true
+
+#################################### AWS ###########################
+[aws]
+# Enter a comma-separated list of allowed AWS authentication providers.
+# Options are: default (AWS SDK Default), keys (Access && secret key), credentials (Credentials field), ec2_iam_role (EC2 IAM Role)
+; allowed_auth_providers = default,keys,credentials
+
+# Allow AWS users to assume a role using temporary security credentials.
+# If true, assume role will be enabled for all AWS authentication providers that are specified in aws_auth_providers
+; assume_role_enabled = true
+
+#################################### Azure ###############################
+[azure]
+# Azure cloud environment where Grafana is hosted
+# Possible values are AzureCloud, AzureChinaCloud, AzureUSGovernment and AzureGermanCloud
+# Default value is AzureCloud (i.e. public cloud)
+;cloud = AzureCloud
+
+# Specifies whether Grafana hosted in Azure service with Managed Identity configured (e.g. Azure Virtual Machines instance)
+# If enabled, the managed identity can be used for authentication of Grafana in Azure services
+# Disabled by default, needs to be explicitly enabled
+;managed_identity_enabled = false
+
+# Client ID to use for user-assigned managed identity
+# Should be set for user-assigned identity and should be empty for system-assigned identity
+;managed_identity_client_id =
+
+#################################### SMTP / Emailing ##########################
+[smtp]
+;enabled = false
+;host = localhost:25
+;user =
+# If the password contains # or ; you have to wrap it with triple quotes. Ex """#password;"""
+;password =
+;cert_file =
+;key_file =
+;skip_verify = false
+;from_address = admin@grafana.localhost
+;from_name = Grafana
+# EHLO identity in SMTP dialog (defaults to instance_name)
+;ehlo_identity = dashboard.example.com
+# SMTP startTLS policy (defaults to 'OpportunisticStartTLS')
+;startTLS_policy = NoStartTLS
+
+[emails]
+;welcome_email_on_sign_up = false
+;templates_pattern = emails/*.html, emails/*.txt
+;content_types = text/html
+
+#################################### Logging ##########################
+[log]
+# Either "console", "file", "syslog". Default is console and  file
+# Use space to separate multiple modes, e.g. "console file"
+;mode = console file
+
+# Either "debug", "info", "warn", "error", "critical", default is "info"
+;level = info
+
+# optional settings to set different levels for specific loggers. Ex filters = sqlstore:debug
+;filters =
+
+# For "console" mode only
+[log.console]
+;level =
+
+# log line format, valid options are text, console and json
+;format = console
+
+# For "file" mode only
+[log.file]
+;level =
+
+# log line format, valid options are text, console and json
+;format = text
+
+# This enables automated log rotate(switch of following options), default is true
+;log_rotate = true
+
+# Max line number of single file, default is 1000000
+;max_lines = 1000000
+
+# Max size shift of single file, default is 28 means 1 << 28, 256MB
+;max_size_shift = 28
+
+# Segment log daily, default is true
+;daily_rotate = true
+
+# Expired days of log file(delete after max days), default is 7
+;max_days = 7
+
+[log.syslog]
+;level =
+
+# log line format, valid options are text, console and json
+;format = text
+
+# Syslog network type and address. This can be udp, tcp, or unix. If left blank, the default unix endpoints will be used.
+;network =
+;address =
+
+# Syslog facility. user, daemon and local0 through local7 are valid.
+;facility =
+
+# Syslog tag. By default, the process' argv[0] is used.
+;tag =
+
+[log.frontend]
+# Should Sentry javascript agent be initialized
+;enabled = false
+
+# Sentry DSN if you want to send events to Sentry.
+;sentry_dsn =
+
+# Custom HTTP endpoint to send events captured by the Sentry agent to. Default will log the events to stdout.
+;custom_endpoint = /log
+
+# Rate of events to be reported between 0 (none) and 1 (all), float
+;sample_rate = 1.0
+
+# Requests per second limit enforced an extended period, for Grafana backend log ingestion endpoint (/log).
+;log_endpoint_requests_per_second_limit = 3
+
+# Max requests accepted per short interval of time for Grafana backend log ingestion endpoint (/log).
+;log_endpoint_burst_limit = 15
+
+#################################### Usage Quotas ########################
+[quota]
+; enabled = false
+
+#### set quotas to -1 to make unlimited. ####
+# limit number of users per Org.
+; org_user = 10
+
+# limit number of dashboards per Org.
+; org_dashboard = 100
+
+# limit number of data_sources per Org.
+; org_data_source = 10
+
+# limit number of api_keys per Org.
+; org_api_key = 10
+
+# limit number of alerts per Org.
+;org_alert_rule = 100
+
+# limit number of orgs a user can create.
+; user_org = 10
+
+# Global limit of users.
+; global_user = -1
+
+# global limit of orgs.
+; global_org = -1
+
+# global limit of dashboards
+; global_dashboard = -1
+
+# global limit of api_keys
+; global_api_key = -1
+
+# global limit on number of logged in users.
+; global_session = -1
+
+# global limit of alerts
+;global_alert_rule = -1
+
+#################################### Unified Alerting ####################
+[unified_alerting]
+#Enable the Unified Alerting sub-system and interface. When enabled we'll migrate all of your alert rules and notification channels to the new system. New alert rules will be created and your notification channels will be converted into an Alertmanager configuration. Previous data is preserved to enable backwards compatibility but new data is removed.```
+;enabled = true
+
+# Comma-separated list of organization IDs for which to disable unified alerting. Only supported if unified alerting is enabled.
+;disabled_orgs =
+
+# Specify the frequency of polling for admin config changes.
+# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
+;admin_config_poll_interval = 60s
+
+# Specify the frequency of polling for Alertmanager config changes.
+# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
+;alertmanager_config_poll_interval = 60s
+
+# Listen address/hostname and port to receive unified alerting messages for other Grafana instances. The port is used for both TCP and UDP. It is assumed other Grafana instances are also running on the same port. The default value is `0.0.0.0:9094`.
+;ha_listen_address = "0.0.0.0:9094"
+
+# Listen address/hostname and port to receive unified alerting messages for other Grafana instances. The port is used for both TCP and UDP. It is assumed other Grafana instances are also running on the same port. The default value is `0.0.0.0:9094`.
+;ha_advertise_address = ""
+
+# Comma-separated list of initial instances (in a format of host:port) that will form the HA cluster. Configuring this setting will enable High Availability mode for alerting.
+;ha_peers = ""
+
+# Time to wait for an instance to send a notification via the Alertmanager. In HA, each Grafana instance will
+# be assigned a position (e.g. 0, 1). We then multiply this position with the timeout to indicate how long should
+# each instance wait before sending the notification to take into account replication lag.
+# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
+;ha_peer_timeout = "15s"
+
+# The interval between sending gossip messages. By lowering this value (more frequent) gossip messages are propagated
+# across cluster more quickly at the expense of increased bandwidth usage.
+# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
+;ha_gossip_interval = "200ms"
+
+# The interval between gossip full state syncs. Setting this interval lower (more frequent) will increase convergence speeds
+# across larger clusters at the expense of increased bandwidth usage.
+# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
+;ha_push_pull_interval = "60s"
+
+# Enable or disable alerting rule execution. The alerting UI remains visible. This option has a legacy version in the `[alerting]` section that takes precedence.
+;execute_alerts = true
+
+# Alert evaluation timeout when fetching data from the datasource. This option has a legacy version in the `[alerting]` section that takes precedence.
+# The timeout string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
+;evaluation_timeout = 30s
+
+# Number of times we'll attempt to evaluate an alert rule before giving up on that evaluation. This option has a legacy version in the `[alerting]` section that takes precedence.
+;max_attempts = 3
+
+# Minimum interval to enforce between rule evaluations. Rules will be adjusted if they are less than this value  or if they are not multiple of the scheduler interval (10s). Higher values can help with resource management as we'll schedule fewer evaluations over time. This option has a legacy version in the `[alerting]` section that takes precedence.
+# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
+;min_interval = 10s
+
+#################################### Alerting ############################
+[alerting]
+# Disable legacy alerting engine & UI features
+;enabled = false
+
+# Makes it possible to turn off alert execution but alerting UI is visible
+;execute_alerts = true
+
+# Default setting for new alert rules. Defaults to categorize error and timeouts as alerting. (alerting, keep_state)
+;error_or_timeout = alerting
+
+# Default setting for how Grafana handles nodata or null values in alerting. (alerting, no_data, keep_state, ok)
+;nodata_or_nullvalues = no_data
+
+# Alert notifications can include images, but rendering many images at the same time can overload the server
+# This limit will protect the server from render overloading and make sure notifications are sent out quickly
+;concurrent_render_limit = 5
+
+# Default setting for alert calculation timeout. Default value is 30
+;evaluation_timeout_seconds = 30
+
+# Default setting for alert notification timeout. Default value is 30
+;notification_timeout_seconds = 30
+
+# Default setting for max attempts to sending alert notifications. Default value is 3
+;max_attempts = 3
+
+# Makes it possible to enforce a minimal interval between evaluations, to reduce load on the backend
+;min_interval_seconds = 1
+
+# Configures for how long alert annotations are stored. Default is 0, which keeps them forever.
+# This setting should be expressed as a duration. Examples: 6h (hours), 10d (days), 2w (weeks), 1M (month).
+;max_annotation_age =
+
+# Configures max number of alert annotations that Grafana stores. Default value is 0, which keeps all alert annotations.
+;max_annotations_to_keep =
+
+#################################### Annotations #########################
+[annotations]
+# Configures the batch size for the annotation clean-up job. This setting is used for dashboard, API, and alert annotations.
+;cleanupjob_batchsize = 100
+
+[annotations.dashboard]
+# Dashboard annotations means that annotations are associated with the dashboard they are created on.
+
+# Configures how long dashboard annotations are stored. Default is 0, which keeps them forever.
+# This setting should be expressed as a duration. Examples: 6h (hours), 10d (days), 2w (weeks), 1M (month).
+;max_age =
+
+# Configures max number of dashboard annotations that Grafana stores. Default value is 0, which keeps all dashboard annotations.
+;max_annotations_to_keep =
+
+[annotations.api]
+# API annotations means that the annotations have been created using the API without any
+# association with a dashboard.
+
+# Configures how long Grafana stores API annotations. Default is 0, which keeps them forever.
+# This setting should be expressed as a duration. Examples: 6h (hours), 10d (days), 2w (weeks), 1M (month).
+;max_age =
+
+# Configures max number of API annotations that Grafana keeps. Default value is 0, which keeps all API annotations.
+;max_annotations_to_keep =
+
+#################################### Explore #############################
+[explore]
+# Enable the Explore section
+;enabled = true
+
+#################################### Internal Grafana Metrics ##########################
+# Metrics available at HTTP API Url /metrics
+[metrics]
+# Disable / Enable internal metrics
+;enabled           = true
+# Graphite Publish interval
+;interval_seconds  = 10
+# Disable total stats (stat_totals_*) metrics to be generated
+;disable_total_stats = false
+
+#If both are set, basic auth will be required for the metrics endpoint.
+; basic_auth_username =
+; basic_auth_password =
+
+# Metrics environment info adds dimensions to the `grafana_environment_info` metric, which
+# can expose more information about the Grafana instance.
+[metrics.environment_info]
+#exampleLabel1 = exampleValue1
+#exampleLabel2 = exampleValue2
+
+# Send internal metrics to Graphite
+[metrics.graphite]
+# Enable by setting the address setting (ex localhost:2003)
+;address =
+;prefix = prod.grafana.%(instance_name)s.
+
+#################################### Grafana.com integration  ##########################
+# Url used to import dashboards directly from Grafana.com
+[grafana_com]
+;url = https://grafana.com
+
+#################################### Distributed tracing ############
+[tracing.jaeger]
+# Enable by setting the address sending traces to jaeger (ex localhost:6831)
+;address = localhost:6831
+# Tag that will always be included in when creating new spans. ex (tag1:value1,tag2:value2)
+;always_included_tag = tag1:value1
+# Type specifies the type of the sampler: const, probabilistic, rateLimiting, or remote
+;sampler_type = const
+# jaeger samplerconfig param
+# for "const" sampler, 0 or 1 for always false/true respectively
+# for "probabilistic" sampler, a probability between 0 and 1
+# for "rateLimiting" sampler, the number of spans per second
+# for "remote" sampler, param is the same as for "probabilistic"
+# and indicates the initial sampling rate before the actual one
+# is received from the mothership
+;sampler_param = 1
+# sampling_server_url is the URL of a sampling manager providing a sampling strategy.
+;sampling_server_url =
+# Whether or not to use Zipkin propagation (x-b3- HTTP headers).
+;zipkin_propagation = false
+# Setting this to true disables shared RPC spans.
+# Not disabling is the most common setting when using Zipkin elsewhere in your infrastructure.
+;disable_shared_zipkin_spans = false
+
+#################################### External image storage ##########################
+[external_image_storage]
+# Used for uploading images to public servers so they can be included in slack/email messages.
+# you can choose between (s3, webdav, gcs, azure_blob, local)
+;provider =
+
+[external_image_storage.s3]
+;endpoint =
+;path_style_access =
+;bucket =
+;region =
+;path =
+;access_key =
+;secret_key =
+
+[external_image_storage.webdav]
+;url =
+;public_url =
+;username =
+;password =
+
+[external_image_storage.gcs]
+;key_file =
+;bucket =
+;path =
+
+[external_image_storage.azure_blob]
+;account_name =
+;account_key =
+;container_name =
+
+[external_image_storage.local]
+# does not require any configuration
+
+[rendering]
+# Options to configure a remote HTTP image rendering service, e.g. using https://github.com/grafana/grafana-image-renderer.
+# URL to a remote HTTP image renderer service, e.g. http://localhost:8081/render, will enable Grafana to render panels and dashboards to PNG-images using HTTP requests to an external service.
+;server_url =
+# If the remote HTTP image renderer service runs on a different server than the Grafana server you may have to configure this to a URL where Grafana is reachable, e.g. http://grafana.domain/.
+;callback_url =
+# Concurrent render request limit affects when the /render HTTP endpoint is used. Rendering many images at the same time can overload the server,
+# which this setting can help protect against by only allowing a certain amount of concurrent requests.
+;concurrent_render_request_limit = 30
+
+[panels]
+# If set to true Grafana will allow script tags in text panels. Not recommended as it enable XSS vulnerabilities.
+;disable_sanitize_html = false
+
+[plugins]
+;enable_alpha = false
+;app_tls_skip_verify_insecure = false
+# Enter a comma-separated list of plugin identifiers to identify plugins to load even if they are unsigned. Plugins with modified signatures are never loaded.
+;allow_loading_unsigned_plugins =
+# Enable or disable installing / uninstalling / updating plugins directly from within Grafana.
+;plugin_admin_enabled = false
+;plugin_admin_external_manage_enabled = false
+;plugin_catalog_url = https://grafana.com/grafana/plugins/
+# Enter a comma-separated list of plugin identifiers to hide in the plugin catalog.
+;plugin_catalog_hidden_plugins =
+
+#################################### Grafana Live ##########################################
+[live]
+# max_connections to Grafana Live WebSocket endpoint per Grafana server instance. See Grafana Live docs
+# if you are planning to make it higher than default 100 since this can require some OS and infrastructure
+# tuning. 0 disables Live, -1 means unlimited connections.
+;max_connections = 100
+
+# allowed_origins is a comma-separated list of origins that can establish connection with Grafana Live.
+# If not set then origin will be matched over root_url. Supports wildcard symbol "*".
+;allowed_origins =
+
+# engine defines an HA (high availability) engine to use for Grafana Live. By default no engine used - in
+# this case Live features work only on a single Grafana server. Available options: "redis".
+# Setting ha_engine is an EXPERIMENTAL feature.
+;ha_engine =
+
+# ha_engine_address sets a connection address for Live HA engine. Depending on engine type address format can differ.
+# For now we only support Redis connection address in "host:port" format.
+# This option is EXPERIMENTAL.
+;ha_engine_address = "127.0.0.1:6379"
+
+#################################### Grafana Image Renderer Plugin ##########################
+[plugin.grafana-image-renderer]
+# Instruct headless browser instance to use a default timezone when not provided by Grafana, e.g. when rendering panel image of alert.
+# See ICU’s metaZones.txt (https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt) for a list of supported
+# timezone IDs. Fallbacks to TZ environment variable if not set.
+;rendering_timezone =
+
+# Instruct headless browser instance to use a default language when not provided by Grafana, e.g. when rendering panel image of alert.
+# Please refer to the HTTP header Accept-Language to understand how to format this value, e.g. 'fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5'.
+;rendering_language =
+
+# Instruct headless browser instance to use a default device scale factor when not provided by Grafana, e.g. when rendering panel image of alert.
+# Default is 1. Using a higher value will produce more detailed images (higher DPI), but will require more disk space to store an image.
+;rendering_viewport_device_scale_factor =
+
+# Instruct headless browser instance whether to ignore HTTPS errors during navigation. Per default HTTPS errors are not ignored. Due to
+# the security risk it's not recommended to ignore HTTPS errors.
+;rendering_ignore_https_errors =
+
+# Instruct headless browser instance whether to capture and log verbose information when rendering an image. Default is false and will
+# only capture and log error messages. When enabled, debug messages are captured and logged as well.
+# For the verbose information to be included in the Grafana server log you have to adjust the rendering log level to debug, configure
+# [log].filter = rendering:debug.
+;rendering_verbose_logging =
+
+# Instruct headless browser instance whether to output its debug and error messages into running process of remote rendering service.
+# Default is false. This can be useful to enable (true) when troubleshooting.
+;rendering_dumpio =
+
+# Additional arguments to pass to the headless browser instance. Default is --no-sandbox. The list of Chromium flags can be found
+# here (https://peter.sh/experiments/chromium-command-line-switches/). Multiple arguments is separated with comma-character.
+;rendering_args =
+
+# You can configure the plugin to use a different browser binary instead of the pre-packaged version of Chromium.
+# Please note that this is not recommended, since you may encounter problems if the installed version of Chrome/Chromium is not
+# compatible with the plugin.
+;rendering_chrome_bin =
+
+# Instruct how headless browser instances are created. Default is 'default' and will create a new browser instance on each request.
+# Mode 'clustered' will make sure that only a maximum of browsers/incognito pages can execute concurrently.
+# Mode 'reusable' will have one browser instance and will create a new incognito page on each request.
+;rendering_mode =
+
+# When rendering_mode = clustered, you can instruct how many browsers or incognito pages can execute concurrently. Default is 'browser'
+# and will cluster using browser instances.
+# Mode 'context' will cluster using incognito pages.
+;rendering_clustering_mode =
+# When rendering_mode = clustered, you can define the maximum number of browser instances/incognito pages that can execute concurrently. Default is '5'.
+;rendering_clustering_max_concurrency =
+# When rendering_mode = clustered, you can specify the duration a rendering request can take before it will time out. Default is `30` seconds.
+;rendering_clustering_timeout =
+
+# Limit the maximum viewport width, height and device scale factor that can be requested.
+;rendering_viewport_max_width =
+;rendering_viewport_max_height =
+;rendering_viewport_max_device_scale_factor =
+
+# Change the listening host and port of the gRPC server. Default host is 127.0.0.1 and default port is 0 and will automatically assign
+# a port not in use.
+;grpc_host =
+;grpc_port =
+
+[enterprise]
+# Path to a valid Grafana Enterprise license.jwt file
+;license_path =
+
+[feature_toggles]
+# enable features, separated by spaces
+;enable =
+
+[date_formats]
+# For information on what formatting patterns that are supported https://momentjs.com/docs/#/displaying/
+
+# Default system date format used in time range picker and other places where full time is displayed
+;full_date = YYYY-MM-DD HH:mm:ss
+
+# Used by graph and other places where we only show small intervals
+;interval_second = HH:mm:ss
+;interval_minute = HH:mm
+;interval_hour = MM/DD HH:mm
+;interval_day = MM/DD
+;interval_month = YYYY-MM
+;interval_year = YYYY
+
+# Experimental feature
+;use_browser_locale = false
+
+# Default timezone for user preferences. Options are 'browser' for the browser local timezone or a timezone name from IANA Time Zone database, e.g. 'UTC' or 'Europe/Amsterdam' etc.
+;default_timezone = browser
+
+[expressions]
+# Enable or disable the expressions functionality.
+;enabled = true
+
+[geomap]
+# Set the JSON configuration for the default basemap
+;default_baselayer_config = `{
+;  "type": "xyz",
+;  "config": {
+;    "attribution": "Open street map",
+;    "url": "https://tile.openstreetmap.org/{z}/{x}/{y}.png"
+;  }
+;}`
+
+# Enable or disable loading other base map layers
+;enable_custom_baselayers = true
-- 
2.39.5


From bd7d2560045d9aebfeb0c7c2b08067e093f588e1 Mon Sep 17 00:00:00 2001
From: Thomas Basler <thomas@familie-basler.net>
Date: Thu, 3 Oct 2024 01:04:54 +0200
Subject: [PATCH 13/13] homeassistant: Add installation procedures for nginx

---
 host_vars/lasagne.binary.kitchen       |  3 ++
 roles/homeassistant/handlers/main.yml  |  5 ++++
 roles/homeassistant/meta/main.yml      |  1 +
 roles/homeassistant/tasks/main.yml     |  1 +
 roles/homeassistant/tasks/nginx.yml    | 15 ++++++++++
 roles/homeassistant/templates/vhost.j2 | 41 ++++++++++++++++++++++++++
 6 files changed, 66 insertions(+)
 create mode 100644 roles/homeassistant/tasks/nginx.yml
 create mode 100644 roles/homeassistant/templates/vhost.j2

diff --git a/host_vars/lasagne.binary.kitchen b/host_vars/lasagne.binary.kitchen
index 52b25cf..d4bbc05 100644
--- a/host_vars/lasagne.binary.kitchen
+++ b/host_vars/lasagne.binary.kitchen
@@ -43,3 +43,6 @@ pgadmin4_db_password: "{{ vault_pgadmin4_db_password }}"
 pgadmin4_initial_user_email: noby@binary-kitchen.de
 pgadmin4_initial_user_password: "{{ vault_pgadmin4_initial_user_password }}"
 ha_pg_grafana_db_pass: "{{ vault_ha_pg_grafana_db_pass }}"
+
+ha_domains:
+  - lasagne.binary.kitchen
diff --git a/roles/homeassistant/handlers/main.yml b/roles/homeassistant/handlers/main.yml
index 6728c1d..b3e8144 100644
--- a/roles/homeassistant/handlers/main.yml
+++ b/roles/homeassistant/handlers/main.yml
@@ -14,3 +14,8 @@
   ansible.builtin.service:
     name: grafana-server
     state: restarted
+
+- name: Restart nginx
+  ansible.builtin.service:
+    name: nginx
+    state: restarted
diff --git a/roles/homeassistant/meta/main.yml b/roles/homeassistant/meta/main.yml
index 9b650cd..cb90fe0 100644
--- a/roles/homeassistant/meta/main.yml
+++ b/roles/homeassistant/meta/main.yml
@@ -11,3 +11,4 @@ galaxy_info:
 dependencies:
   - { role: mosquitto }
   - { role: pgadmin4 }
+  - { role: nginx, nginx_ssl: false }
diff --git a/roles/homeassistant/tasks/main.yml b/roles/homeassistant/tasks/main.yml
index 7259630..7e387e1 100644
--- a/roles/homeassistant/tasks/main.yml
+++ b/roles/homeassistant/tasks/main.yml
@@ -12,3 +12,4 @@
     - systemd.yml
     - installation.yml
     - grafana.yml
+    - nginx.yml
diff --git a/roles/homeassistant/tasks/nginx.yml b/roles/homeassistant/tasks/nginx.yml
new file mode 100644
index 0000000..62d5179
--- /dev/null
+++ b/roles/homeassistant/tasks/nginx.yml
@@ -0,0 +1,15 @@
+---
+
+- name: Configure vhost
+  ansible.builtin.template:
+    src: vhost.j2
+    dest: /etc/nginx/sites-available/homeassistant
+    mode: "0644"
+  notify: Restart nginx
+
+- name: Enable vhost
+  ansible.builtin.file:
+    src: /etc/nginx/sites-available/homeassistant
+    dest: /etc/nginx/sites-enabled/homeassistant
+    state: link
+  notify: Restart nginx
diff --git a/roles/homeassistant/templates/vhost.j2 b/roles/homeassistant/templates/vhost.j2
new file mode 100644
index 0000000..ba005bb
--- /dev/null
+++ b/roles/homeassistant/templates/vhost.j2
@@ -0,0 +1,41 @@
+{{ ansible_managed | comment }}
+
+server {
+        listen 80;
+        listen [::]:80;
+        server_name {{ ha_domains | join(' ') }};
+
+        proxy_buffering off;
+
+        location / {
+                proxy_pass http://127.0.0.1:8123;
+                proxy_set_header Host $host;
+                proxy_redirect http:// https://;
+                proxy_http_version 1.1;
+                proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+                proxy_set_header Upgrade $http_upgrade;
+                proxy_set_header Connection "upgrade";
+        }
+
+        location /api/websocket {
+                proxy_pass http://127.0.0.1:8123;
+                proxy_set_header Host $host;
+                proxy_http_version 1.1;
+                proxy_set_header Upgrade $http_upgrade;
+                proxy_set_header Connection "upgrade";
+        }
+
+        location /grafana {
+                client_max_body_size 1024M;
+                proxy_set_header X-Real-IP $remote_addr;
+                proxy_set_header Host $http_host;
+                proxy_pass http://localhost:3000;
+        }
+
+        location = /pgadmin4 { rewrite ^ /pgadmin4/; }
+        location /pgadmin4 { try_files $uri @pgadmin4; }
+        location @pgadmin4 {
+                include uwsgi_params;
+                uwsgi_pass unix:/run/pgadmin4/pgadmin4.sock;
+        }
+}
\ No newline at end of file
-- 
2.39.5