Skip to content

Preferences

Rod Christiansen edited this page Oct 8, 2026 · 2 revisions

Preferences

BootstrapMate for Windows is configured through the registry: a policy key that Intune or Group Policy writes, a machine settings key that the MSI, the GUI and administrators write, and a protected key that holds the two credential headers. There is no per-user settings source. This page is the reference for every value name, where it lives and what it does.

Precedence

ConfigManager builds one effective configuration per run. Sources are applied lowest first, so a later source overwrites an earlier one:

  1. The default manifest URL compiled into the binary
  2. HKLM\SOFTWARE\BootstrapMate\Settings
  3. HKLM\SOFTWARE\Policies\BootstrapMate, the policy and Intune CSP key
  4. HKLM\SOFTWARE\BootstrapMate\Secrets, for AuthorizationHeader and ReportingHeader only
  5. Command-line switches

Policy beats machine settings, and a command-line switch beats both. Both keys are read from the 64-bit registry view only. A copy of the settings key under WOW6432Node is stale: the MSI removes it, and the first elevated run removes it once, logging the value names it removed. The policy key is shared between the two views and is never removed.

ManagementDetector resolves policy value names through an alias table, so some keys accept more than one spelling. The aliases are listed per setting below. A value present under the policy key also makes the GUI show that control as Managed by Policy and refuse to edit it, and --save-settings skip it.

Registry locations

Purpose Path Who can read it
Policy / Intune CSP (wins over settings) HKLM\SOFTWARE\Policies\BootstrapMate Every user
Machine settings HKLM\SOFTWARE\BootstrapMate\Settings Every user
Credential headers HKLM\SOFTWARE\BootstrapMate\Secrets SYSTEM and Administrators only

The Intune OMA-URI form documented in the ADMX is:

./Device/Vendor/MSFT/Policy/Config/BootstrapMate~Policy~BootstrapMate/{ValueName}

String values are REG_SZ. Boolean values are REG_DWORD 1 or 0; the loader also accepts a REG_SZ that parses as a boolean, and under the policy key one that parses as an integer. Integer values are REG_DWORD.

Credential headers

AuthorizationHeader and ReportingHeader carry credentials, so they live in HKLM\SOFTWARE\BootstrapMate\Secrets, whose ACL admits only SYSTEM and Administrators. Deliver a header through policy as usual. On the next elevated run, before the configuration loads, BootstrapMate moves it into the protected key:

  • A header found under the settings key is moved and deleted from settings.
  • A header found under the policy key, under any of its aliases, is moved and the policy value is set to an empty string. It is emptied rather than deleted so the setting still shows as managed.

Each move is logged as a warning naming the setting and where it came from, never the value. A process that is not elevated cannot read the protected key and treats the header as unset. BootstrapMate never writes a header to its log, session.json or last-run.json, and it redacts --headers from every command line it logs.

Summary

Key Type Default Summary
ManifestUrl String built-in default URL The manifest to download and run
AuthorizationHeader String none Authorization header, sent to the manifest host only
SilentMode Boolean 0 No console output
VerboseMode Boolean 0 Debug lines on the console
DryRun Boolean 0 Refuse to run
EnableDialog Boolean 1 0 turns the progress dialog off
NoDialog Boolean 0 1 turns the progress dialog off
DialogTitle String Setting Up Your Device Progress dialog title
DialogMessage String Please wait while we install required software... Progress dialog message
DialogIcon String none Progress dialog icon
BlurScreen Boolean 0 Progress dialog full screen
CustomInstallPath String C:\Program Files\BootstrapMate Read, but no code path uses it
NetworkTimeout Integer 120 Manifest timeout and download stall timeout, seconds
BaselineMinIntervalHours Integer 144 Minimum hours between completed baseline runs
ReportingUrl String none POST target for the run summary
ReportingHeader String none Authorization header on the reporting POST
VerifyPackageSignatures Boolean 1 Authenticode-gate MSI and EXE installers
ExpectedPublisher String none Require the signer to contain this value
AllowUnsigned Boolean 0 Permit an untrusted or unsigned installer

Connection

ManifestUrl

  • Type: String
  • Default: a URL compiled into the build
  • Policy aliases: ManifestUrl, url, jsonUrl, JsonUrl, ConfigURL, BootstrapUrl

The URL BootstrapMate downloads and runs. Setting it removes the need to pass --url.

The MSI writes the build's default URL to HKLM\SOFTWARE\BootstrapMate\Settings\ManifestUrl on every install and upgrade, so a URL is always resolvable and a value you write to that key by hand is reset on the next upgrade. Set your own URL through policy, which wins over settings. See Serving Manifests and Packages.

AuthorizationHeader

  • Type: String
  • Default: none
  • Stored in: HKLM\SOFTWARE\BootstrapMate\Secrets
  • Policy aliases: AuthorizationHeader, headers, Headers

The complete value of an Authorization request header, sent verbatim, so include the scheme (for example Bearer <token>). Deliver it through policy or the GUI; see Credential headers for where it ends up.

It is attached to the manifest request, and to a package download only when the package URL's host matches the manifest URL's host, compared case-insensitively. A package hosted anywhere else is fetched without it, and the run logs Authorization header withheld for cross-host download: {url} at Debug level. This keeps the credential away from third-party hosts, and avoids the 403 Forbidden some object stores return for a public object requested with an Authorization header they cannot validate.

--headers <value> sets it for a single run.

Behavior

SilentMode

  • Type: Boolean
  • Default: 0
  • Policy aliases: SilentMode, silent

Suppresses console output, as --silent does. When it is on, a command line without --silent does not turn it off.

VerboseMode

  • Type: Boolean
  • Default: 0
  • Policy aliases: VerboseMode, verbose

