chore: base config and deployment for role homarr

roles/homarr/README.md

@@ -0,0 +1,38 @@
+Role Name
+=========
+
+A brief description of the role goes here.
+
+Requirements
+------------
+
+Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+
+Role Variables
+--------------
+
+A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+
+Dependencies
+------------
+
+A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+
+Example Playbook
+----------------
+
+Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
+
+    - hosts: servers
+      roles:
+         - { role: username.rolename, x: 42 }
+
+License
+-------
+
+BSD
+
+Author Information
+------------------
+
+An optional section for the role authors to include contact information, or a website (HTML is not allowed).

roles/homarr/defaults/main.yml

@@ -0,0 +1,23 @@
+#SPDX-License-Identifier: MIT-0
+---
+# defaults file for homarr
+
+# Base directory configuration (inherited from base role or defined here)
+docker_compose_base_dir: /etc/docker/compose
+docker_volume_base_dir: /srv/data
+
+# homarr-specific configuration
+homarr_service_name: homarr
+homarr_docker_compose_dir: "{{ docker_compose_base_dir }}/{{ homarr_service_name }}"
+homarr_docker_volume_dir: "{{ docker_volume_base_dir }}/{{ homarr_service_name }}"
+
+# Service configuration
+homarr_domain: "homarr.local.test"
+homarr_image: "ghcr.io/homarr-labs/homarr:latest"
+homarr_secret_encription_key: "CHANGE_ME"
+homarr_port: 7575
+homarr_use_docker: false
+
+# Traefik configuration
+homarr_traefik_network: "proxy"
+homarr_use_ssl: true

roles/homarr/handlers/main.yml

@@ -0,0 +1,3 @@
+#SPDX-License-Identifier: MIT-0
+---
+# handlers file for homarr

roles/homarr/meta/main.yml

@@ -0,0 +1,35 @@
+#SPDX-License-Identifier: MIT-0
+galaxy_info:
+  author: your name
+  description: your role description
+  company: your company (optional)
+
+  # If the issue tracker for your role is not on github, uncomment the
+  # next line and provide a value
+  # issue_tracker_url: http://example.com/issue/tracker
+
+  # Choose a valid license ID from https://spdx.org - some suggested licenses:
+  # - BSD-3-Clause (default)
+  # - MIT
+  # - GPL-2.0-or-later
+  # - GPL-3.0-only
+  # - Apache-2.0
+  # - CC-BY-4.0
+  license: license (GPL-2.0-or-later, MIT, etc)
+
+  min_ansible_version: 2.2
+
+  # If this a Container Enabled role, provide the minimum Ansible Container version.
+  # min_ansible_container_version:
+
+  galaxy_tags: []
+    # List tags for your role here, one per line. A tag is a keyword that describes
+    # and categorizes the role. Users find roles by searching for tags. Be sure to
+    # remove the '[]' above, if you add tags to this list.
+    #
+    # NOTE: A tag is limited to a single word comprised of alphanumeric characters.
+    #       Maximum 20 tags per role.
+
+dependencies: []
+  # List your role dependencies here, one per line. Be sure to remove the '[]' above,
+  # if you add dependencies to this list.

roles/homarr/tasks/main.yml

@@ -0,0 +1,19 @@
+#SPDX-License-Identifier: MIT-0
+---
+# tasks file for homarr
+- name: Create docker compose directory
+  file:
+    path: "{{ homarr_docker_compose_dir }}"
+    state: directory
+    mode: '0755'
+
+- name: Create docker-compose file for homarr
+  template:
+    src: docker-compose.yml.j2
+    dest: "{{ homarr_docker_compose_dir }}/docker-compose.yml"
+    mode: '0644'
+
+- name: Start homarr containers
+  community.docker.docker_compose_v2:
+    project_src: "{{ homarr_docker_compose_dir }}"
+    state: present

roles/homarr/templates/docker-compose.yml.j2

@@ -0,0 +1,31 @@
+#---------------------------------------------------------------------#
+#     Homarr - A simple, yet powerful dashboard for your server.      #
+#---------------------------------------------------------------------#
+services:
+  homarr:
+    container_name: {{ homarr_service_name }}
+    image: {{ homarr_image }}
+    restart: unless-stopped
+    volumes:
+{% if homarr_use_docker %}
+      - /var/run/docker.sock:/var/run/docker.sock # Optional, only if you want docker integration
+{% endif %}
+      - {{ homarr_docker_volume_dir }}/homarr/appdata:/appdata
+    environment:
+      - SECRET_ENCRYPTION_KEY={{ homarr_secret_encryption_key }}
+    networks:
+      - {{ homarr_traefik_network }}
+    labels:
+      - traefik.enable=true
+      - traefik.docker.network={{ homarr_traefik_network }}
+      - traefik.http.routers.{{ homarr_service_name }}.rule=Host(`{{ homarr_domain }}`)
+{% if homarr_use_ssl %}
+      - traefik.http.routers.{{ homarr_service_name }}.entrypoints=websecure
+      - traefik.http.routers.{{ homarr_service_name }}.tls=true
+{% else %}
+      - traefik.http.routers.{{ homarr_service_name }}.entrypoints=web
+{% endif %}
+      - traefik.http.services.{{ homarr_service_name }}.loadbalancer.server.port={{ homarr_port }}
+networks:
+  {{ homarr_traefik_network }}:
+    external: true

