Skip to content

Commit b9c31d5

Browse files
authored
docs: document AllowedSantaCommands key (#925)
Fixes SNT-369
1 parent 6b37fe4 commit b9c31d5

2 files changed

Lines changed: 21 additions & 6 deletions

File tree

Source/common/SNTConfigurator.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1119,7 +1119,7 @@ extern NSString* _Nonnull const kEnableMenuItemUserOverride;
11191119

11201120
///
11211121
/// If set, only the listed command types will be accepted from the sync server.
1122-
/// Command names are lowercase strings matching proto field names: "kill", "ping".
1122+
/// Command names are lowercase strings matching proto field names: "kill", "ping", "eventupload".
11231123
/// When unset (nil), all commands are allowed.
11241124
///
11251125
/// This is a forced config key (MDM only) — not settable via sync server.

docs/src/lib/santaconfig.ts

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,21 @@ export const SantaConfigKeyGroups: SantaConfigGroups = {
140140
repeated: true,
141141
versionAdded: "2026.3",
142142
},
143+
{
144+
key: "AllowedSantaCommands",
145+
description:
146+
`Array of allowed Santa Commands. If the key \`AllowedSantaCommands\` is unset (nil), all commands are allowed.
147+
If \`AllowedSantaCommands\` is an empty array, none of the commands are allowed.`,
148+
type: "string",
149+
syncConfigurable: false,
150+
repeated: true,
151+
possibleValues: [
152+
{ value: "kill" },
153+
{ value: "ping" },
154+
{ value: "eventupload" },
155+
],
156+
versionAdded: "2026.3",
157+
},
143158
],
144159
gui: [
145160
{
@@ -758,15 +773,15 @@ changes in the release notes of any future release that changes them.`,
758773
usb: [
759774
{
760775
key: "BlockUSBMount",
761-
description: "Deprecated: use RemovableMediaAction instead. If true, blocking Removable Media (e.g. USB Mass storage) feature is enabled.",
776+
description: "Deprecated: use \`RemovableMediaAction\` instead. If true, blocking Removable Media (e.g. USB Mass storage) feature is enabled.",
762777
type: "bool",
763778
syncConfigurable: true,
764779
defaultValue: false,
765780
versionDeprecated: "2026.3",
766781
},
767782
{
768783
key: "RemountUSBMode",
769-
description: `Deprecated: use RemovableMediaRemountFlags instead. Array of strings for arguments to pass to \`mount -o\` when forcibly remounting devices.`,
784+
description: `Deprecated: use \`RemovableMediaRemountFlags\` instead. Array of strings for arguments to pass to \`mount -o\` when forcibly remounting devices.`,
770785
type: "string",
771786
syncConfigurable: true,
772787
repeated: true,
@@ -786,7 +801,7 @@ changes in the release notes of any future release that changes them.`,
786801
{
787802
key: "RemovableMediaAction",
788803
description:
789-
"Action for all removable media. If unset, falls back to deprecated BlockUSBMount + RemountUSBMode.",
804+
"Action for all removable media. If unset, falls back to deprecated \`BlockUSBMount\` + \`RemountUSBMode\`.",
790805
type: "string",
791806
syncConfigurable: true,
792807
possibleValues: [
@@ -798,7 +813,7 @@ changes in the release notes of any future release that changes them.`,
798813
{
799814
key: "RemovableMediaRemountFlags",
800815
description:
801-
"Array of mount flag arguments when RemovableMediaAction is Remount. If unset, falls back to deprecated RemountUSBMode.",
816+
"Array of mount flag arguments when \`RemovableMediaAction\` is Remount. If unset, falls back to deprecated \`RemountUSBMode\`.",
802817
type: "string",
803818
syncConfigurable: true,
804819
repeated: true,
@@ -829,7 +844,7 @@ changes in the release notes of any future release that changes them.`,
829844
{
830845
key: "EncryptedRemovableMediaRemountFlags",
831846
description:
832-
"Array of mount flag arguments for encrypted removable media when EncryptedRemovableMediaAction is Remount.",
847+
"Array of mount flag arguments for encrypted removable media when \`EncryptedRemovableMediaAction\` is Remount.",
833848
type: "string",
834849
syncConfigurable: true,
835850
repeated: true,

0 commit comments

Comments
 (0)