通过 MDM 部署
如果你使用 Jamf Pro、Kandji 或 Microsoft Intune 等设备管理(MDM)工具管理 Mac,就可以用许可证密钥文件在这些 Mac 上激活 VMPal。VMPal 会在启动时或文件发生变化时读取该文件,并自动激活其中的密钥。你还可以强制要求使用你所在组织的密钥,这样不使用它就无法使用 VMPal。在许可证管理页面中,你还可以关闭某些功能,并选择 Mac 要更新到的版本。VMPal for Windows 同样会读取密钥文件,参见在 Windows PC 上。
许可证密钥文件和下文介绍的限制需要支持它们的 VMPal 版本。旧版本会忽略它们。
创建密钥文件
密钥文件是名为 .vmpallicensekey 的纯文本文件。把你的许可证密钥写在第一行:
VP-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
require: true
require 这一行是可选的:
require: true:在密钥激活之前无法使用 VMPal,用户也不能激活其他密钥。require: false,或者没有require行:会激活该密钥,但在你的密钥无法激活时,允许用户保留或激活他们自己的许可证。
一些细节:
- 也可以把密钥写成
key: VP-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX。 require也接受yes和no、1和0,或者on和off,require = true这种写法也可以。其他任何值都视为true。- 以
#开头的行是注释。VMPal 会忽略它不认识的字段。 - 只有空行和注释的文件视同没有文件。有字段但没有密钥的文件会被忽略。例外是
/Users/Shared中的require: true:即使没有密钥,它仍然要求使用密钥,因此在文件中写入密钥之前,VMPal 都无法使用。 - 请以 UTF-8 文本格式保存文件。
安装密钥文件
把文件安装到 /Users/Shared/.vmpallicensekey,让它归 root 所有且只有 root 可写(所有者 root:wheel,权限 0644)。VMPal 随后会为这台 Mac 的所有用户激活该密钥,整台 Mac 只占用一个席位。
以 root 身份运行下面的脚本,例如作为 MDM 策略中的脚本。如果只想激活密钥而不强制要求,请去掉 "require: true"。
#!/bin/sh
set -eu
KEY="VP-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
KEY_FILE="/Users/Shared/.vmpallicensekey"
# Any user can create files in /Users/Shared: write the file under a new name
# only root can change, then move it over whatever is at KEY_FILE. -h replaces
# a link there instead of following it
TMP_FILE=$(mktemp /Users/Shared/.vmpallicensekey.XXXXXX)
printf '%s\n' "$KEY" "require: true" > "$TMP_FILE"
chown root:wheel "$TMP_FILE"
chmod 0644 "$TMP_FILE"
rm -rf "$KEY_FILE"
mv -fh "$TMP_FILE" "$KEY_FILE"
# Fails if a user made a folder there meanwhile: run the script again
[ -f "$KEY_FILE" ] && [ ! -L "$KEY_FILE" ]
请像这个脚本一样,让文件归 root 所有且只有 root 可写。无论
/Users/Shared中的密钥文件归谁所有,VMPal 都会应用它。拥有该文件的用户可以更改或删除它,因此用户能更改的文件会让他们绕过require。请安装文件本身,而不是符号链接:VMPal 会忽略/Users/Shared/.vmpallicensekey处的符号链接。硬链接会被当作文件本身读取:它只是该文件在 Mac 上某处的另一个名称,不会带来任何不同。
VMPal 会把已激活的许可证保存在密钥文件旁边的 /Users/Shared/.vmpallicense 中,这样 Mac 的所有用户共享这个许可证,任何用户都不会另外占用席位。如果你提前创建这个文件,请让所有用户都可以写入(权限 0666)。如果该文件已存在但某个用户无法写入,激活就会失败,并提示“VMPal无法将许可证保存到/Users/Shared。”VMPal 还会在旁边的 .vmpallicensepolicy 中保存许可证所有者最近一次的策略。
你也可以为单个用户安装密钥文件,路径为 ~/Library/Application Support/com.tableplus.VMPal/.vmpallicensekey。VMPal 随后会把该用户的许可证保存在同一个文件夹中。用户可以删除自己文件夹中的文件,因此 VMPal 会忽略那里的 require。/Users/Shared 中的密钥文件优先于用户文件夹中的密钥文件。
用户会看到什么
VMPal 会在启动时读取密钥文件;在运行期间,它会在大约一分钟内发现新的或已更改的密钥文件。
密钥文件位于 /Users/Shared 时 |
VMPal 的行为 |
|---|---|
| 没有许可证 | 不经询问,直接激活你的密钥。 |
| 用户输入过许可证 | 提示“你所在的组织管理着这台Mac上的VMPal”,然后用你的密钥替换用户的许可证进行激活。用户的许可证会从这台 Mac 上移除,其席位也会释放。 |
| 已用你的密钥激活 | 不做任何操作。设置 › 许可证 会显示“VMPal已使用管理员在这台Mac上设置的许可证密钥激活”,以及 激活对象:这台Mac上的所有用户。停用这台Mac 会被隐藏。 |
如果你的密钥无法激活,VMPal 会在“激活许可证密钥****1234”提示中说明原因,其中显示的是你密钥的最后 4 个字符。它会提供:
- 重试:在 VMPal 无法连接许可证服务器,或服务器出现问题时提供。
- 给许可证所有者发邮件:在所有席位都已占用,或许可证的更新期已结束时提供。它会打开一封发给该许可证的辅助许可证管理员的邮件(如果没有辅助许可证管理员,则发给许可证所有者),其中包含密钥的最后 4 个字符、原因、Mac 的名称,以及 macOS 和 VMPal 的版本。
- 下载旧版本:当这个版本的 VMPal 发布于许可证更新期结束之后时提供;下载VMPal:当这个版本已被撤回时提供。两者都会下载该许可证涵盖的最新版本,或你在更新设置中选择的版本。
- 在没有许可证的 Mac 上,除非密钥是强制要求的,还会提供 尝试其他密钥 和 使用免费版。其他情况下提供 好。
VMPal 每次启动最多显示一次这个提示,并会稍后再次尝试你的密钥。在没有 require 的情况下保留自己许可证的用户,会一直保留它,直到 VMPal 在之后的某次尝试中激活你的密钥。
使用 require: true 时
- 在你的密钥激活之前,VMPal 会先显示“正在激活许可证密钥****1234”,之后才会载入你的虚拟机和 Hub、打开窗口、恢复终端标签页、启动设为登录时启动的虚拟机,或响应编程智能体和
vmpal。如果 VMPal 是在登录时打开的,它会出现在程序坞中并不停跳动,直到有人查看。 - 如果激活失败,VMPal 会说明原因,并提供 重试;在所有席位都已占用或更新期已结束时提供 给许可证所有者发邮件;在版本对该许可证来说太新时提供 下载旧版本;在这个版本已被撤回时提供 下载VMPal;以及 退出。选择退出时,VMPal 下次启动时要恢复的终端标签页会保留下来。
- VMPal 也会自动重试:网络或服务器出错后每分钟一次,其他情况下每 15 分钟一次。它每分钟都会重新读取密钥文件,因此修正后的密钥文件会在一分钟内生效。
- 用户不能激活其他密钥。设置 › 许可证 会显示你的密钥(已遮盖)以及 激活。在那里输入的密钥,或者来自
vmpal://license/activate链接的密钥,会收到提示“这台Mac只能使用你所在组织的许可证密钥****1234激活。如需更改,请联系你的管理员。” - VMPal 永远不会在使用过程中关闭。如果 VMPal 打开期间 Mac 失去了许可证,VMPal 会尝试再次激活你的密钥;如果无法激活,则提示“在此密钥激活之前,VMPal无法再次打开。”在密钥激活之前,正在运行的虚拟机会继续运行,但不会启动新的虚拟机,
vmpal无法使用 VMPal,VMPal 下次也无法启动。 - 如果你在 VMPal 打开期间安装或更改了密钥文件,VMPal 会在大约一分钟内激活你的密钥。在此之前,VMPal 从密钥文件激活的许可证仍可正常使用,包括虚拟机;但如果是用户输入的许可证,则不会启动任何虚拟机,
vmpal也无法使用 VMPal。 - 第一次启动时需要能访问 vmpal.com。
虚拟机和命令行
每台虚拟机都在自己的进程中运行,这个进程可以在不打开 VMPal 窗口的情况下启动:从程序坞中的虚拟机图标启动,对于设为 登录时启动 的虚拟机在登录时启动,或者通过 vmpal 启动。这些进程和 vmpal 会自行读取许可证文件,因此遵循相同的规则:
- 使用
require: true时,如果 Mac 上没有你的密钥对应的许可证,虚拟机就不会启动。它会提示“无法启动虚拟机”,并提供 打开VMPal,用于打开 VMPal 激活密钥。 - 在同样的情况下,需要 VMPal 的
vmpal命令会立即失败,并提示“VMPal can't be used until it's activated with your organization's license key ****1234, as device management requires. Open VMPal to activate it.” - 例外情况是 VMPal 从密钥文件激活的许可证:在 VMPal 用你的密钥替换它的过程中(例如在你更改密钥之后),虚拟机仍可启动,
vmpal也仍可基于它正常使用。 - 下文介绍的限制同样适用于每台虚拟机。
限制功能和更新
在许可证管理页面中,许可证密钥的 VMPal 策略 部分适用于使用该密钥激活的所有 Mac 和 PC,无论是通过密钥文件还是手动激活。许可证所有者及其辅助许可证管理员可以更改它。请通过访问链接打开许可证管理页面。
| 设置 | 对 Mac 的作用 |
|---|---|
| 停用编程智能体(MCP 和智能体控制) | 关闭 VMPal 的 MCP 服务器、把 VMPal 添加到编程智能体的功能,以及所有虚拟机的智能体控制。vmpal 会拒绝执行它的命令。在虚拟机中运行的 Hub 脚本也会被跳过,因为它们需要智能体控制 |
| 停用 Mac 上的 Hub 脚本 | 跳过在 Mac 本身上运行的脚本,无论是通过“立即运行”还是 vmpal 触发的。智能体和 vmpal 无法让脚本在那里运行。虚拟机中的脚本仍会运行 |
| 停用崩溃报告 | 关闭 VMPal 和虚拟机的崩溃报告 |
| 停用共享文件夹 | 关闭所有虚拟机中的共享文件夹 |
| 停用剪贴板和拖放 | 关闭所有虚拟机中的共享剪贴板,以及把文件拖入和拖出虚拟机的功能。使用远程控制时,把文件拖放到另一台 Mac 的屏幕上以及从中拖出文件的功能也会关闭 |
| 停用远程控制 | 其他 Mac 无法连接到这台 Mac,这台 Mac 也无法连接到其他 Mac:它的 远程控制 开关保持关闭,它的窗口、添加电脑… 和编程智能体都无法访问其他 Mac |
| 更新 | 自动(允许的最新版本) 会把 Mac 更新到许可证允许的最新版本。选择某个版本后,Mac 会保持在该版本,直到你在这里更改 |
共享文件夹、剪贴板和远程控制的限制需要 Mac 上安装 VMPal 0.95 或更高版本。更早的版本只有在你同时停用这两项时,才会一起关闭共享文件夹和剪贴板。
在 Mac 上,被你关闭的功能对应的设置会变暗,并显示“已被许可证所有者停用。请联系你的管理员解锁。”设置 › 许可证 会在 限制 下列出它们。编程智能体和 vmpal 会收到“The license owner turned off coding agents for VMPal on this Mac. Contact your admin to unlock it.”每台虚拟机都会保留自己的设置,当你重新打开某项功能时,这些设置就会恢复。
更新 会列出购买许可证时的当前版本,以及该许可证涵盖的之后各个版本。选择某个版本后,VMPal 不会安装比它更新的版本,也不会退回到更旧的版本:已经在更新版本上的 Mac 会保持该版本。更新界面和 设置 › 关于 会显示“许可证所有者已批准更新至版本88。”在你选择版本之前 VMPal 已下载的更新,仍会在 VMPal 退出时安装。如果我们撤回了你选择的版本,Mac 会像选择 自动(允许的最新版本) 时一样更新。
VMPal 会在以下时机获取更改:启动时、切换到前台时(最多每小时一次),以及在装有密钥文件的 Mac 上每 6 小时一次。更改会立即在 VMPal 和正在运行的虚拟机中生效,但以下情况除外:
- 重新打开的崩溃报告会在 VMPal 或各台虚拟机下次启动时开始生效。
- macOS 13 虚拟机中的共享文件夹会在虚拟机重新启动时更改。
- 已经在进行的 Hub 运行会继续。仍在等待的运行会被跳过。
只要密钥文件仍然安装着,失去许可证的 Mac 就会一直保留最近一次的策略。如果你看不到策略部分,请联系我们为你的许可证密钥开启它。
如果你的 MDM 工具自行安装 VMPal 更新,请只安装许可证涵盖的版本,或你在 更新 设置中选择的版本。在许可证更新期结束之后发布的版本无法激活;使用
require: true时,VMPal 会因此被阻止,直到安装了更旧的版本。
更改或移除密钥
- 更改密钥: 替换该文件,例如使用上面的脚本。VMPal 会在大约一分钟内激活新密钥;如果 VMPal 没有打开,则在下次启动时激活。在新密钥激活之前,旧许可证仍可正常使用,包括虚拟机。不过,使用
require: true时,强制要求的是新密钥:在它激活之前,VMPal 下次启动时会等待它。 - 在许可证管理页面中重新生成许可证密钥: 也要用新密钥更新密钥文件。已经激活的 Mac 会继续正常使用,但需要激活的 Mac 无法使用旧密钥;使用
require: true时,它会被阻止。 - 释放 Mac: 删除密钥文件(以 root 身份运行
rm -f /Users/Shared/.vmpallicensekey),或者清空它。在大约一分钟内(如果 VMPal 没有打开,则在下次启动时),VMPal 会注销这台 Mac,从而释放席位、移除许可证并解除限制。如果 Mac 那时无法访问 vmpal.com,席位会继续被占用:请在许可证管理页面中移除这台 Mac。
VMPal 无法读取的密钥文件(例如有字段但没有密钥的文件)不会改变任何东西。
在 Windows PC 上
VMPal for Windows 同样会读取许可证密钥文件,格式相同,遵循的规则也相同:提示、require,以及更改或移除密钥。不同之处如下:
| 在 PC 上 | |
|---|---|
| 适用于所有用户的密钥文件 | C:\ProgramData\VMPal\.vmpallicensekey,也是 require 唯一生效的位置 |
| 适用于单个用户的密钥文件 | %LOCALAPPDATA%\VMPal\.vmpallicensekey |
| 适用于所有用户的许可证 | C:\ProgramData\VMPal\.vmpallicense,针对该 PC 加密,最近一次的策略保存在旁边的 .vmpallicensepolicy 中 |
| 记录 VMPal 在密钥文件中忽略了哪些内容 | %LOCALAPPDATA%\VMPal\Logs\License.log |
密钥文件可以是 UTF-8,也可以是带字节顺序标记(BOM)的 UTF-16,记事本和 Windows PowerShell 就是这样保存的。VMPal 会忽略作为链接(符号链接或目录联接)的密钥文件,以及超过 1 MB 的密钥文件。
在 PC 上安装密钥文件
任何用户都可以在 C:\ProgramData 中创建文件夹,而创建者可以删除其中的内容。因此,无论 C:\ProgramData\VMPal 是谁创建的,脚本都会先把它交给管理员组。请以管理员或 SYSTEM 身份运行脚本,例如作为 Microsoft Intune 中的平台脚本。如果只想激活密钥而不强制要求,请去掉 "require: true"。
$ErrorActionPreference = "Stop"
$Key = "VP-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
$Folder = Join-Path $env:ProgramData "VMPal"
$KeyFile = Join-Path $Folder ".vmpallicensekey"
# Administrators own the folder. Users can read it and add files, such as
# VMPal's shared license, but can't change or delete the administrators' files
New-Item -ItemType Directory -Force -Path $Folder | Out-Null
takeown /F $Folder /A | Out-Null
$Acl = New-Object Security.AccessControl.DirectorySecurity
$Acl.SetOwner([Security.Principal.SecurityIdentifier]"S-1-5-32-544")
$Acl.SetAccessRuleProtection($true, $false)
$Both = "ContainerInherit, ObjectInherit"
foreach ($Rule in @(("S-1-5-18", "FullControl", $Both, "None"),
("S-1-5-32-544", "FullControl", $Both, "None"),
("S-1-5-32-545", "ReadAndExecute", $Both, "None"),
("S-1-5-32-545", "CreateFiles", "None", "None"),
("S-1-3-0", "FullControl", $Both, "InheritOnly"))) {
$Acl.AddAccessRule((New-Object Security.AccessControl.FileSystemAccessRule(
[Security.Principal.SecurityIdentifier]$Rule[0], $Rule[1], $Rule[2], $Rule[3], "Allow")))
}
Set-Acl -LiteralPath $Folder -AclObject $Acl
# Written under a new name, then moved to the key file's path
$Temp = "$KeyFile." + [guid]::NewGuid().ToString("N")
[IO.File]::WriteAllLines($Temp, [string[]]($Key, "require: true"))
$Old = Get-Item -LiteralPath $KeyFile -Force -ErrorAction SilentlyContinue
if ($Old -and $Old.PSIsContainer) { throw "$KeyFile is a folder: delete it, then run this script again" }
# Deletes a link itself, never what it points to
if ($Old) { [IO.File]::Delete($KeyFile) }
# Fails if a user made a file there meanwhile: run the script again
Move-Item -LiteralPath $Temp -Destination $KeyFile
在 PC 上:
- 使用
require: true时,VMPal 会先显示“Activating license key ****1234”,之后才会打开窗口、打开远程控制或启动设为登录时启动的虚拟机。登录时,如果没有需要启动的内容,VMPal 不会等待。 - 在你的密钥激活之前,不会启动任何虚拟机:“Device management requires VMPal to be activated with your organization's license key ****1234 before VMs can start.”编程智能体和
vmpal会像在 Mac 上一样被拒绝。输入其他密钥时会收到“This PC can only be activated with your organization's license key ****1234. Contact your admin to change it.” - VMPal 会在启动时和每小时检查一次许可证,在等待强制要求的密钥时每分钟检查一次。它每分钟都会读取密钥文件。
- Download the Old Build 和 Download VMPal 会下载该许可证涵盖的最新版 VMPal for Windows。
策略同样适用于 PC:
| 设置 | 对 PC 的作用 |
|---|---|
| 停用编程智能体(MCP 和智能体控制) | VMPal 的 MCP 服务器和 vmpal 会拒绝所有调用(包括来自虚拟机内部的调用),每台虚拟机设置中的智能体控制也会变暗 |
| 停用 Mac 上的 Hub 脚本 | 没有作用:VMPal for Windows 没有 Hub |
| 停用崩溃报告 | 关闭 VMPal 的崩溃报告。重新打开后,会在 VMPal 下次启动时开始生效 |
| 停用共享文件夹 | 关闭所有虚拟机中的共享文件夹,包括正在运行的虚拟机。除非编程智能体也被停用,否则编程智能体所做的拷贝仍然有效 |
| 停用剪贴板和拖放 | 关闭共享剪贴板,以及把文件拷贝和拖入、拖出虚拟机的功能。增强会话会从下一次连接开始遵循此设置。使用远程控制时,剪贴板和文件拖放在两个方向上都会关闭 |
| 停用远程控制 | 其他电脑无法连接到这台 PC,这台 PC 也无法连接到其他电脑。已经打开的连接会断开 |
| 更新 | PC 始终更新到许可证允许的最新版本。你选择的版本只适用于 Mac |
| PC 上的提示 | 解决方法 |
|---|---|
| VMPal couldn't save the license in C:\ProgramData\VMPal. | 再次运行脚本:它会允许所有用户向该文件夹添加文件。 |
| VMPal couldn't save the license on this PC. | 对于用户文件夹中的密钥文件,请确保该用户可以写入 %LOCALAPPDATA%\VMPal。 |
疑难解答
| 提示 | 解决方法 |
|---|---|
| 此许可证的所有席位均已被占用。 | 在许可证管理页面中移除不再使用的 Mac,或增加席位。 |
| 此许可证密钥无效。 | 检查文件中的密钥,尤其是在重新生成许可证密钥之后。 |
| 此版本的VMPal发布于该许可证更新期结束之后。 | 用 下载旧版本 安装旧版本,或续订许可证。 |
| 此版本已从注册表中移除。请更新VMPal后再试一次。 | 在同一个提示中用 下载VMPal 安装其他版本:它会下载该许可证涵盖的最新版本,或你在 更新 设置中选择的版本。 |
| VMPal无法连接许可证服务器。请检查网络连接,然后再试一次。 | 确保 Mac 能通过 HTTPS 访问 vmpal.com。VMPal 不会跟随来自它的重定向。 |
| VMPal无法将许可证保存到/Users/Shared。 | 移除 /Users/Shared/.vmpallicense,或者把它设为所有用户都可写入的文件(权限 0666),而不是链接。 |
| VMPal无法将许可证保存到这台Mac上。 | 对于用户文件夹中的密钥文件,请确保该用户可以写入 ~/Library/Application Support/com.tableplus.VMPal。 |
| VMPal无法激活此许可证密钥。 | 稍后重试;如果问题持续出现,请联系我们。 |
| 无法启动虚拟机 | 打开 VMPal,它会激活你的密钥。 |
VMPal 会记录它在密钥文件中忽略的内容,例如它不认识的字段,或它视为 true 的 require 值。要查看这些记录:
log show --last 1d --predicate 'eventMessage CONTAINS "License key file"'
本地管理员仍然可以移除密钥文件。要让每台 Mac 都保持在能读取密钥文件的版本上,请用你的 MDM 工具管理 VMPal 的更新。