Homarr¶

Description / name	Input element
Your domain name

Overview¶

Homarr is a simple and modern homepage for your server that helps you access all of your services in one place. It integrates with the services you use to display useful information or control them. It's easy to install and supports many different devices.

Manual

Releases

Community

Deployment¶

sb install sandbox-homarr

Usage¶

Visit https://homarr.iYOUR_DOMAIN_NAMEi.

Basics¶

Default login:

Password: your_normal_password

Documentation: Homarr Docs

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
homarr_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like homarr_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

Instead, use the corresponding _custom variable (like homarr_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsDocker Socket ProxyWebDNSTraefikDockerDocker+Global Override Options

homarr_name

# Type: string
homarr_name: homarr

homarr_role_docker_socket_proxy_envs

# Type: dict
homarr_role_docker_socket_proxy_envs:
  CONTAINERS: "1"
  POST: "0"

homarr_role_web_subdomain

# Type: string
homarr_role_web_subdomain: "{{ homarr_name }}"

homarr_role_web_domain

# Type: string
homarr_role_web_domain: "{{ user.domain }}"

homarr_role_web_port

# Type: string
homarr_role_web_port: "7575"

homarr_role_web_url

# Type: string
homarr_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='homarr') + '.' + lookup('role_var', '_web_domain', role='homarr')
                      if (lookup('role_var', '_web_subdomain', role='homarr') | length > 0)
                      else lookup('role_var', '_web_domain', role='homarr')) }}"

homarr_role_dns_record

# Type: string
homarr_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='homarr') }}"

homarr_role_dns_zone

# Type: string
homarr_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='homarr') }}"

homarr_role_dns_proxy

# Type: bool (true/false)
homarr_role_dns_proxy: "{{ dns_proxied }}"

homarr_role_traefik_sso_middleware

# Type: string
homarr_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

homarr_role_traefik_middleware_default

# Type: string
homarr_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

homarr_role_traefik_middleware_custom

# Type: string
homarr_role_traefik_middleware_custom: ""

homarr_role_traefik_certresolver

# Type: string
homarr_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

homarr_role_traefik_enabled

# Type: bool (true/false)
homarr_role_traefik_enabled: true

homarr_role_traefik_api_enabled

# Type: bool (true/false)
homarr_role_traefik_api_enabled: false

homarr_role_traefik_api_endpoint

# Type: string
homarr_role_traefik_api_endpoint: ""

Container

homarr_role_docker_container

# Type: string
homarr_role_docker_container: "{{ homarr_name }}"

Image

homarr_role_docker_image_pull

# Type: bool (true/false)
homarr_role_docker_image_pull: true

homarr_role_docker_image_repo

# Type: string
homarr_role_docker_image_repo: "ghcr.io/ajnart/homarr"

homarr_role_docker_image_tag

# Type: string
homarr_role_docker_image_tag: "latest"

homarr_role_docker_image

# Type: string
homarr_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='homarr') }}:{{ lookup('role_var', '_docker_image_tag', role='homarr') }}"

Envs

homarr_role_docker_envs_default

# Type: dict
homarr_role_docker_envs_default:
  TZ: "{{ tz }}"
  BASE_URL: "{{ lookup('role_var', '_web_subdomain', role='homarr') + '.' + lookup('role_var', '_web_domain', role='homarr') }}"
  PASSWORD: "{{ user.pass }}"
  DOCKER_HOST: "tcp://{{ homarr_name }}-docker-socket-proxy:2375"
  NODE_TLS_REJECT_UNAUTHORIZED: "0"

homarr_role_docker_envs_custom

# Type: dict
homarr_role_docker_envs_custom: {}

Volumes

homarr_role_docker_volumes_default

# Type: list
homarr_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='homarr') }}:/app/data/configs"
  - "{{ lookup('role_var', '_paths_location', role='homarr') }}/icons:/app/public/icons"

homarr_role_docker_volumes_custom

# Type: list
homarr_role_docker_volumes_custom: []

Hostname

homarr_role_docker_hostname

# Type: string
homarr_role_docker_hostname: "{{ homarr_name }}"

Networks

homarr_role_docker_networks_alias

# Type: string
homarr_role_docker_networks_alias: "{{ homarr_name }}"

homarr_role_docker_networks_default

# Type: list
homarr_role_docker_networks_default: []

homarr_role_docker_networks_custom

# Type: list
homarr_role_docker_networks_custom: []

Restart Policy

homarr_role_docker_restart_policy

# Type: string
homarr_role_docker_restart_policy: unless-stopped

State

homarr_role_docker_state

# Type: string
homarr_role_docker_state: started

Dependencies

homarr_role_depends_on

# Type: string
homarr_role_depends_on: "{{ homarr_name }}-docker-socket-proxy"

homarr_role_depends_on_delay

# Type: string (quoted number)
homarr_role_depends_on_delay: "0"

homarr_role_depends_on_healthchecks

# Type: string ("true"/"false")
homarr_role_depends_on_healthchecks: "false"

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

homarr_role_docker_blkio_weight

# Type: int
homarr_role_docker_blkio_weight:

homarr_role_docker_cpu_period

# Type: int
homarr_role_docker_cpu_period:

homarr_role_docker_cpu_quota

# Type: int
homarr_role_docker_cpu_quota:

homarr_role_docker_cpu_shares

# Type: int
homarr_role_docker_cpu_shares:

homarr_role_docker_cpus

# Type: string
homarr_role_docker_cpus:

homarr_role_docker_cpuset_cpus

# Type: string
homarr_role_docker_cpuset_cpus:

homarr_role_docker_cpuset_mems

# Type: string
homarr_role_docker_cpuset_mems:

homarr_role_docker_kernel_memory

# Type: string
homarr_role_docker_kernel_memory:

homarr_role_docker_memory

# Type: string
homarr_role_docker_memory:

homarr_role_docker_memory_reservation

# Type: string
homarr_role_docker_memory_reservation:

homarr_role_docker_memory_swap

# Type: string
homarr_role_docker_memory_swap:

homarr_role_docker_memory_swappiness

# Type: int
homarr_role_docker_memory_swappiness:

homarr_role_docker_shm_size

# Type: string
homarr_role_docker_shm_size:

Security & Devices

homarr_role_docker_cap_drop

# Type: list
homarr_role_docker_cap_drop:

homarr_role_docker_cgroupns_mode

# Type: string
homarr_role_docker_cgroupns_mode:

homarr_role_docker_device_cgroup_rules

# Type: list
homarr_role_docker_device_cgroup_rules:

homarr_role_docker_device_read_bps

# Type: list
homarr_role_docker_device_read_bps:

homarr_role_docker_device_read_iops

# Type: list
homarr_role_docker_device_read_iops:

homarr_role_docker_device_requests

# Type: list
homarr_role_docker_device_requests:

homarr_role_docker_device_write_bps

# Type: list
homarr_role_docker_device_write_bps:

homarr_role_docker_device_write_iops

# Type: list
homarr_role_docker_device_write_iops:

homarr_role_docker_devices

# Type: list
homarr_role_docker_devices:

homarr_role_docker_devices_default

# Type: string
homarr_role_docker_devices_default:

homarr_role_docker_groups

# Type: list
homarr_role_docker_groups:

homarr_role_docker_privileged

# Type: bool (true/false)
homarr_role_docker_privileged:

homarr_role_docker_security_opts

# Type: list
homarr_role_docker_security_opts:

homarr_role_docker_user

# Type: string
homarr_role_docker_user:

homarr_role_docker_userns_mode

# Type: string
homarr_role_docker_userns_mode:

Networking

homarr_role_docker_dns_opts

# Type: list
homarr_role_docker_dns_opts:

homarr_role_docker_dns_search_domains

# Type: list
homarr_role_docker_dns_search_domains:

homarr_role_docker_dns_servers

# Type: list
homarr_role_docker_dns_servers:

homarr_role_docker_domainname

# Type: string
homarr_role_docker_domainname:

homarr_role_docker_exposed_ports

# Type: list
homarr_role_docker_exposed_ports:

homarr_role_docker_hosts

# Type: dict
homarr_role_docker_hosts:

homarr_role_docker_hosts_use_common

# Type: bool (true/false)
homarr_role_docker_hosts_use_common:

homarr_role_docker_ipc_mode

# Type: string
homarr_role_docker_ipc_mode:

homarr_role_docker_links

# Type: list
homarr_role_docker_links:

homarr_role_docker_network_mode

# Type: string
homarr_role_docker_network_mode:

homarr_role_docker_pid_mode

# Type: string
homarr_role_docker_pid_mode:

homarr_role_docker_ports

# Type: list
homarr_role_docker_ports:

homarr_role_docker_uts

# Type: string
homarr_role_docker_uts:

Storage

homarr_role_docker_keep_volumes

# Type: bool (true/false)
homarr_role_docker_keep_volumes:

homarr_role_docker_mounts

# Type: list
homarr_role_docker_mounts:

homarr_role_docker_storage_opts

# Type: dict
homarr_role_docker_storage_opts:

homarr_role_docker_tmpfs

# Type: list
homarr_role_docker_tmpfs:

homarr_role_docker_volume_driver

# Type: string
homarr_role_docker_volume_driver:

homarr_role_docker_volumes_from

# Type: list
homarr_role_docker_volumes_from:

homarr_role_docker_volumes_global

# Type: bool (true/false)
homarr_role_docker_volumes_global:

homarr_role_docker_working_dir

# Type: string
homarr_role_docker_working_dir:

Monitoring & Lifecycle

homarr_role_docker_auto_remove

# Type: bool (true/false)
homarr_role_docker_auto_remove:

homarr_role_docker_cleanup

# Type: bool (true/false)
homarr_role_docker_cleanup:

homarr_role_docker_force_kill

# Type: string
homarr_role_docker_force_kill:

homarr_role_docker_healthcheck

# Type: dict
homarr_role_docker_healthcheck:

homarr_role_docker_healthy_wait_timeout

# Type: int
homarr_role_docker_healthy_wait_timeout:

homarr_role_docker_init

# Type: bool (true/false)
homarr_role_docker_init:

homarr_role_docker_kill_signal

