Skip to content

Branding

Overview

NF can be white-labeled to match your branding. The branding settings can be configured in the UI or via environment variables.

Configuration

NF first looks for persistent configuration in the /var/nf/config directory, and falls back to environment variable values.

Configuration UI

Access the branding settings in the UI by navigating to the Settings menu and selecting Branding.

Environment Variables

White-labeling config can be set with the following environment variables:

  • THUMBNAIL_FILE: Small version of the logo. Use a 1:1 aspect ratio.
  • LOGO_FILE: Large version of the logo. Use a 7:1 aspect ratio.
  • FAV_ICON_FILE: Favicon image. Use a 1:1 aspect ratio.
  • FOOTER_TEXT: The text to display in the app footer.

Images should be set to a file path relative to the /var/nf/upload directory. For example, THUMBNAIL_FILE=logo.png refers to the file logo.png in the /var/nf/upload directory.

Values can also be set to a URL. For example, THUMBNAIL_FILE=https://example.com/logo.png.

Using the Settings API

The Settings API can be used to set the branding settings. If you want to serve the assets using NF's static files capabilities, you will need to first upload the file, then set the branding settings environment variable.

See examples in the nf-sdk