roles/homarr/tests/inventory

@@ -0,0 +1,2 @@
+#SPDX-License-Identifier: MIT-0
+localhost

roles/homarr/tests/test.yml

@@ -0,0 +1,6 @@
+#SPDX-License-Identifier: MIT-0
+---
+- hosts: localhost
+  remote_user: root
+  roles:
+    - homarr

roles/homarr/vars/main.yml

@@ -0,0 +1,3 @@
+#SPDX-License-Identifier: MIT-0
+---
+# vars file for homarr

roles/traefik/defaults/main.yml

@@ -17,54 +17,62 @@ docker_volume_dir: "{{ docker_volume_base_dir }}/{{ service_name }}"
 traefik_mode: "backend"
 
 # SSL configuration
-use_ssl: true
+traefik_use_ssl: true
-ssl_email: "admin@example.com"
+traefik_ssl_email: "admin@example.com"
-ssl_cert_resolver: "dns"  # Certificate resolver name
+traefik_ssl_cert_resolver: "dns"  # Certificate resolver name
 
 # Certificate mode: 'acme' for Let's Encrypt with DNS challenge or 'selfsigned' for self-signed certs
-cert_mode: "selfsigned"  # Use selfsigned for vagrant, acme for production
+traefik_cert_mode: "selfsigned"  # Use selfsigned for vagrant, acme for production
 
 # ACME DNS Challenge with RFC2136 (TSIG) configuration
-acme_dns_zone: ""  # e.g., "digitalboard._acme.digitalboard.ch."
+traefik_acme_dns_zone: ""  # e.g., "digitalboard._acme.digitalboard.ch."
-acme_dns_nameserver: ""  # e.g., "192.168.1.1:53"
+traefik_acme_dns_nameserver: ""  # e.g., "192.168.1.1:53"
-acme_tsig_algorithm: "hmac-sha256"
+traefik_acme_tsig_algorithm: "hmac-sha256"
-acme_tsig_key: ""  # TSIG key name
+traefik_acme_tsig_key: ""  # TSIG key name
-acme_tsig_secret: ""  # TSIG secret
+traefik_acme_tsig_secret: ""  # TSIG secret
-acme_propagation_timeout: "120"
+traefik_acme_propagation_timeout: "120"
-acme_polling_interval: "2"
+traefik_acme_polling_interval: "2"
-acme_ttl: "60"
+traefik_acme_ttl: "60"
 
 # Self-signed certificate configuration (for vagrant/testing)
-selfsigned_cert_dir: "{{ docker_volume_dir }}/certs"
+traefik_selfsigned_cert_dir: "{{ docker_volume_dir }}/certs"
-selfsigned_cert_days: 365
+traefik_selfsigned_cert_days: 365
-selfsigned_common_name: "*.local.test"
+traefik_selfsigned_common_name: "*.local.test"
 
 # Dashboard
-enable_dashboard: false
+traefik_enable_dashboard: false
-dashboard_domain: ""  # e.g., "traefik.local.test" - if set, exposes dashboard via hostname instead of port 8080
+traefik_dashboard_domain: ""  # e.g., "traefik.local.test" - if set, exposes dashboard via hostname instead of port 8080
 
 # Access log configuration
-enable_access_logs: true
+traefik_enable_access_logs: true
-access_log_format: "common"
+traefik_access_log_format: "common"
-log_level: "INFO"
+traefik_log_level: "INFO"
 
 # Network name
 traefik_network: "proxy"
 
-# Services to expose (defined by application roles via host_vars or group_vars)
+# Services to expose through DMZ (defined on backend servers via host_vars)
-# Each backend server should define this variable with their services
+# The DMZ proxy aggregates these from all backend_servers and auto-populates backend_host
-# traefik_services:
+# traefik_dmz_exposed_services:
 #   - name: httpbin
 #     domain: httpbin.example.com
 #     port: 8080
 #     protocol: http  # http or https
-#     entrypoints: [websecure]  # optional, defaults based on SSL config
+
+# Services to expose directly on the proxy (for hosts not managed by Ansible)
+# Define on the DMZ host itself - requires explicit backend_host
+# traefik_services:
+#   - name: external-api
+#     domain: api.example.com
+#     backend_host: 10.0.0.50  # required for direct definitions
+#     port: 8080
+#     protocol: http
 
 # DMZ mode: Explicit backend server mapping
 # Define which backend servers this DMZ proxy should route to
 # If empty or undefined, routes to all servers in backend_servers group
-backend_servers_to_proxy: []
+traefik_backend_servers_to_proxy: []
 # Example:
-# backend_servers_to_proxy:
+# traefik_backend_servers_to_proxy:
 #   - backend1
 #   - backend2

roles/traefik/tasks/main.yml

@@ -4,15 +4,20 @@
 
 - name: Determine which backend servers to proxy (DMZ mode)
   set_fact:
-    _backend_servers: "{{ backend_servers_to_proxy if backend_servers_to_proxy | length > 0 else groups['backend_servers'] | default([]) }}"
+    _backend_servers: "{{ traefik_backend_servers_to_proxy if traefik_backend_servers_to_proxy | length > 0 else groups['backend_servers'] | default([]) }}"
   when: traefik_mode == 'dmz'
 
 - name: Build service registry from backend servers (DMZ mode)
   set_fact:
-    proxied_services: "{{ proxied_services | default([]) + hostvars[item].traefik_services | default([]) | map('combine', {'backend_host': hostvars[item].ansible_host | default(item)}) | list }}"
+    proxied_services: "{{ proxied_services | default([]) + hostvars[item].traefik_dmz_exposed_services | default([]) | map('combine', {'backend_host': hostvars[item].ansible_host | default(item)}) | list }}"
   loop: "{{ _backend_servers | default([]) }}"
   when: traefik_mode == 'dmz'
 
+- name: Add directly defined services to registry (DMZ mode)
+  set_fact:
+    proxied_services: "{{ proxied_services | default([]) + traefik_services | default([]) }}"
+  when: traefik_mode == 'dmz'
+
 - name: Debug service registry
   debug:
     var: proxied_services
@@ -43,7 +48,7 @@
     path: "{{ docker_volume_dir }}/letsencrypt"
     state: directory
     mode: '0755'
-  when: cert_mode == 'acme'
+  when: traefik_cert_mode == 'acme'
 
 - name: Create traefik Docker network
   community.docker.docker_network:
@@ -71,14 +76,14 @@
     dest: "{{ docker_volume_dir }}/config/dashboard.yml"
     mode: '0644'
   notify: restart traefik
-  when: enable_dashboard | bool and dashboard_domain | length > 0
+  when: traefik_enable_dashboard | bool and traefik_dashboard_domain | length > 0
 
 - name: Remove dashboard routing configuration when not needed
   file:
     path: "{{ docker_volume_dir }}/config/dashboard.yml"
     state: absent
   notify: restart traefik
-  when: not (enable_dashboard | bool) or dashboard_domain | length == 0
+  when: not (traefik_enable_dashboard | bool) or traefik_dashboard_domain | length == 0
 
 - name: Create docker-compose file for traefik
   template:

roles/traefik/templates/dashboard.yml.j2

@@ -1,15 +1,15 @@
-{% set dashboard_ssl = use_ssl_dashboard | default(use_ssl) %}
+{% set dashboard_ssl = traefik_use_ssl_dashboard | default(traefik_use_ssl) %}
 http:
   routers:
     dashboard:
-      rule: "Host(`{{ dashboard_domain }}`)"
+      rule: "Host(`{{ traefik_dashboard_domain }}`)"
       service: api@internal
       entryPoints:
         - {{ 'websecure' if dashboard_ssl else 'web' }}
 {% if dashboard_ssl %}
       tls:
-{% if cert_mode == 'acme' %}
+{% if traefik_cert_mode == 'acme' %}
-        certResolver: {{ ssl_cert_resolver }}
+        certResolver: {{ traefik_ssl_cert_resolver }}
 {% else %}
         {}
 {% endif %}

roles/traefik/templates/docker-compose.yml.j2

@@ -3,26 +3,26 @@ services:
     image: traefik:latest
     container_name: traefik
     restart: always
-{% if cert_mode == 'acme' %}
+{% if traefik_cert_mode == 'acme' %}
     environment:
-      RFC2136_NAMESERVER: "{{ acme_dns_nameserver }}"
+      RFC2136_NAMESERVER: "{{ traefik_acme_dns_nameserver }}"
-      RFC2136_TSIG_ALGORITHM: "{{ acme_tsig_algorithm }}"
+      RFC2136_TSIG_ALGORITHM: "{{ traefik_acme_tsig_algorithm }}"
-      RFC2136_TSIG_KEY: "{{ acme_tsig_key }}"
+      RFC2136_TSIG_KEY: "{{ traefik_acme_tsig_key }}"
-      RFC2136_TSIG_SECRET: "{{ acme_tsig_secret }}"
+      RFC2136_TSIG_SECRET: "{{ traefik_acme_tsig_secret }}"
-      RFC2136_PROPAGATION_TIMEOUT: "{{ acme_propagation_timeout }}"
+      RFC2136_PROPAGATION_TIMEOUT: "{{ traefik_acme_propagation_timeout }}"
-      RFC2136_POLLING_INTERVAL: "{{ acme_polling_interval }}"
+      RFC2136_POLLING_INTERVAL: "{{ traefik_acme_polling_interval }}"
-      RFC2136_TTL: "{{ acme_ttl }}"
+      RFC2136_TTL: "{{ traefik_acme_ttl }}"
 {% endif %}
     ports:
       - "80:80"
       - "443:443"
-{% if enable_dashboard and not dashboard_domain %}
+{% if traefik_enable_dashboard and not traefik_dashboard_domain %}
       - "8080:8080"
 {% endif %}
     volumes:
       - {{ docker_volume_dir }}/traefik.yml:/traefik.yml:ro
       - {{ docker_volume_dir }}/config:/config:ro
-{% if cert_mode == 'acme' %}
+{% if traefik_cert_mode == 'acme' %}
       - {{ docker_volume_dir }}/letsencrypt:/letsencrypt
 {% endif %}
 {% if traefik_mode == 'backend' %}

roles/traefik/templates/middlewares.yml.j2

@@ -1,18 +1,18 @@
-{% if enable_dashboard %}
+{% if traefik_enable_dashboard %}
 api:
   dashboard: true
   insecure: true
 {% endif %}
 
-{% if enable_access_logs %}
+{% if traefik_enable_access_logs %}
 accessLog:
-  format: {{ access_log_format }}
+  format: {{ traefik_access_log_format }}
 {% endif %}
 
 entryPoints:
   web:
     address: ":80"
-{% if use_ssl %}
+{% if traefik_use_ssl %}
     http:
       redirections:
         entryPoint:

roles/traefik/templates/services.yml.j2

@@ -5,11 +5,11 @@ http:
       rule: "Host(`{{ service.domain }}`)"
       service: {{ service.name }}-service
       entryPoints:
-        - {{ 'websecure' if use_ssl else 'web' }}
+        - {{ 'websecure' if traefik_use_ssl else 'web' }}
-{% if use_ssl %}
+{% if traefik_use_ssl %}
       tls:
-{% if cert_mode == 'acme' %}
+{% if traefik_cert_mode == 'acme' %}
-        certResolver: {{ ssl_cert_resolver }}
+        certResolver: {{ traefik_ssl_cert_resolver }}
 {% else %}
         {}
 {% endif %}
@@ -23,12 +23,12 @@ http:
         passHostHeader: true
         servers:
           - url: "{{ service.protocol }}://{{ service.backend_host }}:{{ service.port }}"
-{% if service.protocol == 'https' and cert_mode == 'selfsigned' %}
+{% if service.protocol == 'https' and traefik_cert_mode == 'selfsigned' %}
         serversTransport: insecure-transport
 {% endif %}
 {% endfor %}
 
-{% if cert_mode == 'selfsigned' %}
+{% if traefik_cert_mode == 'selfsigned' %}
   serversTransports:
     insecure-transport:
       insecureSkipVerify: true

roles/traefik/templates/traefik.yml.j2

@@ -1,23 +1,23 @@
 log:
-  level: {{ log_level }}
+  level: {{ traefik_log_level }}
 
-{% if enable_dashboard %}
+{% if traefik_enable_dashboard %}
 api:
   dashboard: true
-{% if not dashboard_domain %}
+{% if not traefik_dashboard_domain %}
   insecure: true
 {% endif %}
 {% endif %}
 
-{% if enable_access_logs %}
+{% if traefik_enable_access_logs %}
 accessLog:
-  format: {{ access_log_format }}
+  format: {{ traefik_access_log_format }}
 {% endif %}
 
 entryPoints:
   web:
     address: ":80"
-{% if use_ssl %}
+{% if traefik_use_ssl %}
     http:
       redirections:
         entryPoint:
@@ -38,19 +38,19 @@ providers:
     exposedByDefault: false
 {% endif %}
 
-{% if use_ssl and cert_mode == 'acme' %}
+{% if traefik_use_ssl and traefik_cert_mode == 'acme' %}
 certificatesResolvers:
-  {{ ssl_cert_resolver }}:
+  {{ traefik_ssl_cert_resolver }}:
     acme:
-      email: {{ ssl_email }}
+      email: {{ traefik_ssl_email }}
       storage: /letsencrypt/acme.json
       dnsChallenge:
         provider: rfc2136
         resolvers:
-          - "{{ acme_dns_nameserver }}"
+          - "{{ traefik_acme_dns_nameserver }}"
 {% endif %}
 
-{% if use_ssl %}
+{% if traefik_use_ssl %}
 tls:
   options:
     default: