From d479f93f49e2997a166eb261d63442225037ce27 Mon Sep 17 00:00:00 2001 From: Roberto Dip Date: Fri, 2 Feb 2024 18:13:07 -0300 Subject: [PATCH] add internal docs to set end user email (#16573) for #15057 --- .../set-up-custom-end-user-email.md | 43 +++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/Contributing/set-up-custom-end-user-email.md diff --git a/docs/Contributing/set-up-custom-end-user-email.md b/docs/Contributing/set-up-custom-end-user-email.md new file mode 100644 index 000000000000..8cdd4d18ce47 --- /dev/null +++ b/docs/Contributing/set-up-custom-end-user-email.md @@ -0,0 +1,43 @@ +# Provide end user email address w/o relying on end user + +In issue #15057, we introduced a feature primarily intended for internal use +that allows the specification of the email for the "Used by" field on the host +details page. This feature supports macOS and Windows, but the method to define +the email differs for each operating system. + +### macOS via configuration profiles + +When `fleetd` starts in macOS, it'll check for the user email in the enrollment profile. + +The enrollment profile contains multiple `` elements. Locate the one with a +`PayloadIdentifier` equal to `com.fleetdm.fleet.mdm.apple.mdm`, and add the +following, replacing foo@example.com with the desired user email: + +```xml +EndUserEmail +foo@example.com +``` + +For instance, the specific part of the payload might look like this: + +```xml +PayloadIdentifier +com.fleetdm.fleet.mdm.apple.mdm +EndUserEmail +foo@example.com +``` + +### Windows via custom installers + +For Windows, we implemented a hidden flag in `fleetctl` that allows you to +define a custom user email when a package is built. + +If provided, `fleetd` will report the user email to the fleet server when it starts. + +``` +$ fleetctl package --type=msi --end-user-email=foo@example.com --fleet-url=https://test.example.com --enroll-secret=abc +``` + +Note: You need to build a different package per user email. + +