# Type: string
homarr_role_docker_kill_signal:

homarr_role_docker_log_driver

# Type: string
homarr_role_docker_log_driver:

homarr_role_docker_log_options

# Type: dict
homarr_role_docker_log_options:

homarr_role_docker_oom_killer

# Type: bool (true/false)
homarr_role_docker_oom_killer:

homarr_role_docker_oom_score_adj

# Type: int
homarr_role_docker_oom_score_adj:

homarr_role_docker_output_logs

# Type: bool (true/false)
homarr_role_docker_output_logs:

homarr_role_docker_paused

# Type: bool (true/false)
homarr_role_docker_paused:

homarr_role_docker_recreate

# Type: bool (true/false)
homarr_role_docker_recreate:

homarr_role_docker_restart_retries

# Type: int
homarr_role_docker_restart_retries:

homarr_role_docker_stop_timeout

# Type: int
homarr_role_docker_stop_timeout:

Other Options

homarr_role_docker_capabilities

# Type: list
homarr_role_docker_capabilities:

homarr_role_docker_cgroup_parent

# Type: string
homarr_role_docker_cgroup_parent:

homarr_role_docker_commands

# Type: list
homarr_role_docker_commands:

homarr_role_docker_create_timeout

# Type: int
homarr_role_docker_create_timeout:

homarr_role_docker_entrypoint

# Type: string
homarr_role_docker_entrypoint:

homarr_role_docker_env_file

# Type: string
homarr_role_docker_env_file:

homarr_role_docker_labels

# Type: dict
homarr_role_docker_labels:

homarr_role_docker_labels_use_common

# Type: bool (true/false)
homarr_role_docker_labels_use_common:

homarr_role_docker_read_only

# Type: bool (true/false)
homarr_role_docker_read_only:

homarr_role_docker_runtime

# Type: string
homarr_role_docker_runtime:

homarr_role_docker_sysctls

# Type: list
homarr_role_docker_sysctls:

homarr_role_docker_ulimits

# Type: list
homarr_role_docker_ulimits:

homarr_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
homarr_role_autoheal_enabled: true

homarr_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
homarr_role_depends_on: ""

homarr_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
homarr_role_depends_on_delay: "0"

homarr_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
homarr_role_depends_on_healthchecks:

homarr_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
homarr_role_diun_enabled: true

homarr_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
homarr_role_dns_enabled: true

homarr_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
homarr_role_docker_controller: true

homarr_role_docker_image_repo

# Type: string
homarr_role_docker_image_repo:

homarr_role_docker_image_tag

# Type: string
homarr_role_docker_image_tag:

homarr_role_docker_volumes_download

# Type: bool (true/false)
homarr_role_docker_volumes_download:

homarr_role_paths_location

# Type: string
homarr_role_paths_location:

homarr_role_themepark_addons

# Type: string
homarr_role_themepark_addons:

homarr_role_themepark_app

# Type: string
homarr_role_themepark_app:

homarr_role_themepark_theme

# Type: string
homarr_role_themepark_theme:

homarr_role_traefik_api_endpoint

# Type: dict/omit
homarr_role_traefik_api_endpoint:

homarr_role_traefik_api_middleware

# Type: string
homarr_role_traefik_api_middleware:

homarr_role_traefik_api_middleware_http

# Type: string
homarr_role_traefik_api_middleware_http:

homarr_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
homarr_role_traefik_autodetect_enabled: false

homarr_role_traefik_certresolver

# Type: string
homarr_role_traefik_certresolver:

homarr_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
homarr_role_traefik_crowdsec_enabled: false

homarr_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
homarr_role_traefik_error_pages_enabled: false

homarr_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
homarr_role_traefik_gzip_enabled: false

homarr_role_traefik_middleware_http

# Type: string
homarr_role_traefik_middleware_http:

homarr_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
homarr_role_traefik_middleware_http_api_insecure:

homarr_role_traefik_middleware_http_insecure

# Type: bool (true/false)
homarr_role_traefik_middleware_http_insecure:

homarr_role_traefik_priority

# Type: string
homarr_role_traefik_priority:

homarr_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
homarr_role_traefik_robot_enabled: true

homarr_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
homarr_role_traefik_tailscale_enabled: false

homarr_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
homarr_role_traefik_wildcard_enabled: true

homarr_role_web_domain

# Type: string
homarr_role_web_domain:

homarr_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
homarr_role_web_fqdn_override:

Example Override

homarr_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "homarr2.{{ user.domain }}"
  - "homarr.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

homarr_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
homarr_role_web_host_override:

Example Override

homarr_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'homarr2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

homarr_role_web_http_port

# Type: string (quoted number)
homarr_role_web_http_port:

homarr_role_web_http_scheme

# Type: string ("http"/"https")
homarr_role_web_http_scheme:

homarr_role_web_http_serverstransport

# Type: dict/omit
homarr_role_web_http_serverstransport:

homarr_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
homarr_role_web_scheme:

homarr_role_web_serverstransport

# Type: dict/omit
homarr_role_web_serverstransport:

homarr_role_web_subdomain

# Type: string
homarr_role_web_subdomain: