Documentation Index
Fetch the complete documentation index at: https://docs.velatir.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview
The Velatir desktop client is built for organisation-wide rollouts. This page covers silent installation, MDM integration with Microsoft Intune and Jamf Pro, bring-your-own-CA distribution, and version pinning. On MDM-enrolled Macs, a signed Configuration Profile pre-installs the Velatir root CA, the API key, and the network extension allowlist, so the package itself can install with no end-user prompts. On Windows, the same outcome is achieved by setting MSI properties on the deployment policy. For single-device installation, see Download and install instead.Prerequisites
- Administrator access to your MDM platform (Microsoft Intune, Jamf Pro, or equivalent)
- A Velatir project API key from Dashboard > Settings > API Keys
- Network reachability from managed devices to
api.velatir.comand Velatir’s update storage
Installer Details
| Platform | Artefact | Architecture |
|---|---|---|
| Windows | Velatir-Bootstrap-<arch>.msi | x64, arm64 (separate packages per architecture) |
| macOS | Velatir-Bootstrap-macos-<arch>.pkg | Apple Silicon and Intel (separate packages per architecture) |
Download URLs
Each URL serves the latest published version. Pin to a specific version by replacinglatest with the version string if your change-management process requires it.
| Asset | URL |
|---|---|
| Windows MSI (x64) | https://releases.velatir.com/velatir-agents/windows-x64/latest/Velatir-Bootstrap-x64.msi |
| Windows MSI (arm64) | https://releases.velatir.com/velatir-agents/windows-arm64/latest/Velatir-Bootstrap-arm64.msi |
| macOS package (Apple Silicon) | https://releases.velatir.com/velatir-agents/macos-arm64/latest/Velatir-Bootstrap-macos-arm64.pkg |
| macOS package (Intel) | https://releases.velatir.com/velatir-agents/macos-x64/latest/Velatir-Bootstrap-macos-x64.pkg |
MSI Properties (Windows)
| Property | Required | Description |
|---|---|---|
VELATIR_API_KEY | Recommended | Stage the API key at install time. Hidden from MSI logs. |
VELATIR_BYO_CA_PATH | No | Path to a PFX bundle deployed alongside the MSI for bring-your-own-CA installations. |
VELATIR_BYO_CA_PASSWORD | No | Password for the PFX bundle above. |
Package Parameters (macOS)
The macOS package supports three silent-configuration paths, checked in this order at install time. A Configuration Profile is the recommended path because it eliminates every installer prompt on MDM-enrolled devices and supports key rotation without reinstall.| Method | Recommended for | Behaviour |
|---|---|---|
Configuration Profile with com.apple.ManagedClient.preferences payload (domain com.velatir.agent) | Organisation-wide MDM rollouts | Provisions ApiKey and ApiBaseUrl to /Library/Managed Preferences/. The agent reads this on every start and prefers it over the local settings file, so profile updates rotate the key without reinstalling the package. |
/var/tmp/velatir-bootstrap.config (key=value file pre-staged before installer) | MDM platforms that run a pre-install script before the package | One-time configuration written into /Library/Application Support/Velatir/appsettings.local.json during install. The preinstall script reads the file and deletes it. |
Environment variables on installer | Ad-hoc unattended installs from the command line | One-time configuration written into the same settings file. |
| Key | Required | Description |
|---|---|---|
VELATIR_API_KEY | Recommended | The project API key from the Velatir dashboard. |
VELATIR_API_BASE_URL | No | Override the backend URL. Defaults to https://api.velatir.com/api/v1. |
Unattended Command-Line Install
installer:
sudo velatir set-api-key --key vltr_... after install. The agent reports ApiKey missing until configured.
Microsoft Intune (Windows)
Deploy as a Line-of-Business app or as a Win32 app for richer detection logic. The Line-of-Business path is the simplest and is recommended for most organisations.Line-of-Business App
Upload the MSI
Sign in to the Microsoft Intune admin centre, then go to Apps > All apps > Add.Select Line-of-Business app as the app type and upload the MSI that matches your fleet architecture (
Velatir-Bootstrap-x64.msi or Velatir-Bootstrap-arm64.msi).Configure app information
Fill in:
- Name: Velatir for Desktop Applications
- Description: Velatir AI compliance desktop agent
- Publisher: Velatir
- Ignore app version: No
Assign to device groups
On the Assignments tab, add the device groups you want to deploy to. The MSI requires administrator rights on the device; Intune handles elevation automatically when assigned in Required mode.
Rotating the API Key
To rotate the API key, update the Command-line arguments with the new value and redeploy. The MSI overwrites the existing key and restarts the host:Configuration Profile (macOS)
A single signed.mobileconfig profile carries everything the desktop client needs to deploy with no installer prompts: root CA trust, the API key, and pre-approval for the network system extension. Push the profile through your MDM platform alongside the .pkg. On MDM-enrolled devices the profile installs silently; the agent then reads its configuration from the managed preferences domain on first launch.
Profile Payloads
| Payload Type | Purpose |
|---|---|
com.apple.security.root | Trusts the Velatir root CA in the System keychain. Eliminates the “changes to System Certificate Trust” prompt during install. |
com.apple.ManagedClient.preferences (domain com.velatir.agent) | Provisions ApiKey and ApiBaseUrl as managed preferences. Updates propagate without reinstalling the package. |
com.apple.system-extension-policy | Pre-approves the Velatir network extension by Team Identifier. Eliminates the system extension approval prompt for end users. |
Profile Template
The skeleton below covers the root CA payload and the managed preferences payload. Replace eachPayloadUUID with a fresh value from uuidgen, embed the base64-encoded Velatir root CA, and substitute your API key.
velatir-root.cer and is published alongside the package. Base64-encode the DER form to embed it in the profile:
PayloadContent array. Velatir’s Team Identifier is AA7QLU3S4R.
Signing the Profile
Sign the profile so your MDM platform deploys it without “unsigned profile” warnings:On Macs that are not enrolled in an MDM, end users must manually approve the profile in System Settings > Privacy & Security > Profiles. Apple removed the silent-install path for unenrolled devices in macOS 11, so silent profile install is only supported on MDM-enrolled Macs.
Jamf Pro (macOS)
Jamf Pro deploys the Velatir Configuration Profile first, then the signed PKG. Once both are scoped to the same device group, every new device receives the desktop client with no end-user interaction.Upload and scope the Configuration Profile
In Jamf Pro, go to Computer Management > Configuration Profiles > Upload, then upload the signed
velatir.mobileconfig from the previous section.Scope the profile to the device groups that will run Velatir. Use the Distribution Method Install Automatically so the profile lands before the package.The profile delivers the root CA trust, the API key, and the network extension allowlist in a single signed payload.Upload the PKG
In Computer Management > Packages > New, upload the PKG that matches your fleet:
Velatir-Bootstrap-macos-arm64.pkgfor Apple Silicon devicesVelatir-Bootstrap-macos-x64.pkgfor Intel devices
Processor Type) to assign each package to the appropriate devices.Create the install policy
Create a policy that installs the package on the same scope as the profile. Trigger on Recurring Check-in with execution frequency Once per computer.No additional script policy is required for staging the API key — the agent reads it directly from the managed preferences delivered by the Configuration Profile.
Rotating the API Key
Update theApiKey string in the Configuration Profile and re-upload it. Devices apply the new profile on their next check-in and the agent picks up the rotated key on its next start. The package does not need to be reinstalled.
Microsoft Intune (macOS)
Intune deploys the same two artefacts: the Configuration Profile (as a Custom configuration profile) and the PKG (as a line-of-business app).Push the Configuration Profile
In the Microsoft Intune admin centre, go to Devices > Configuration > Create > New policy.Choose macOS as the platform and Templates > Custom as the profile type. Upload the signed
velatir.mobileconfig from the Configuration Profile section above.Assign to the device groups that will run Velatir.Upload the PKG as a line-of-business app
Go to Apps > macOS > Add and choose Line-of-business app. Upload the PKG that matches your fleet:
Velatir-Bootstrap-macos-arm64.pkgfor Apple Silicon devicesVelatir-Bootstrap-macos-x64.pkgfor Intel devices
- Name: Velatir for Desktop Applications
- Publisher: Velatir
- Ignore app version: No
Assign to device groups
Scope the app assignment to the same device groups that received the Configuration Profile. Use Required so devices install on their next sync.No additional configuration script is required — the agent reads the API key from the managed preferences delivered by the profile.
Bring Your Own Certificate Authority
Organisations that already operate an internal certificate authority can supply their own CA instead of using the Velatir-issued one. The desktop client uses it as the local MITM authority, so existing trust stores on managed devices do not need a new root. See the dedicated Bring Your Own Certificate page for the full setup, including the certificate format, single-device installation, Intune and Jamf Pro distribution, and rotation guidance.Version Pinning
By default the agent applies new payloads automatically as they become available. For organisations that prefer to coordinate desktop-app updates with their own change-management process, contact support to enable a per-tenant update channel that the agent will use exclusively. This is the supported way to delay or stagger updates across the organisation.Operational Recommendations
- Pilot first. Deploy to a small ring (10–50 users covering representative AI tooling) for two weeks before fleet-wide rollout.
- Monitor with
velatir status --json. A simple Intune Remediation or Jamf extension attribute that runsvelatir status --jsonon each check-in surfaces drift across the fleet. - Watch the dashboard, not the device. Once the desktop client is installed, all visibility flows through your Velatir dashboard. Local logs are useful for debugging individual machines, not for fleet health.
- Rotate keys through the profile, not the package. On macOS, update the
ApiKeyvalue in the Configuration Profile and re-upload it. Devices apply the new managed preference on their next MDM check-in and the agent picks it up on its next start, without a package reinstall. - Document your CA story. If you use bring-your-own CA, ensure your IT runbooks describe how to rotate it; the desktop client will follow the rotation automatically but only if you redeploy the bundle.
Next Steps
Permissions
Detailed reference for the permissions the installer requests.
CLI reference
Reference for the
velatir commands that read and rotate configuration.Troubleshooting
Diagnose failures during scaled rollouts.
VPN compatibility
Behaviour alongside corporate VPNs.