runr_branding (Resource)

The white-label brand of the console, login page and e-mails (one per scope). Terraform owns the whole brand: attributes left out use RunR's defaults (for an organization: the install's brand), and destroying the resource resets the brand. Images can be set as URLs or data: URIs; uploads stay in the console.

scope = "install" is the installation's brand (branding.manage; multi-tenant: platform administrators), scope = "organization" an organization's own brand in the multi-tenant edition (branding.manage in the organization, while the platform allows organization brands).

Example Usage#

# The installation's brand. Attributes left out use the defaults; destroying the resource
# resets the brand.
resource "runr_branding" "brand" {
  product_name    = "Acme Cloud"
  company_name    = "Acme Corp."
  primary_color   = "#0f766e"
  accent_color    = "#f59e0b"
  login_headline  = "Welcome to Acme Cloud"
  support_email   = "support@acme.example"
  support_url     = "https://help.acme.example"
  email_from_name = "Acme Cloud"

  # Images as data: URIs from files next to the configuration (or https:// URLs).
  logo_light_url = "data:image/svg+xml;base64,${filebase64("${path.module}/logo-light.svg")}"
  logo_dark_url  = "data:image/svg+xml;base64,${filebase64("${path.module}/logo-dark.svg")}"
  favicon_url    = "data:image/png;base64,${filebase64("${path.module}/favicon.png")}"

  footer_links = [
    { label = "Status", url = "https://status.acme.example" },
    { label = "Privacy", url = "https://acme.example/privacy" },
  ]

  powered_by              = false
  tenant_branding_enabled = true # multi-tenant: organizations may set their own brand
}

Schema#

Optional#

accent_color (String) Accent colour (#rrggbb).
company_name (String) Company name (footer, e-mails).
email_from_name (String) Sender name of e-mails.
email_logo_url (String) Logo of e-mails: an https:// URL or a data: URI, e.g. "data:image/png;base64,${filebase64("logo.png")}". An image uploaded in the console stays while this is unset.
favicon_url (String) Favicon: an https:// URL or a data: URI, e.g. "data:image/png;base64,${filebase64("logo.png")}". An image uploaded in the console stays while this is unset.
footer_links (Attributes List) Links of the console footer (at most 8). (see below for nested schema)
login_headline (String) Headline of the login page.
login_text (String) Text of the login page.
logo_dark_url (String) Logo for dark backgrounds: an https:// URL or a data: URI, e.g. "data:image/png;base64,${filebase64("logo.png")}". An image uploaded in the console stays while this is unset.
logo_light_url (String) Logo for light backgrounds: an https:// URL or a data: URI, e.g. "data:image/png;base64,${filebase64("logo.png")}". An image uploaded in the console stays while this is unset.
logo_mark_url (String) Square logo mark: an https:// URL or a data: URI, e.g. "data:image/png;base64,${filebase64("logo.png")}". An image uploaded in the console stays while this is unset.
powered_by (Boolean) Show "Powered by RunR" (install scope only).
primary_color (String) Primary colour (#rrggbb).
product_name (String) Product name shown in the console, the login page and e-mails.
scope (String) install or organization. Default: organization for members of a multi-tenant installation who are not platform administrators, install otherwise.
support_email (String) Support e-mail address.
support_url (String) Support page (https://…).
tenant_branding_enabled (Boolean) Allow organizations of a multi-tenant installation to set their own brand (install scope only). Unset: the switch stays as it is set in the console; destroying the resource keeps it.

Read-Only#

id (String) The scope.

Nested Schema for `footer_links`#

Required:

label (String) Link text.
url (String) https://…, http://… or mailto:….

Import#

Import is supported using the following syntax:

The terraform import command can be used, for example:

# install (the installation's brand) or organization (multi-tenant: the organization's own brand)
terraform import runr_branding.brand install