ChristianLempa_Boilerplates/library/compose/homepage/template.yaml

---
kind: compose
metadata:
  name: Homepage
  description: 'Homepage is a modern, fully static, fast, secure fully customizable application dashboard with integrations

    for over 100 services and translations into multiple languages.


    Project: https://gethomepage.dev/

    Documentation: https://gethomepage.dev/latest/

    GitHub: https://github.com/gethomepage/homepage'
  version: v1.8.0
  author: Christian Lempa
  date: '2025-12-12'
  tags:
    - traefik
    - swarm
    - volume_modes
  icon:
    provider: simpleicons
    id: homepage
  draft: true
  next_steps: ''
schema: '1.2'
spec:
  general:
    vars:
      service_name:
        description: The service name
        type: str
        required: true
        default: homepage
      container_name:
        description: The container name
        type: str
        default: homepage
      container_timezone:
        description: The container timezone
        type: str
      container_loglevel:
        description: The container log level
        type: enum
        options:
          - debug
          - info
          - warn
          - error
      restart_policy:
        description: The container restart policy
        type: enum
        options:
          - unless-stopped
          - always
          - on-failure
          - 'no'
        required: true
        default: unless-stopped
  ports:
    vars:
      ports_http:
        description: The HTTP port
        type: int
        needs:
          - traefik_enabled=false
        required: true
        default: 3000
  traefik:
    vars:
      traefik_enabled:
        type: bool
        default: false
        description: Enable Traefik integration
      traefik_entrypoint:
        description: The Traefik entrypoint
        type: str
        required: true
        default: web
      traefik_host:
        default: homepage
      traefik_network:
        default: traefik
        type: str
        required: true
      traefik_domain:
        default: home.arpa
        type: str
        required: true
  traefik_tls:
    vars:
      traefik_tls_enabled:
        description: Enable Traefik TLS
        type: bool
        default: false
      traefik_tls_entrypoint:
        description: The Traefik TLS entrypoint
        type: str
        default: websecure
        required: true
      traefik_tls_certresolver:
        type: str
        required: true
        default: cloudflare
  volume:
    vars:
      volume_mode:
        type: enum
        options:
          - local
          - mount
          - nfs
        default: local
        required: true
      volume_mount_path:
        type: str
        default: /mnt/storage
        needs:
          - volume_mode=mount
        required: true
      volume_nfs_options:
        type: str
        default: nfsvers=4,soft,timeo=180,intr
        description: The NFS mount options
      volume_nfs_path:
        type: str
        default: ''
        description: The NFS path
      volume_nfs_server:
        type: str
        default: ''
        description: The NFS server
  swarm:
    vars:
      swarm_enabled:
        description: Enable Docker Swarm mode
        type: bool
        default: false
      swarm_replicas:
        description: Number of replicas for replicated mode
        type: int
        needs:
          - swarm_enabled=true
          - swarm_placement_mode=replicated
        required: true
        default: 1
      swarm_placement_host:
        description: Hostname for placement constraint
        type: str
        needs:
          - swarm_enabled=true
          - swarm_placement_mode=replicated
      swarm_placement_mode:
        description: The placement mode
        type: str
        needs:
          - swarm_enabled=true
        default: replicated