@mcesystems/usbmuxd-instance-manager 1.0.73 → 1.0.75

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -108,19 +108,22 @@ await service.stop();
108
108
  | `wslDistribution` | string | `usbmuxd-alpine` | Alpine WSL2 distribution name |
109
109
  | `verboseLogging` | boolean | true | Enable verbose output |
110
110
  | `appleVendorId` | string | '05AC' | Apple vendor ID (hex) |
111
- | `lockdownWindowsPath` | string | `C:\ProgramData\mce\lockdown` | Windows folder for lockdown (pairing) files; synced to/from Alpine |
112
- | `lockdownSyncEnabled` | boolean | true | Sync lockdown files so pairing can be skipped |
113
111
 
114
112
  ### Lockdown sync
115
113
 
116
- When enabled, the manager syncs lockdown (pairing) files between Windows and Alpine so devices that were already paired on Windows can be used without pairing again in WSL:
114
+ The manager automatically syncs lockdown (pairing) files between the native Apple/iTunes lockdown directory and Alpine so devices that were already paired on Windows can be used without pairing again in WSL.
117
115
 
118
- - **To Alpine**: When a device is assigned, that device’s plist (`{UDID}.plist`) is copied from `lockdownWindowsPath` to Alpine `/var/lib/lockdown`. Only the file for that device is copied.
119
- - **From Alpine**: When the service stops, plists for all devices that were assigned this session (plus `SystemConfiguration.plist` if present) are copied from Alpine back to `lockdownWindowsPath` so they are available for the next run.
116
+ The lockdown directory is resolved per platform:
117
+ - **Windows**: `C:\ProgramData\Apple\Lockdown` (same directory used by iTunes / Apple Mobile Device)
118
+ - **macOS**: `/var/db/lockdown`
119
+ - **Linux**: `/var/lib/lockdown`
120
120
 
121
- **Alpine permissions**: `/var/lib/lockdown` is often root-owned. The sync tries a normal copy first; if that fails (e.g. permission denied), it retries with `sudo cp`. Ensure the WSL user has passwordless sudo for these commands, or that the Alpine image has `/var/lib/lockdown` writable by the default user. If both fail, a warning is logged and device assignment continues (pairing can still be done manually).
121
+ Sync behavior:
122
+
123
+ - **To Alpine**: When a device is assigned, that device's plist (`{UDID}.plist`) and `SystemConfiguration.plist` are copied from the Apple lockdown directory to Alpine `/var/lib/lockdown`.
124
+ - **From Alpine**: When the service stops, plists for all devices that were assigned this session (plus `SystemConfiguration.plist` if present) are copied from Alpine back to the Apple lockdown directory so they are available for the next run.
122
125
 
123
- Set `lockdownSyncEnabled: false` or leave `lockdownWindowsPath` empty to disable lockdown sync.
126
+ **Alpine permissions**: `/var/lib/lockdown` is often root-owned. The sync tries a normal copy first; if that fails (e.g. permission denied), it retries with `sudo cp`. Ensure the WSL user has passwordless sudo for these commands, or that the Alpine image has `/var/lib/lockdown` writable by the default user. If both fail, a warning is logged and device assignment continues (pairing can still be done manually).
124
127
 
125
128
  ## CLI Options
126
129
 
@@ -212,7 +215,7 @@ The instance manager does steps 2–3 automatically when it sees an iOS device.
212
215
  2. **Unbind** so Windows gets the device back:
213
216
  `usbipd unbind --busid <BUSID>`
214
217
 
215
- Until you unbind, the device stays Shared (forced) and Windows/iTunes will not see it.
218
+ Until you unbind, the device stays "Shared (forced)" and Windows/iTunes will not see it.
216
219
 
217
220
  ### Useful usbipd commands
218
221