Wallpaper

With the configuration Wallpaper for iOS devices, an image can be set for the home screen and/or lock screen that appears on the devices after the policy has been applied. For example, student devices in a school or devices in a company can be provided with a uniform background image and/or an image on the lock screen.

This configuration requires supervised devices (badge Supervised in the portal, see Supervised Mode / Supervision →).

The configuration is created via Devices → Policies → {iOS policy} → Add → Wallpaper → Add details. When it is created, the form is titled Add wallpaper; when it is edited, Edit wallpaper. All fields are located in the General section. A policy can contain several wallpaper configurations.

If the background image is set via the policy, the original background image of the device is discarded and cannot be restored with Relution.

Which views can be configured on the devices?

Set as determines where the wallpaper is shown: Home and Lock screens (default), Lock screen or Home screen.

With iOS 16 and iPadOS 17 the devices use an enhanced lock screen. The image is therefore always set for both screens, even if only one is selected under Set as, unless a separate wallpaper configuration exists for the other screen. Different images for the lock screen and the home screen therefore require two configurations, one per screen.

Configurations for Lock screen and Home screen coexist. If several wallpaper configurations affect the same screen, for example Home and Lock screens together with Lock screen, only one of them is sent to the device: the one from the policy with the higher priority.


Text on the wallpaper

The field Text on wallpaper allows text with placeholders to be written onto the image, see Text on wallpapers →.

FieldDescriptionDefault
Text on wallpaperOptional text, which may span several lines, that Relution writes onto the image. Placeholders such as ${device.name} are replaced for each device. The text appears in the center of the image; the font size adapts automatically to the length and number of lines of the text, the device type (iPhone or iPad) and the image size. Without text, the device receives the uploaded image unchanged.empty
Text colorColor of the text as a six-digit hex color code, e.g. #000000 for black. The value is selected with the color picker next to the field or entered directly. A value in any other format is marked as an error, and the configuration cannot be saved.#ffffff

If the Text on wallpaper field contains text, a notice above the field points out the delayed delivery: Relution generates the image with text for each device on the server. If it is not yet available when the policy is applied, the device first receives the image without text; as soon as the image with text has been generated, Relution sends it to the device automatically.

Below the form, the Available placeholders area lists all placeholders that can be used in the Text on wallpaper field: user placeholders such as ${user.email} and device placeholders such as ${device.name} or ${device.serialnumber}. The area is expanded and can be collapsed with the arrow button; clicking an entry copies it to the clipboard. Functions such as substrings or default values are described in Advanced placeholders →.

From Relution 26.5.5 to 27.0.1, text output on wallpapers is disabled by default: devices receive the image without text, even though the portal still shows the field Text on wallpaper. On self-hosted servers running these versions, it is enabled via relution.wallpaper.text-rendering-enabled: true in application.yml or the environment variable RELUTION_WALLPAPER_TEXTRENDERINGENABLED=true and applies to all platforms after the server has been restarted. As of Relution 27.0.2, text output is enabled by default again and the setting has been removed. Devices that previously received the image without text may only show the text after the policy has been applied again.

Image file

The Wallpaper field is mandatory. The image is uploaded in PNG or JPEG format and may be at most 3 MB in size by default. For a larger file, the portal displays an error message. In self-hosted installations, the limit can be adjusted in application.yml via the key relution.wallpaper.max-file-size.ios.

Uploading works via Select or by drag and drop onto the area below the button; the portal shows the permitted file size in brackets after the field label (Max. file size). A file that is too large is not uploaded. After the upload, the portal shows a preview and the file name; the icon next to the file name removes the image again.

If an image that has already been saved is larger than the permitted file size, for example after the limit has been reduced, a notice above the form points this out. The configuration can then only be saved after a smaller image has been uploaded.


Example: device name on the wallpaper

A school’s loan iPads are to show their device name on the lock screen and the home screen so that they can be clearly identified when they are handed out and returned:

  • Set as: Home and Lock screens (default)
  • Text on wallpaper: ${device.name}
  • Text color: #000000
  • Wallpaper: school-light.png (light PNG image, smaller than 3 MB)

After the policy has been applied, each iPad shows the image with its own device name in black; until Relution has generated the image with text, the image without text is shown first.

How helpful was this article?