Deploy PaperCut Hive and Pocket using Kandji (macOS)

Note: If you’ve already created a Login & Background Items Library Item for PaperCut, you can rename it to reflect a more general use for PaperCut and scope it to appropriate Blueprints.

Use this optional step to accomplish two things at once on a Mac with macOS 13 Ventura or newer:

• prevent users from disabling the PaperCut Print Hive Agent

• prevent macOS from displaying the following alert:
  “Background Items Added. Software from “PaperCut Software International Pty Ltd” added items that can run in the background. You can manage this in Login Items Settings.”

For more details, see Kandji’s support article at: Configure the Login & Background Items Library Item

1. Sign in to your Kandji instance, for example, https://your-company.kandji.io or https://your-company.eu.kandji.io.

2. In the sidebar, select Library.

3. In the upper-right corner, click Add new.

4. Select Login & Background Items.

5. Click Add & Configure.

6. Enter a name such as PaperCut Hive Agent.

7. In the Assignment section, click Select Blueprint, then select the Blueprint or Blueprints to assign this Custom Profile to (you can always change the Blueprint selection later).

8. (Optional) Next to the Rules section, click Add, add one or more Assignment Rules, then click Confirm. Assignment rules limit which devices within the Blueprint will be assigned this Library Item.

9. Click Add Background Item.

10. Click the menu for Identifier Type and select Team Identifier.

11. In the Identifier field, enter B5N3YV5P2H and verify what you’ve entered.

12. Click Save.

You need to download the macOS PaperCut Pocket or PaperCut Hive Computer app and upload this to your prefered cloud storage location, then cerate a Jumpcloud script to deploy it.

You need to add the Jamf Pro Add-on in PaperCut Pocket or Hive in order to be able to download the PaperCut Pocket or Hive Comupter app zip file.

1. From the PaperCut Hive or Pocket admin console, in the left menu select Add-ons.

2. On the Device management tab, locate the Jamf Pro card and click Learn More.
   

3. Click Add.
   

   The Review authorizations popup is displayed.
   

4. Read the points, select the I agree that: checkbox and select Agree to enable this add-on for your organization.

5. Select these instructions to open the instructions, then walk through the steps in your instance of Jamf.

6. Click the Setup instructions tab.
   

7. Under Step 1 click on the Download zip file button to download the PaperCut Hive or PaperCut Pocket Computer app zip file to your computer.

   Note: Ensure that your browser does not decompress the installation file when you download it. For example, in Safari, choose Safari > Settings, click General, then deselect the option “Open ‘safe’ files after downloading.” Click this button to download the .zip file:

8. Close the Jamf Pro add-on instructions page.

9. On the PaperCut Hive Admin console, go to Manage > Edge Mesh and click Add edge nodes.

   

10. Select Manually deploy edge nodes.

11. Under Step 2, click the Copy button to copy the command line, and then paste it into a text editor. You'll need the /systemkey value later.
    

This section also includes optional steps 13-16 to add a Preinstall Script to install Rosetta for a Mac with Apple silicon.

1. Sign in to your Kandji instance, for example, https://your-company.kandji.io or https://your-company.eu.kandji.io.

2. In the sidebar, select Library.

3. In the upper-right corner, click Add new.

4. Select Custom Apps.

5. Click Add & Configure.

6. Enter a name such as PaperCut edge node & Print Client.

7. In the Assignment section, click Select Blueprint, then select the Blueprint or Blueprints to assign this Custom Profile to (you can always change the Blueprint selection later).

8. (Optional) Next to the Rules section, click Add, add one or more Assignment Rules, then click Confirm. Assignment Rules limit which devices within the Blueprint will be assigned this Library Item.

