Setting the Primary Color, Name and Logo in Kiosk/App Portal (15.3.0-15.5.1)

Devices of this nature use the App Portal.  As of FileWave 15.3, the App Portal IPA is automatically delivered to devices and will automatically update.

Customisation Options:

• Logo (Default to FileWave Logo if no custom logo set)
• Colour

Logo Customisation

If you are a Hosted Customer then you will need Technical Support to assist with these changes for now.

Direct editing of the IPA is not feasible.  As such, the logo needs to be hosted from the FileWave Server.  The chosen image needs to be placed in the following location:

/usr/local/filewave/django/static/kiosk2/images/

For the IPA to utilise this image, edit the the following file:

/usr/local/filewave/django/filewave/settings_custom.py

The line may be added to the bottom of the custom settings file and needs to include the FQDN of the FileWave Server, along with the named image in the format:

KIOSK_LOGO_URL = 'https://[fully_qualified_domain_name]/filewave/static/kiosk2/images/[file name]'

For example, imagine those details are:

• image.svg
• demo.filewave.ch

The line added will then appear as:

KIOSK_LOGO_URL = 'https://demo.filewave.ch/filewave/static/kiosk2/images/image.svg'

Supported file formats are:

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

Customise Colour

Colour may be customised by editing the same custom settings file.  The colour should be presented in hex of either 6 or 8 characters.  The line to add (again this may be added to the bottom of the custom settings file), should be of the format:

KIOSK_PRIMARY_COLOR = '[hex colour]'

 For example:

KIOSK_PRIMARY_COLOR = '#e580ff'

or

KIOSK_PRIMARY_COLOR = '#FF0000CC'

The FileWave Server Service should be restarted after modification of the custom settings python file.

Kiosk access is via Menu Bar.

macOS Kiosk App Logo

Customisation Options:

• Logo (Default to FileWave Logo if no custom logo set)
• Colour
• Kiosk App Name
• Menu Bar Icon - See below: Local macOS Logo

3 items can be specified through a single file:

macOS:

/usr/local/sbin/FileWave.app/Contents/MacOS/FileWave\ Kiosk.app/Contents/custom/settings.json

The contents should appear similar to:

{
    "logo_url": "https://buffer.com/cdn-cgi/image/w=1000,fit=contain,q=90,f=auto/library/content/images/size/w1200/2023/10/free-images.jpg",
    "primary_color": "#0465DA",
    "kiosk_app_name": "Custom Kiosk Name"
}

Defined as:

 It may be necessary to reboot the computer or log out and back in, before changes take effect; particularly if customisation of the older Version 1 Kiosk was removed at the same time that the new Version 2 Kiosk and customisation is applied.

If the custom icon is added as per the instructions for i(Pad)OS devices, the same URL may be used in the above settings.

macOS Menu Bar Extra Icon

The following method provides a pre-configured Fileset for customising this icon with a local file.

The Menu Bar Extra Icon will show in black or white alone.

macOS will automatically hide one or more Menu Bar Extras to prevent crowding of the Menu Bar.

FileWave Kiosk2 Menu Bar Icon.fileset.zip

The Fileset needs to be edited prior to deployment.  Out of the two files shown, the chosen custom image should be named to match the first png: 'tray-icon-macos.png'.  Leave the other file in place.

 Dragging the custom icon over the shown file should prompt a message as below.  Select Replace.

Associate with a test device, and once happy with the look, you can broaden the association.

The Fileset is designed to:

• Restart the Kiosk after activation, automatically ensuring the user is immediately presented with the new logo
• On de-activation, the 'tray-icon-macos.png.fw' file will be copied to replace the custom logo (resetting the default) and again restarting the Kiosk for immediate change.

Kiosk is accessed via the System Tray icon.

Windows Kiosk App Logo

Customisation Options:

• Logo (Default to FileWave Logo if no custom logo set)
• Colour
• Kiosk App Name
• System Tray Icon - See Windows System  Tray Icon
  

All 3 items can be specified through a single file:

Windows (32bit FileWave Client: 15.4-):

C:\Program Files (x86)\FileWave\kiosk\custom\settings.json

Windows (64bit FileWave Client: 15.5+):

C:\Program Files\FileWave\client\kiosk\custom\settings.json

The contents should appear similar to:

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

Defined as:

 It may be necessary to reboot the computer before changes take effect; particularly if customisation of the older Kiosk was removed at the same time that the new Kiosk and customisation is added.

If the custom icon is added as per the instructions for i(Pad)OS devices, the same URL may be used in the above settings.

Windows System Tray Icon

The following method provides a pre-configured Fileset for customising this icon with a local file.

FileWave Kiosk2 Sytem Tray Icon.fileset.zip

The provided Fileset contains two revisions:

• FileWave Client version 15.4- (32bit FileWave Client)
• FileWave Client version 15.5+ (64bit FileWave Client)

The Fileset needs to be edited prior to deployment.  Out of the four files shown, the chosen custom icon should be named to match the two icon files: 'tray-icon-dark.ico' and 'tray-icon-light.ico'.  Leave the other two files in place.

Unlike the other images, the Windows System Tray is using '.ico' files.  These need to be of equal size, e.g. 256x256, 128x128, etc.

Consider exporting the current 'ico' files, editing them with the chosen logo and then upload, if unsure how to create '.ico' files.

FileWave 15.4- (FileWave Client 32bit)

FileWave 15.5+ (FileWave Client 64bit)

Dragging the custom icon over the shown files should prompt a message as below.  Select Replace.

Associate the relevant revision with a test device and once happy broaden the association.

The new image will not show until the FileWave Client is restarted or the user logs out and back in.