Iru Custom Apps

iru:
  # Your Iru API base URL.
  # You can find it in Settings > Access, e.g.
  # US: https://SubDomain.api.kandji.io
  # EU: https://SubDomain.api.eu.kandji.io
  #
  # Required.
  # Templates: allowed.
  url: https://mycompany.api.kandji.io

  # Name of the Custom App in the Library.
  #
  # If more than one artifact matches, each one is published as its own
  # Custom App, so make sure the name is unique per artifact, e.g. by using
  # templates like {{ .Os }} or {{ .Arch }}.
  #
  # Default: the project name.
  # Templates: allowed (artifact fields available).
  name: "My App {{ .Version }}"

  # IDs of the artifacts to publish.
  #
  # Custom Apps only install on macOS, so artifacts for other operating
  # systems are ignored. Each selected artifact must have the extension
  # matching install_type, i.e. .zip by default.
  #
  # Default: all uploadable archives and binaries.
  ids:
    - macos-pkg

  # API token.
  #
  # Default: the $IRU_API_TOKEN environment variable.
  # Templates: allowed.
  api_token: "{{ .Env.MY_IRU_TOKEN }}"

  # ID of an existing Custom App library item to update instead of creating
  # a new one on every release.
  #
  # A Custom App holds a single file, so exactly one artifact must match:
  # for a multi-architecture macOS build, either select one artifact with
  # ids, or build a universal binary.
  # See "Updating an existing Custom App" below.
  #
  # Templates: allowed.
  library_item_id: 58429143-b55c-42d3-a9a3-7c699ddd0ce1

  # How the file should be installed. Selected artifacts must have the
  # matching file extension: .pkg, .zip, or .dmg.
  #
  # The API requires this field, GoReleaser defaults it to zip, which fits
  # a macOS zip archive from the archives section. Set package or image
  # when you publish a .pkg or .dmg.
  #
  # Valid options: package, zip, image.
  # Default: zip.
  install_type: zip

  # Installation enforcement.
  #
  # The API requires this field, GoReleaser defaults it.
  #
  # Valid options: install_once, continuously_enforce, no_enforcement.
  # Default: install_once.
  install_enforcement: install_once

  # Path to extract a zip file to.
  #
  # Required if install_type is zip, and only allowed with it.
  unzip_location: /Applications

  # Audit script.
  #
  # Required if install_enforcement is continuously_enforce, and only
  # allowed with it.
  audit_script: ""

  # Script to run before the install.
  preinstall_script: ""

  # Script to run after the install.
  postinstall_script: ""

  # Whether to show the app in Self Service.
  #
  # Required if install_enforcement is no_enforcement.
  show_in_self_service: false

  # Self Service category ID to display the app in.
  #
  # Required if show_in_self_service is true, and only allowed with it.
  # Templates: allowed.
  self_service_category_id: ""

  # Whether to flag the app as recommended in Self Service.
  #
  # Requires show_in_self_service.
  self_service_recommended: false

  # Whether the Custom App is active and installable.
  #
  # Default: true, applied by the API when creating.
  active: true

  # Whether to restart the device after a successful install.
  restart: false

  # Whether to disable this feature.
  #
  # Templates: allowed.
  disable: "{{ .IsSnapshot }}"