9. In the Installation section, select the installation method required from the drop-down menu. You can choose your deployment method from 1 of the 3 available deployment methods below;

   Install once per device

   This installs the client once only.

   Install on-demand from Self Service

   Allow the user to install the client using the self-service option.

   Audit and enforce

   Use an audit script to check for files, folders, apps, settings, and more. A failed audit script will trigger a package (re-)installation. Failure is detected when a script's exit code is anything other than 0. An example of a bash audit script for PaperCut Hive is:

   #!/bin/bash
   #
   # Audit script for Kandji — verifies four PaperCut Hive files using mdfind
   
   files=(
     "/Library/PaperCut Hive/data/config/cloud-region.conf"
     "/Library/PaperCut Hive/data/config/coordinator.ident"
     "/Library/PaperCut Hive/pc-edgenode-service.conf"
     "/Library/PaperCut Hive/pc-edgenode-service"
   )
   
   missing=()
   
   for file in "${files[@]}"; do
     if ! mdfind -onlyin "/Library/PaperCut Hive" -name "$(basename "$file")" | grep -Fxq "$file"; then
       missing+=("$file")
     fi
   done
   
   if [[ ${#missing[@]} -eq 0 ]]; then
     echo "PASSED: All required PaperCut Hive files are present."
     exit 0
   else
     echo "FAILED: The following file(s) are missing:"
     for f in "${missing[@]}"; do
       echo "- $f"
     done
     exit 1
   fi
   

10. (Optional) Configure the Self Service section.

11. In the Install details section, select ZIP File.

12. In the Unzip Location field, enter /var/tmp; the script expects the installation folder to be in that location.

13. Below the Unzip Location section, click Add Preinstall Script.

14. In a different web browser tab, visit the page that contains Kandi’s script that installs Rosetta if it’s not already installed: https://github.com/kandji-inc/support/blob/main/Scripts/InstallRosetta2.sh

15. Click the Copy raw contents button, which looks like two squares, and is displayed to the left of the Trash button.

16. In the Custom Apps Library Item that you are working on in Kandji, in the Preinstall Script field, paste the script you just copied.

17. In the ZIP File section, click the click to upload link.

18. In the Choose Files to Upload window, navigate to the folder that contains your .zip file.

19. Select the papercut-hive.zip file.

20. Click Upload.

21. Click Add Postinstall Script.

22. Copy the following script by clicking the Copy button. Note that this script needs to be updated by replacing 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' with the value of your organisations 'systemkey' you noted down earlier.

23. Replace 'yy' with the regional data center region code, for example, au,ca, us,eu,uk, & 'zz' with the orgId of your organization.
    

    #!/usr/bin/env zsh
    
    # Kandji automatically unzips the zip file in the Unzip Location.
    # Change the following if you change the Unzip Location.
    HIVE_INSTALLER_PATH="/var/tmp/hive_installer"
    
    # Get the current logged in user excluding loginwindow, _mbsetupuser, and root
    current_user=$(/usr/sbin/scutil <<<"show State:/Users/ConsoleUser" |
    /usr/bin/awk '/Name :/ && ! /loginwindow/ && ! /root/ && ! /_mbsetupuser/ { print $3 }' |
    /usr/bin/awk -F '@' '{print $1}')
    
    # Make sure that we can find the most recent logged-in user
    if [[ $current_user == "" ]]; then
    # Because someone other than the current user was returned, we are going to look at
    # who uses this Mac the most, then set the current user to that user.
    current_user=$(/usr/sbin/ac -p | /usr/bin/sort -nk 2 |
    /usr/bin/grep -E -v "total|admin|root|mbsetup|adobe" | /usr/bin/tail -1 |
    /usr/bin/xargs | /usr/bin/cut -d " " -f1)
    fi
    
    # Install the PaperCut edgenode with system administrator privileges
    # This code is private to your PaperCut organisation. Please do not share it
    # Replace 'yy' with the regional data centre region  code e.g. au,us,eu,uk
    # Replace 'zz' with your orgID
    cd ${HIVE_INSTALLER_PATH}
    ./install.sh xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx yy zz
    
    # Install the PaperCut client as the current user
    /usr/sbin/chown -R $current_user ${HIVE_INSTALLER_PATH}
    /usr/bin/su - "$current_user" -c "cd ${HIVE_INSTALLER_PATH} && ./install.sh install_client"
    

24. In the Postinstall Script field, paste the script you copied in the previous step.

25. Click Save.

Log in to a Mac that is in a Blueprint that contains the Library Items that you just configured.

1. (Optional) The Login & Background Items Library Item should be automatically deployed as soon as you create and save the Library Item. To confirm this, open System Settings > Profiles (for macOS 13 Ventura or newer) or System Preferences > Profiles (for macOS 12 Monterey or earlier) to confirm the Login Items Policy profile is displayed.

2. (Optional) If you've configured the Custom Apps Library Item to be available in Self Service, it should be automatically deployed and available in Self Service within 15 minutes. To force the Kandji Agent to check in and install the Custom App Library Item immediately, use the following steps:

   1. Open the Kandji Self Service app.

   2. In the sidebar click Device Info.

   3. Click Sync.

3. Open System Settings > Printers & Scanners (for macOS 13 Ventura or newer) or System Preferences > Printers & Scanners (for macOS 12 Monterey or earlier).

4. Confirm that the PaperCut Printer is displayed.

5. Open the PaperCut Hive invite email for the user and click on the link in that email. This will cause the PaperCut Hive print client on that macOS device to be linked to that user.

6. Send a test print job and validate in your PapetrCut Hive Admin dashboard in the Job Log you can see the job and it is linked to the correct user.