Writes Debug lines to the console, as --verbose does. The log file always receives Debug lines. When it is on, a command line without --verbose does not turn it off.

DryRun

  • Type: Boolean
  • Default: 0

BootstrapMate has no simulated install, so DryRun is honoured by refusing to run: every run, the scheduled task included, logs an error and exits 1 without installing anything. Leave it off except to deliberately stop a device from running.

Dialog

The progress dialog is an optional external binary, csharpDialog, at C:\Program Files\csharpDialog\dialog.exe. When it is absent every dialog call is a no-op and the only trace is a Debug log line. The dialog opens only on a run that provisions; a run whose preflight chose Skip or Baseline shows nothing. See Preflight and Baseline.

EnableDialog

  • Type: Boolean
  • Default: 1

0 turns the dialog off on every run, whatever the command line says.

NoDialog

  • Type: Boolean
  • Default: 0

1 turns the dialog off, as --no-dialog does. It is applied when the run takes its URL from configuration rather than --url. It is read from policy and settings but is not in the ADMX; use EnableDialog from a policy editor.

DialogTitle

  • Type: String
  • Default: Setting Up Your Device

The dialog title. Applied when the run takes its URL from configuration; --dialog-title sets it for a run started with --url.

DialogMessage

  • Type: String
  • Default: Please wait while we install required software...

The dialog message. Applied the same way as DialogTitle; --dialog-message is the command-line form.

DialogIcon

  • Type: String
  • Default: none

Path to an .ico or .png passed to the dialog as --icon. Applied on every run.

BlurScreen

  • Type: Boolean
  • Default: 0

Passes --fullscreen to the dialog so it covers the screen behind it, as --blur-screen does. Applied when the run takes its URL from configuration.

Advanced

CustomInstallPath

  • Type: String
  • Default: C:\Program Files\BootstrapMate
  • Policy aliases: CustomInstallPath, InstallPath, iapath

Read into the configuration and shown in the GUI, but no code path uses it. The install location is fixed by the MSI.

NetworkTimeout

  • Type: Integer (seconds)
  • Default: 120
  • Range: clamped to 10-600

The timeout for the manifest request, and how long a package download may go without receiving data before the attempt fails and is retried. A large package keeps downloading for as long as data keeps arriving, up to 30 minutes per attempt. See Retries and Timeouts.

BaselineMinIntervalHours

  • Type: Integer (hours)
  • Default: 144
  • Range: 0-8760 in the ADMX; 0 disables the limit for completed baselines

The minimum time between completed baseline runs. A failed baseline gets one retry after 24 hours whatever this says, and provisioning runs are never limited. The full rule is on Preflight and Baseline.

Reporting

ReportingUrl

  • Type: String
  • Default: none
  • Policy aliases: ReportingUrl, ReportURL, reportingUrl

Where to POST the run summary. When empty, no report is sent. The POST fires at the end of every run that reached the manifest, never fails the run, and times out after 15 seconds. See Logging and Reporting for the payload.

ReportingHeader

  • Type: String
  • Default: none
  • Stored in: HKLM\SOFTWARE\BootstrapMate\Secrets
  • Policy aliases: ReportingHeader, ReportingAuthorizationHeader

Sent verbatim as the Authorization header on the reporting POST. Unlike AuthorizationHeader, it is not host-scoped; it goes to whatever ReportingUrl names.

Security

VerifyPackageSignatures

  • Type: Boolean
  • Default: 1
  • Policy aliases: VerifyPackageSignatures, VerifySignatures

Turns on the Authenticode gate for downloaded msi and exe installers. 0 turns it off for every item. See Security and Package Verification.

ExpectedPublisher

  • Type: String
  • Default: none
  • Policy aliases: ExpectedPublisher, Publisher

When set, the signer certificate's common name (or its full subject when no CN can be read) must contain this string, compared case-insensitively. It is a substring test. A manifest item may override it with its own expectedPublisher.

AllowUnsigned

  • Type: Boolean
  • Default: 0

Permits an installer whose signature is missing, tampered with, or does not chain to a trusted root, with a warning in the log. A publisher mismatch is never permitted. A manifest item may override it with its own allowUnsigned.

Retired settings

FollowRedirects and Reboot are not settings. A value still set to 1 for either, in policy or settings, is logged as a warning (Setting FollowRedirects (policy) is ignored: it was never implemented and has been removed) and otherwise ignored. Redirects are always followed, and BootstrapMate never restarts the machine.

The ADMX and ADML templates

resources/BootstrapMate.admx and resources/en-US/BootstrapMate.adml define 18 policies for Group Policy and Intune ADMX ingestion: ManifestUrl, AuthorizationHeader, SilentMode, VerboseMode, DryRun, EnableDialog, DialogTitle, DialogMessage, DialogIcon, BlurScreen, CustomInstallPath, NetworkTimeout, BaselineMinIntervalHours, ReportingUrl, ReportingHeader, VerifyPackageSignatures, ExpectedPublisher and AllowUnsigned. Every policy is class="Machine" and targets SOFTWARE\Policies\BootstrapMate. Boolean policies write 1 when enabled and 0 when disabled. CI parses both files as XML on every build.

For Group Policy, copy them to the usual locations on the machine or in the central store:

C:\Windows\PolicyDefinitions\BootstrapMate.admx
C:\Windows\PolicyDefinitions\en-US\BootstrapMate.adml

Inspecting the effective configuration

Read the policy and settings keys. The Secrets key needs an elevated shell, and its values are credentials, so do not paste them anywhere.

Get-ItemProperty 'HKLM:\SOFTWARE\Policies\BootstrapMate'
Get-ItemProperty 'HKLM:\SOFTWARE\BootstrapMate\Settings'

See also

Clone this wiki locally