Skip to content

MOTD

Overview

MOTD is a Saltbox module that enhances the Message of the Day (MOTD) displayed upon user login to provide personalized information.

Deployment

sb install motd

Role Defaults

Variables can be customized using the Inventory. (1)

  1. Example override

    motd_install: true
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/sb"
motd_cli_flags 
# Type: string
motd_cli_flags: "--all --title 'Saltbox' --font ivrit --type parchment"
motd_services 
# Service types:
# - multi_instance_apikey: Multiple instances with API key (sonarr, radarr, lidarr, readarr, overseerr)
# - multi_instance_token: Multiple instances with token (plex)
# - single_instance_apikey: Single instance with API key (sabnzbd)
# - single_instance_userpass: Single instance with username/password (nzbget)
# - multi_instance_userpass: Multiple instances with username/password (qbittorrent)
# - disabled: Statically disabled services (jellyfin, emby, rtorrent)
# Type: list
motd_services:
  - name: colors
    type: colors
  - name: emby
    type: multi_instance_token
    check_field: token
    output_field: token
  - name: jellyfin
    type: multi_instance_token
    check_field: token
    output_field: token
  - name: lidarr
    type: multi_instance_apikey
    check_field: api_key
    output_field: apikey
  - name: nzbget
    type: single_instance_userpass
    check_field: username
  - name: plex
    type: multi_instance_token
    check_field: token
    output_field: token
  - name: qbittorrent
    type: multi_instance_userpass_info
    check_field: username
  - name: radarr
    type: multi_instance_apikey
    check_field: api_key
    output_field: apikey
  - name: sabnzbd
    type: single_instance_apikey
    check_field: api_key
    output_field: apikey
  - name: sonarr
    type: multi_instance_apikey
    check_field: api_key
    output_field: apikey
  - name: systemd
    type: systemd
motd_colors 
# Type: dict
motd_colors:
  text:
    label: "#FF79D0"
    value: "#12C78F"
    app_name: "#BF976F"
  status:
    warning: "#F5EF34"
    success: "#12C78F"
    error: "#EB4268"
  progress_bar:
    low: "#A8CC8C"
    high: "#DBAB79"
    critical: "#E88388"
motd_systemd 
# Type: dict
motd_systemd:
  enabled: true
  additional_services: []
  display_names: {}