Error Pages¶

Overview¶

Error Pages is a GitHub repository that provides visually appealing, customizable error pages for HTTP servers, Kubernetes clusters, and other systems like Traefik and Nginx.

Manual

Releases

Community

Installation¶

Enable in adv_settings.yml:

traefik:
  error_pages: yes

Then install/update Traefik:

sb install traefik

Configuration¶

Change Template¶

Change the template in your inventory:

error_pages_role_template: "ghost"

Available templates: l7 (default), ghost, noise, hacker-terminal, shuffle, lost-in-space, app-down, connection, and more.

Rebuild after changing:

sb install traefik

Disable for Specific Apps¶

Disable error pages for specific apps in your inventory:

plex_role_traefik_error_pages_enabled: false

Notes¶

Error pages stored in /opt/error-pages/
Pre-generated at install time from selected template
Applied globally via Traefik middleware
Manual edits overwritten on rebuild

Role Defaults¶

Use the Inventory to customize variables. (1)

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

When overriding variables that end in _default (like error_pages_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 error_pages_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsConfigDockerDocker+Global Override Options

error_pages_name

# Type: string
error_pages_name: error-pages

error_pages_role_template

# Template options listed here https://github.com/tarampampam/error-pages
# Type: string
error_pages_role_template: "l7"

Container

error_pages_role_docker_container

# Type: string
error_pages_role_docker_container: "{{ error_pages_name }}"

Image

error_pages_role_docker_image_pull

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

error_pages_role_docker_image_repo

# Type: string
error_pages_role_docker_image_repo: "tarampampam/error-pages"

error_pages_role_docker_image_tag

# Type: string
error_pages_role_docker_image_tag: "latest"

error_pages_role_docker_image

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

Envs

error_pages_role_docker_envs_default

# Type: dict
error_pages_role_docker_envs_default:
  TEMPLATE_NAME: "{{ lookup('role_var', '_template', role='error_pages') }}"

error_pages_role_docker_envs_custom

# Type: dict
error_pages_role_docker_envs_custom: {}

Volumes

error_pages_role_docker_volumes_default

# Type: list
error_pages_role_docker_volumes_default:
  - "{{ server_appdata_path }}/error-pages:/opt/html"

error_pages_role_docker_volumes_custom

# Type: list
error_pages_role_docker_volumes_custom: []

Labels

error_pages_role_docker_labels_default

# Type: dict
error_pages_role_docker_labels_default:
  traefik.enable: "true"
  traefik.http.routers.error-pages-router.rule: "PathPrefix(`/`)"
  traefik.http.routers.error-pages-router.priority: "5"
  traefik.http.routers.error-pages-router.entrypoints: "web,websecure"
  traefik.http.routers.error-pages-router.middlewares: "error-pages-middleware"
  traefik.http.middlewares.error-pages-middleware.errors.status: "400-599"
  traefik.http.middlewares.error-pages-middleware.errors.service: "error-pages-service"
  traefik.http.middlewares.error-pages-middleware.errors.query: "/{status}.html"
  traefik.http.services.error-pages-service.loadbalancer.server.port: "8080"

error_pages_role_docker_labels_custom

# Type: dict
error_pages_role_docker_labels_custom: {}

Hostname

error_pages_role_docker_hostname

# Type: string
error_pages_role_docker_hostname: "{{ error_pages_name }}"

Networks

error_pages_role_docker_networks_alias

# Type: string
error_pages_role_docker_networks_alias: "{{ error_pages_name }}"

error_pages_role_docker_networks_default

# Type: list
error_pages_role_docker_networks_default: []

error_pages_role_docker_networks_custom

# Type: list
error_pages_role_docker_networks_custom: []

Restart Policy

error_pages_role_docker_restart_policy

# Type: string
error_pages_role_docker_restart_policy: unless-stopped

State

error_pages_role_docker_state

# Type: string
error_pages_role_docker_state: started

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

Resource Limits

error_pages_role_docker_blkio_weight

# Type: int
error_pages_role_docker_blkio_weight:

error_pages_role_docker_cpu_period

# Type: int
error_pages_role_docker_cpu_period:

error_pages_role_docker_cpu_quota

# Type: int
error_pages_role_docker_cpu_quota:

error_pages_role_docker_cpu_shares

# Type: int
error_pages_role_docker_cpu_shares:

error_pages_role_docker_cpus

# Type: string
error_pages_role_docker_cpus:

error_pages_role_docker_cpuset_cpus

# Type: string
error_pages_role_docker_cpuset_cpus:

error_pages_role_docker_cpuset_mems

# Type: string
error_pages_role_docker_cpuset_mems:

error_pages_role_docker_kernel_memory

# Type: string
error_pages_role_docker_kernel_memory:

error_pages_role_docker_memory

# Type: string
error_pages_role_docker_memory:

error_pages_role_docker_memory_reservation

# Type: string
error_pages_role_docker_memory_reservation:

error_pages_role_docker_memory_swap

# Type: string
error_pages_role_docker_memory_swap:

error_pages_role_docker_memory_swappiness

# Type: int
error_pages_role_docker_memory_swappiness:

error_pages_role_docker_shm_size

# Type: string
error_pages_role_docker_shm_size:

Security & Devices

error_pages_role_docker_cap_drop

# Type: list
error_pages_role_docker_cap_drop:

error_pages_role_docker_cgroupns_mode

# Type: string
error_pages_role_docker_cgroupns_mode:

error_pages_role_docker_device_cgroup_rules

# Type: list
error_pages_role_docker_device_cgroup_rules:

error_pages_role_docker_device_read_bps

# Type: list
error_pages_role_docker_device_read_bps:

error_pages_role_docker_device_read_iops

# Type: list
error_pages_role_docker_device_read_iops:

error_pages_role_docker_device_requests

# Type: list
error_pages_role_docker_device_requests:

error_pages_role_docker_device_write_bps

# Type: list
error_pages_role_docker_device_write_bps:

error_pages_role_docker_device_write_iops

# Type: list
error_pages_role_docker_device_write_iops:

error_pages_role_docker_devices

# Type: list
error_pages_role_docker_devices:

error_pages_role_docker_devices_default

# Type: string
error_pages_role_docker_devices_default:

error_pages_role_docker_groups

# Type: list
error_pages_role_docker_groups:

error_pages_role_docker_privileged

# Type: bool (true/false)
error_pages_role_docker_privileged:

error_pages_role_docker_security_opts

# Type: list
error_pages_role_docker_security_opts:

error_pages_role_docker_user

# Type: string
error_pages_role_docker_user:

error_pages_role_docker_userns_mode

# Type: string
error_pages_role_docker_userns_mode:

Networking

error_pages_role_docker_dns_opts

# Type: list
error_pages_role_docker_dns_opts:

error_pages_role_docker_dns_search_domains

# Type: list
error_pages_role_docker_dns_search_domains:

error_pages_role_docker_dns_servers

# Type: list
error_pages_role_docker_dns_servers:

error_pages_role_docker_domainname

# Type: string
error_pages_role_docker_domainname:

error_pages_role_docker_exposed_ports

# Type: list
error_pages_role_docker_exposed_ports:

error_pages_role_docker_hosts

# Type: dict
error_pages_role_docker_hosts:

error_pages_role_docker_hosts_use_common

# Type: bool (true/false)
error_pages_role_docker_hosts_use_common:

error_pages_role_docker_ipc_mode

# Type: string
error_pages_role_docker_ipc_mode:

error_pages_role_docker_links

# Type: list
error_pages_role_docker_links:

error_pages_role_docker_network_mode

# Type: string
error_pages_role_docker_network_mode:

error_pages_role_docker_pid_mode

# Type: string
error_pages_role_docker_pid_mode:

error_pages_role_docker_ports

# Type: list
error_pages_role_docker_ports:

error_pages_role_docker_uts

# Type: string
error_pages_role_docker_uts:

Storage

error_pages_role_docker_keep_volumes

# Type: bool (true/false)
error_pages_role_docker_keep_volumes:

error_pages_role_docker_mounts

# Type: list
error_pages_role_docker_mounts:

error_pages_role_docker_storage_opts

# Type: dict
error_pages_role_docker_storage_opts:

error_pages_role_docker_tmpfs

# Type: list
error_pages_role_docker_tmpfs:

error_pages_role_docker_volume_driver

# Type: string
error_pages_role_docker_volume_driver:

error_pages_role_docker_volumes_from

# Type: list
error_pages_role_docker_volumes_from:

error_pages_role_docker_volumes_global

# Type: bool (true/false)
error_pages_role_docker_volumes_global:

error_pages_role_docker_working_dir

# Type: string
error_pages_role_docker_working_dir:

Monitoring & Lifecycle

error_pages_role_docker_auto_remove

# Type: bool (true/false)
error_pages_role_docker_auto_remove:

error_pages_role_docker_cleanup

# Type: bool (true/false)
error_pages_role_docker_cleanup:

error_pages_role_docker_force_kill

# Type: string
error_pages_role_docker_force_kill:

error_pages_role_docker_healthcheck

# Type: dict
error_pages_role_docker_healthcheck:

error_pages_role_docker_healthy_wait_timeout

# Type: int
error_pages_role_docker_healthy_wait_timeout:

error_pages_role_docker_init

# Type: bool (true/false)
error_pages_role_docker_init:

error_pages_role_docker_kill_signal

# Type: string
error_pages_role_docker_kill_signal:

error_pages_role_docker_log_driver

# Type: string
error_pages_role_docker_log_driver:

error_pages_role_docker_log_options

# Type: dict
error_pages_role_docker_log_options:

error_pages_role_docker_oom_killer

# Type: bool (true/false)
error_pages_role_docker_oom_killer:

error_pages_role_docker_oom_score_adj

# Type: int
error_pages_role_docker_oom_score_adj:

error_pages_role_docker_output_logs

# Type: bool (true/false)
error_pages_role_docker_output_logs:

error_pages_role_docker_paused

# Type: bool (true/false)
error_pages_role_docker_paused:

error_pages_role_docker_recreate

# Type: bool (true/false)
error_pages_role_docker_recreate:

error_pages_role_docker_restart_retries

# Type: int
error_pages_role_docker_restart_retries:

error_pages_role_docker_stop_timeout

# Type: int
error_pages_role_docker_stop_timeout:

Other Options

error_pages_role_docker_capabilities

# Type: list
error_pages_role_docker_capabilities:

error_pages_role_docker_cgroup_parent

# Type: string
error_pages_role_docker_cgroup_parent:

error_pages_role_docker_commands

# Type: list
error_pages_role_docker_commands:

error_pages_role_docker_create_timeout

# Type: int
error_pages_role_docker_create_timeout:

error_pages_role_docker_entrypoint

# Type: string
error_pages_role_docker_entrypoint:

error_pages_role_docker_env_file

# Type: string
error_pages_role_docker_env_file:

error_pages_role_docker_labels_use_common

# Type: bool (true/false)
error_pages_role_docker_labels_use_common:

error_pages_role_docker_read_only

# Type: bool (true/false)
error_pages_role_docker_read_only:

error_pages_role_docker_runtime

# Type: string
error_pages_role_docker_runtime:

error_pages_role_docker_sysctls

# Type: list
error_pages_role_docker_sysctls:

error_pages_role_docker_ulimits

# Type: list
error_pages_role_docker_ulimits:

error_pages_role_autoheal_enabled

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

error_pages_role_depends_on

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

error_pages_role_depends_on_delay

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

error_pages_role_depends_on_healthchecks

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

error_pages_role_diun_enabled

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

error_pages_role_docker_controller

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

error_pages_role_docker_image_repo

# Type: string
error_pages_role_docker_image_repo:

error_pages_role_docker_image_tag

# Type: string
error_pages_role_docker_image_tag:

error_pages_role_docker_volumes_download

# Type: bool (true/false)
error_pages_role_docker_volumes_download:

error_pages_role_template

# Type: string
error_pages_role_template: