MOTD¶

Overview¶

Enhances the Message of the Day (MOTD) displayed upon user login to provide personalized information.

Deployment¶

sb install motd

Role Defaults¶

Info

Variables can be overridden in /srv/git/saltbox/inventories/host_vars/localhost.yml.

Example Override

motd_install: true

GeneralGlobal Override Options

motd_install

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

motd_use_python

# Requires the new golang CLI to be installed and in the location set below
# if you set motd_use_python to false.
# Type: bool (true/false)
motd_use_python: true

motd_cli_path

# Type: string
motd_cli_path: "/usr/local/bin/sb2"

motd_cli_flags

# Type: string
motd_cli_flags: "--all --title 'Saltbox' --font ivrit --type parchment"

motd_role_autoheal_enabled

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

motd_role_depends_on

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

motd_role_depends_on_delay

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

motd_role_depends_on_healthchecks

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

motd_role_diun_enabled

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

motd_role_dns_enabled

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

motd_role_docker_controller

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

motd_role_traefik_autodetect_enabled

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

motd_role_traefik_crowdsec_enabled

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

motd_role_traefik_error_pages_enabled

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

motd_role_traefik_gzip_enabled

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

motd_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
motd_role_traefik_middleware_http_api_insecure:

motd_role_traefik_middleware_http_insecure

# Type: bool (true/false)
motd_role_traefik_middleware_http_insecure:

motd_role_traefik_robot_enabled

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

motd_role_traefik_tailscale_enabled

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

motd_role_traefik_wildcard_enabled

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

motd_role_web_fqdn_override

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

Example Override

motd_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "motd2.{{ user.domain }}"
  - "motd.otherdomain.tld"

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

motd_role_web_host_override

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

Example Override

motd_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'motd2.' + user.domain }}`)"

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

motd_role_web_scheme

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