Skip to main content

Setting the Primary Color, Name and Logo in Kiosk/App Portal (15.3+)

What

This article provides step-by-step instructions on how to set a primary color, name and a logo for the App Portal / Kiosk on FileWave v15.3.0+.

When/Why

The customization of the FileWave Kiosk interface, including its primary color and logo, allows organizations to maintain brand consistency across different platforms and devices. In order to make this change during the preview you will need direct access to your FileWave Server or have Technical Support make the edit for you. 

How

Customizing the iOS/iPadOS Kiosk for logo and color

Please note that you can not change the name yet on the mobile Kiosk. This can be done on the macOS/Windows Desktop Kiosk however as outlined in the section after this.

Logo Customization:

  • Copy the image you wish to use as the logo to the following location: /usr/local/filewave/django/static/kiosk2/images/image.jpeg

  • Edit the server-side file located at: /usr/local/filewave/django/filewave/settings_custom.py.

  • Add the following entry at the end of the script: KIOSK_LOGO_URL = 'https://fully_qualified_domain_name/filewave/static/kiosk2/images/image.jpeg'

  • Restart the server after modifying settings_custom.py

The supported formats of the logo are:

- SVG
- JPEG
- PNG
- GIF
- Animated GIF
- WebP
- Animated WebP
- BMP
- WBMP

In case the Logo isn’t preset by the user, or if it's preset but cannot be retrieved for some reason, the default logo that will be shown in the application is the FileWave logo.

To ensure optimal display quality and prevent upscaling issues, we recommend using either:

  • SVG file format
  • Picture format with a minimum height of 96 pixels

Primary Color Customization:

  • In the same server-side file mentioned above (/FileWave/Django/filewave/settings_custom.py), add the following entry at the end of the script: KIOSK_PRIMARY_COLOR = “#ColorCode“.
  • Restart the server after modifying settings_custom.py

Please note that the primary color should be written in a hex format of 6 or 8 characters. For example:

- KIOSK_PRIMARY_COLOR = '#e580ff'
- KIOSK_PRIMARY_COLOR = '#FF0000CC'

In case the default color isn’t set, or if it's preset but in the wrong format, the color that will be shown in the application is the FileWave default color.

Customizing the macOS/Windows Desktop Kiosk for logo, name and color

To customize the logo, the primary color, and the name of the Kiosk app, you can deploy the following configuration file to your clients inside a Fileset:

{
   "logo_url": "https://my.company/logo.svg",
   "primary_color": "#0465DA",
   "kiosk_app_name": "My Kiosk"
}

The location of the file on macOS: /usr/local/sbin/FileWave.app/Contents/MacOS/FileWave\ Kiosk.app/Contents/custom/settings.json

The location of the file on Windows: C:\Program Files (x86)\FileWave\kiosk\custom\settings.json

Configurable parameters:

  1. logo_url: The URL of the logo image (Default: FileWave logo)

  2. primary_color: The primary color in #RRGGBB format (Default: #0465DA)

  3. kiosk_app_name: The displayed name of the Kiosk app (Default: FileWave Kiosk)

Notes

  • If after deployment, you still do not see the changes made to the kiosk but have confirmed the settings.json has properly deployed, it may be necessary to restart the device before the changes fully take place. This may be especially necessary if the old kiosk customizer fileset was removed from the device and this new one is taking it's place.
Back to top