ChristianLempa_Boilerplates/library/compose/homer/template.yaml

---
kind: compose
schema: "1.2"
metadata:
  icon:
    provider: selfh
    id: homer
  name: Homer
  description: >
    A very simple static homepage for your server to keep your services on hand, from a simple yaml configuration file.


    Project: https://github.com/bastienwirtz/homer

    Documentation: https://github.com/bastienwirtz/homer/blob/main/docs/configuration.md
  version: v25.11.1
  author: Christian Lempa
  date: '2025-12-11'
  tags:
    - traefik
    - swarm
    - authentik
  draft: true
  next_steps: |
    1. Start the Homer dashboard:
       docker compose up -d

    2. Customize your dashboard:
       - Edit assets/config.yml to add your services
       - Organize services into groups (Applications, Monitoring, etc.)
       - Add links to the navbar for quick access

    3. Optional: Add a logo:
       - Place your logo.png file in the assets/ directory
       - Or update the logo path in assets/config.yml
       - Supported formats: PNG, SVG, JPG

    4. Optional: Customize the theme:
       - Uncomment and modify the colors section in config.yml
       - Available themes: default, sui
       - See documentation for advanced theming options

    5. Access your dashboard:
       {% if traefik_enabled -%}
       - Via Traefik: https://{{ traefik_host }}
       {% if not traefik_enabled and network_mode == 'bridge' %}- Direct access: http://localhost:{{ ports_http }}{% endif %}
       {%- else -%}
       - Open http://localhost:{{ ports_http }} in your browser
       {%- endif %}

    For more information, visit: https://github.com/bastienwirtz/homer/blob/main/docs/configuration.md
spec:
  general:
    vars:
      service_name:
        default: "homer"
      container_name:
        default: "homer"
      homer_title:
        description: "Dashboard title"
        type: str
        default: "My Dashboard"
      homer_subtitle:
        description: "Dashboard subtitle"
        type: str
        default: "Homer"
      homer_logo:
        description: "Logo file path (relative to assets/)"
        type: str
        default: "logo.png"
  ports:
    vars:
      ports_http:
        description: "Host port for HTTP (8080)"
        type: int
        default: 8080
  traefik:
    vars:
      traefik_host:
        default: homer.home.arpa