Skip to content

Managing Backgrounds

Marc Thielemann edited this page Oct 17, 2025 · 15 revisions



Configuration profile keys

Here you can find information about all app settings that can be configured using a configuration profile:

HidePredefinedBackgrounds
LogoImages
PredefinedBackgrounds


key:	HidePredefinedBackgrounds
value:	a boolean

If set to true, the predefined backgrounds included in the application (or specified using the PredefinedBackgrounds key), will not be displayed. If set to false, the predefined backgrounds cannot be hided by the user.


key:	LogoImages
value:	an array of dictionaries

This key allows to specify logos that then can be embedded into the background image. The following keys are supported in a dictionary:

LogoData
LogoName
LogoPath
LogoSize
LogoSizeLocked
LogoXPosition
LogoXPositionLocked
LogoYPosition
LogoYPositionLocked


Here's how the general structure should look like:

<key>LogoImages</key>
<array>

   <dict>
      <key>LogoName</key>
      <string>My Logo</string>
      <key>LogoPath</key>
      <string>/Library/Application Support/Backgrounds/my_logo.pdf</string>
      <key>LogoSize</key>
      <integer>20</integer>
      <key>LogoSizeLocked</key>
      <true/>
      <key>LogoXPosition</key>
      <integer>50</integer>
      <key>LogoXPositionLocked</key>
      <true/>
      <key>LogoYPosition</key>
      <integer>50</integer>
      <key>LogoYPositionLocked</key>
      <true/>
   </dict>

   <dict>
      <key>LogoName</key>
      <string>My other logo</string>
      <key>LogoData</key>
      <data>
         …
      </data>
      <key>LogoSize</key>
      <integer>50</integer>
   </dict>

</array>

key:	LogoData
value:	Base64 encoded image data

To get this data from an existing image file, you could use the Terminal and then do something like base64 -b 52 -i <path to file>. The output can be used as value for this key. If LogoPath is also defined, it would be evaluated first and only if it returns no valid image data, `LogoData would be used.


key:	LogoName
value:	a string

This string specifies the logo name. This name is shown in the app's logo menu and must be unique.


key:	LogoPath
value:	a string

Specifies the path to an image file. Alternatively the logo can also be embedded in the configuration profile. Then use the key LogoData instead. If both, LogoPath and LogoData are specified, LogoPath is evaluated first and if no valid image file is found, `LogoData is used.


key:	LogoSize
value:	a number (float or integer)

Specifies the size of the logo image in percent (%) of the size of the background image. This optional key allows you to specify an initial size for the logo image.


key:	LogoSizeLocked
value:	a boolean

Allows to lock the size of the logo image. If set to true, the size specified using the LogoSize key, cannot be changed by a user anymore. The logo size slider will be disabled. So if you want to make sure your logo is used in a specific size, specify the size and then lock it using this key.


key:	LogoXPosition
value:	a number (float or integer)

Specifies the horizontal position of the logo image in percent (%). Starting with 0 percent at the left side of the background and ending with 100 percent at the right side. This optional key allows you to specify an initial horizontal position for the logo image.


key:	LogoXPositionLocked
value:	a boolean

Allows to lock the horizontal position of the logo image. If set to true, the position specified using the LogoXPosition key, cannot be changed by a user anymore. The logo horizontal position slider will be disabled. So if you want to make sure your logo is displayed on a specific position of the background image, specify the position (using the LogoXPosition and LogoYPosition keys) and then lock the position using the LogoXPositionLocked and `LogoXPositionLocked keys.


key:	LogoYPosition
value:	a number (float or integer)

Specifies the vertical position of the logo image in percent (%). Starting with 0 percent at the bottom of the background and ending with 100 percent at the top. This optional key allows you to specify an initial vertical position for the logo image.


key:	LogoYPositionLocked
value:	a boolean

Allows to lock the vertical position of the logo image. If set to true, the position specified using the LogoYPosition key, cannot be changed by a user anymore. The logo vertical position slider will be disabled. So if you want to make sure your logo is displayed on a specific position of the background image, specify the position (using the LogoXPosition and LogoYPosition keys) and then lock the position using the LogoXPositionLocked and LogoXPositionLocked keys.


key:	PredefinedBackgrounds
value:	an array of dictionaries

This key allows to overwrite the predefined backgrounds included in the application, so administrators can define their own set of predefined backgrounds. The following keys are supported in a dictionary:

BackgroundName
GradientAngle
GradientColors
GradientLocations
GradientXPosition
GradientYPosition
LogoName
LogoSize
LogoXPosition
LogoYPosition
RadialGradient


Here's how the general structure should look like:

<key>PredefinedBackgrounds</key>
<array> 

   <dict>
      <key>BackgroundName</key>
      <string>From gold to blue</string>
      <key>GradientColors</key>
      <array>
         <integer>15772416</integer>
         <integer>11051840</integer>
         <integer>6265727</integer>
         <integer>36819</integer>
      </array>
      <key>GradientLocations</key>
      <array>
         <real>0</real>
         <real>0.33</real>
         <real>0.66</real>
         <real>1</real>
      </array>
      <key>GradientAngle</key>
      <integer>0</integer>
      <key>LogoName</key>
      <string>My Logo</string>
      <key>LogoSize</key>
      <real>50</real>
      <key>LogoXPosition</key>
      <real>50</real>
      <key>LogoYPosition</key>
      <real>50</real>
      <key>RadialGradient</key>
      <false/>
   </dict>

</array>


key:	BackgroundName
value:	a string

Specifies the name of the background. This key is optional but must be used if the app should be used from the command line. If the name is not specified, the background does not show up if using the `--listBackgrounds argument.


key:	GradientAngle
value:	a number (float or integer)

Specifies the angle of a linear gradient.


key:	GradientColors
value:	an array of numbers (integer)

Specifies the colors of the gradient. Each number is the integer representation of the rgb value. So if you have e.g. a color like this: R: 250 G: 145 B: 0. This would be FA 91 00 in hex and FA 91 00 converted to decimal would be 16421120.


key:	GradientLocations
value:	an array of numbers (float or integer)

Specifies the locations of the colors (configured using the GradientColors key).


key:	GradientXPosition
value:	a number (float or integer)

Specifies the vertical center position of a radial gradient, Starting with -1 at the bottom of the background and ending with 1 at the top.


key:	GradientYPosition
value:	a number (float or integer)

Specifies the horizontal center position of a radial gradient, Starting with -1 at the left side of the background and ending with `1 at the right side.


key:	LogoName
value:	a string

Specifies the name of the logo image to embed into the background image. The logo must be configured using the LogoImages key. If the logo is not configured or the configured logo image does not exist, the app displays a small caution symbol instead of the logo image.


key:	LogoSize
value:	a number (float or integer)

Specifies the size of the logo image in percent (%) of the size of the background image. This key overwrites the (fixed) size of the logo image, configured for the logo in LogoImages.


key:	LogoXPosition
value:	a number (float or integer)

Specifies the horizontal position of the logo image in percent (%). Starting with 0 percent at the left side of the background and ending with 100 percent at the right side. This key overwrites the (fixed) position of the logo image, configured for the logo in LogoImages.


key:	LogoYPosition
value:	a number (float or integer)

Specifies the vertical position of the logo image in percent (%). Starting with 0 percent at the bottom of the background and ending with 100 percent at the top. This key overwrites the (fixed) position of the logo image, configured for the logo in LogoImages.


key:	RadialGradient
value:	a boolean

If set to true it specifies a radial gradient, or a linear gradient if set to false (or if not set).

Clone this wiki locally