Distributing Kitcast Builds Using MDM Providers
This guide will walk you through setting up Mobile Device Management (MDM) for the first time with Kitcast V2, using platforms like Jamf. We'll cover various scenarios, provide examples, and ensure you have all the information needed for a smooth setup.
Table of Contents
- Prerequisites
- Understanding Key Terms
- Step 1: Install the Kitcast tvOS App
- Step 2: Retrieve Your Secret Key and Configuration Format
- Step 3: Choose Your Configuration Scenario
- Scenario 1: Automatic Group Creation via MDM (Workspace-Based)
- Scenario 2: Adding Devices to a Specific Group (Group-Based)
- Scenario 3: App Distribution via MDM Without Config (Manual Linking)
- Step 4: Update Your MDM Provider with the Configuration
- Step 5: Verify Device Linking and Content Playback
- Additional Notes
- Troubleshooting
- Support
Prerequisites
- MDM Provider Access: Ensure you have administrative access to your MDM provider (e.g., Jamf).
- Kitcast V2 Account: Sign up for an account on Kitcast.tv V2 and have administrative privileges.
- Compatible Devices: Apple TV devices compatible with the Kitcast tvOS App.
Understanding Key Terms
- MDM (Mobile Device Management): A platform that allows you to manage and configure devices remotely.
- Groups: In Kitcast V2, devices are organized into Groups (previously called "Locations" in V1).
- Secret Key (MDM Token): A unique key used to authenticate and link your devices to your Kitcast account.
- Plist Configuration: A property list file used by MDM providers to configure apps on devices.
Step 1: Install the Kitcast tvOS App
Before configuring MDM settings, ensure that the Kitcast tvOS App is installed on all your devices.
- Via MDM: Deploy the Kitcast tvOS App to your devices using your MDM provider.
- Manually: If not using MDM for app deployment, download and install the app directly from the App Store on each device.
Step 2: Retrieve Your Secret Key (MDM Token) and Configuration Format
- Log into Kitcast V2: Access your account dashboard.
- Navigate to "Settings" –> "General" tab:
- Click on your profile icon or account settings.
- Select Preferences from the dropdown menu.
- Copy the Secret Key (MDM Token):
- Locate the MDM Token section. It shows the <Secret Key> you need to put into your config file.
- You can click the Copy icon to copy your full configuration, including the <Secret Key>, for pasting.
Step 3: Choose Your Configuration Scenario
Select the scenario that best fits your organization's needs.
Scenario 1: Automatic Group Creation via MDM (Workspace-Based)
- Use Case: Ideal if you want MDM to automatically create groups in Kitcast V2 based on your MDM's organizational structure.
- MDM Variables:
- $UDID: Device Unique Identifier.
- $DEVICENAME: Name of the screen.
- $SITEID: Group Unique Identifier
- $SITENAME: Group Name
-- These values from your MDM system will be substituted in place of the MDM variable
Scenario 2: Adding Devices to a Specific Group (Group-Based)
- Use Case: Best if you have predefined groups in Kitcast V2 and want to assign devices directly to them.
- MDM Variables:
- $UDID: Device Unique Identifier.
- $DEVICENAME: Name of the screen.
-- These values from your MDM system will be substituted in place of the MDM variable
Scenario 3: App Distribution via MDM Without Config (Manual Linking)
- Use Case: Suitable if you prefer to link devices manually using codes displayed on the screen.
- Action: Deploy the app via MDM without a configuration profile (please ensure no profile or any values such as
deviceName
,externalDeviceId
, orsecret
are set if you want to proceed with this scenario). You will manually assign the screens to the necessary groups.
Step 4: Update Your MDM Provider with the Configuration
Jamf Example:
-
Access Jamf Management Console:
- Log in to your Jamf administrator account.
-
Navigate to Mobile Device Apps:
- Go to Devices > Mobile Device Apps in the left-hand menu.
-
Add a New App or Edit an Existing One:
- New: Click on New to add a new app.
- Existing: Select the app associated with Kitcast and click Edit.
-
Configure the App Settings:
- Under "General" tab, enter the relevant details such as app name, description, and category.
- In "App Configuration" tab, add the required settings:
- Upload your plist file in the "Preferences" field.
- Ensure that all variables, such as
Secret
,$UDID
and$DEVICENAME
, are correctly set according to your MDM configuration.
-
Assign the App to Devices:
- Go to the Scope section and select the devices or device groups you want to assign the app to.
-
Save and Deploy:
- Click Save to finalize your changes.
- Jamf Pro will distribute the app and its configuration to the selected Apple TV devices.
Workspace-Based Configuration Plist Example:
<dict>
<key>secret</key>
<string>BcjGlIwoQTFHNFlvm7cxyXJMKuC8ETHf</string>
<key>externalDeviceId</key>
<string>$UDID</string>
<key>deviceName</key>
<string>$DEVICENAME</string>
<key>externalGroupId</key>
<string>$SITEID</string>
<key>groupName</key>
<string>$SITENAME</string>
</dict>
The Workspace-Based Configuration is designed to automatically link devices to your workspace. In this scenario, Kitcast uses the group name and external group ID provided by Jamf (or your MDM provider) to create a corresponding group in your workspace.
This ensures that devices are organized into groups that match the structure set in your MDM system, eliminating the need to manually configure groups in Kitcast.
This configuration is ideal for setups where devices need to reflect the grouping structure defined in your MDM provider, enabling seamless and automatic group management.
Group-Based Configuration Plist Example:
<dict>
<key>secret</key>
<string>BcjGlIwoQTFHNFlvm7cxyXJMKuC8ETHf</string>
<key>externalDeviceId</key>
<string>$UDID</string>
<key>deviceName</key>
<string>$DEVICENAME</string>
<key>groupId</key>
<string>e22d8abd-5f97-4672-a113-3f9524adef80</string>
</dict>
The Group-Based Configuration allows you to link devices to a specific group in Kitcast.
By specifying the groupId
in the plist, you can ensure that devices are added directly to the desired group. You can copy the plist with the specific group settings from the Kitcast dashboard by hovering over the group, clicking the gear icon, and selecting MDM Info.
This scenario is best suited for cases where you need precise control over group assignments, such as organizing devices by location, department, or function.
Step 5: Verify Screen Linking and Content Playback
- Check Screen Status in Kitcast V2:
- Navigate to Screens in your Kitcast Dashboard.
- Confirm that all screens are listed and linked.
- Assign Content to Groups:
- Go to Content Management.
- Assign playlists or content to the relevant groups.
- Verify on Devices:
- Ensure that screens are displaying the assigned content.
- Check for any error messages or issues on the screens.
Additional Notes
- Custom Values:
- Instead of MDM variables like $SITEID and $SITENAME, you can use custom values if your MDM doesn't support these variables.
- Example: Replace $SITENAME with the actual group name you want in Kitcast V2.
- Group IDs:
To obtain the GroupID for your configuration, follow these steps:
-
Navigate to the Groups section in the Kitcast Dashboard (located in the left-hand menu).
-
Locate the specific group you want to use in your config.
-
Hover over the group's name in the list of all groups.
-
In the dropdown menu that appears, select MDM Info.
-
The plist containing the GroupID and its key will be automatically copied to your clipboard.
-
- Device Identifiers (Screens):
- External Device ID is crucial for matching the device between your MDM and Kitcast screen.
Troubleshooting
- Screens Not Appearing:
- Ensure that the plist configuration is correctly formatted and uploaded.
- Verify that the Secret Key matches the one in your Kitcast V2 account.
- Content Not Playing:
- Check that content is assigned to the correct group.
- Confirm that the screens are online and have internet access.
- MDM Variables Not Substituting:
- Verify that your MDM supports the variables used.
- Replace variables with static values if necessary.
Support
If you encounter any issues or have questions:
- Documentation: Visit Kitcast.tv support for detailed articles and FAQs.
- Contact Us: support@kitcast.tv
Congratulations! You have successfully set up MDM for Kitcast V2. Enjoy seamless digital signage management across all your devices.