> For the complete documentation index, see [llms.txt](https://academy.shade.inc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://academy.shade.inc/enterprise/deploying-the-shade-pkg-to-jamf-pro.md).

# Deploying the Shade PKG to Jamf Pro

This guide walks through downloading the Shade installer package (PKG) and uploading it into Jamf Pro so it can be deployed to Macs.

{% hint style="info" %}
For the latest documentation, please refer to [Jamf Pro's PKG Documentation](https://learn.jamf.com/r/en-US/jamf-pro-documentation-current/Viewing_the_Contents_of_an_Indexed_Package)
{% endhint %}

#### Prerequisites

* Access to Jamf Pro with permissions to upload packages (typically **Jamf Pro Server Administrator** or a role that can manage Packages).
* A Mac with a browser that can download the installer.
  * If you are downloading the macOS app, Shade recommends using a browser other than Safari.

#### 1) Download the Shade PKG

1. Open: <https://shade.inc/download>
2. Under **Download Shade**, choose the correct build for your Mac:
   * **macOS (Apple Silicon)** for M-series Macs (M1, M2, M3, M4)
   * **macOS (Intel)** for Intel Macs
3. Download the installer file.
4. Confirm the download completed and you have a single installer file to upload (for example, in **Downloads**).

#### 2) (Recommended) Validate the package before upload

1. Verify you downloaded the correct architecture (Apple Silicon vs Intel).
2. Make sure the file:
   * Opens or installs successfully on a test machine.
   * Has a reasonable file size (not suspiciously small).
3. Rename the file to something clear and versioned (recommended), for example:
   * `Shade-Desktop-<version>.pkg`

#### 3) Upload the PKG to Jamf Pro

1. Sign in to **Jamf Pro**.
2. Go to **Settings**.
3. Navigate to the **Packages** section (sometimes listed under **Computer Management** depending on your Jamf Pro version).
4. Click **New** or **Upload** (label varies by Jamf Pro version).
5. In the upload form, select the Shade PKG you downloaded.
6. Configure key **Package Settings** (common options):
   * **Display Name**: Use a clear name (for example, `Shade`).
   * **Category**: Optional, but helpful for organization (for example, `Applications`).
   * **Priority**: Keep the default unless you have multiple dependent packages.
   * **OS Requirements**: Set minimum macOS version if your environment requires it.
   * **Architecture**: If Jamf allows specifying it, match the package you downloaded (Apple Silicon vs Intel).
7. Save.
8. Wait for the upload to finish, then confirm the package appears in the **Packages** list.

#### 4) Confirm the package is available for deployment

1. Open the uploaded package in Jamf Pro.
2. Confirm:
   * The package name and details look correct.
   * The package shows as successfully uploaded (no errors).

#### 5) Next steps (optional): Deploy to devices

After the PKG is uploaded, you can deploy it using one of these approaches:

* **Policy**: Install Shade on demand (Self Service) or automatically (recurring check-in, enrollment).
* **PreStage enrollment**: Install during enrollment workflows.

#### Deploy via Self Service (On-Demand)

Use this method if you want Shade to be available in the Jamf Self Service app, allowing users to choose when to install it.

1. **Create a New Policy**: In Jamf Pro, go to **Computers** > **Policies** and click **New**.
2. **General Payload**:
   * **Display Name**: `Install Shade`
   * **Trigger**: None (Self Service policies do not require a system trigger).
   * **Execution Frequency**: `Ongoing` (this allows users to re-install the app if they move to a new machine or accidentally delete it).
3. **Packages Payload**:
   * Click **Configure** and find your uploaded Shade PKG.
   * Ensure the Action is set to **Install**.
4. **Self Service Payload**:
   * Click the **Self Service** tab at the top.
   * Check the box **Make the policy available in Self Service**.
   * **Self Service Display Name**: `Shade`
   * **Button Name**: `Install`
   * **Description**: Provide a brief description (e.g., "Shade is your creative asset manager...").
   * **Icon**: Upload the Shade application icon for a professional look.
5. **Scope**:
   * Click the **Scope** tab.
   * Add the specific computers or Smart Groups (e.g., "All Managed Clients") that should see Shade in their Self Service catalog.
6. **Save**.

***

#### Deploy via Silent Install (Automatic)

Use this method if you want Shade to be installed automatically on background Macs without any user interaction.

1. **Create a New Policy**: In Jamf Pro, go to **Computers** > **Policies** and click **New**.
2. **General Payload**:
   * **Display Name**: `Deploy Shade - Automatic`
   * **Trigger**: Select **Recurring Check-in** (this is the standard trigger for silent background deployments).
   * **Execution Frequency**: Select **Once per computer**.
3. **Packages Payload**:
   * Click **Configure** and find your uploaded Shade PKG.
   * Ensure the Action is set to **Install**.
4. **Maintenance Payload**:
   * Click **Configure** and check the **Update Inventory** box. This ensures that Jamf knows the app is installed immediately after the policy runs.
5. **Scope**:
   * Click the **Scope** tab.
   * Add the computers or Smart Groups that require Shade.
   * *Tip: Use a Smart Group that targets computers where "Shade.app" is not currently installed.*
6. **Save**.

***

#### Verify Deployment

After saving your policy, you can monitor its progress:

* **Logs**: Open the policy in Jamf Pro and click the **Logs** button at the bottom right. This will show you which computers have successfully installed the package and which are still pending.
* **Inventory**: Check an individual computer’s inventory record under **Applications** to confirm `Shade.app` appears in the list.

#### What the Shade PKG Does During Installation

The PKG runs a post-install script with administrator privileges. IT admins should be aware that it:

* Quits any running Shade processes before installing.
* Sets the permissions on the ShadeFS helper inside the Shade app (owned by root with the setuid bit), which ShadeFS needs to mount drives.
* Adds a `fuse-t` entry pointing to the local machine (127.0.0.1) to the macOS hosts file, if it isn't already there. The built-in FUSE-T mount backend requires this entry.
* Downloads the ShadeFS XPC service from `storage.googleapis.com` and registers it as a LaunchAgent (`inc.shade.xpc`) for the logged-in user. **This requires network access at install time.** If the download fails, the install still completes, but the Shade Finder extension won't work.
* Registers and enables the Shade Finder extension.
* Removes any copy of the Shade Premiere Pro panel installed by older PKGs. The panel is now distributed through Adobe Exchange.

#### Updating Shade on Managed Macs

On macOS, in-app updates download a new PKG and open it in the macOS Installer, so the person installing the update needs administrator rights. If your users don't have admin rights, plan to deploy new Shade versions through Jamf.

#### Troubleshooting Tips

* **Architecture Mismatch**: If a silent install fails, verify that you haven't deployed an Intel PKG to an Apple Silicon (M1/M2/M3) Mac.
* **File Vault**: If you are deploying during Enrollment (PreStage), ensure the "Fill User Template" or "At Restart" options are NOT selected, as Shade should be installed into the `/Applications` folder normally.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://academy.shade.inc/enterprise/deploying-the-shade-pkg-to-jamf-pro.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
