Document correct cPanel install.json format with required fields

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
shuki
2026-03-05 00:34:58 +02:00
parent a87ca4a823
commit 894c918d32

View File

@@ -229,7 +229,7 @@ Allows cPanel account owners to restore their own data (files, databases, email,
3. Confirmation summary with CSRF token 3. Confirmation summary with CSRF token
4. Execute via AdminBin, display results 4. Execute via AdminBin, display results
**cPanel plugin registration:** `install.json` is an array of plugin definitions. It registers in cPanel's "Files" section. The `feature` key (`gniza_restore`) allows admins to enable/disable per package. Both `install_plugin` and `uninstall_plugin` require a **tar.gz archive** containing `install.json` — passing a raw JSON file path prints usage help and does nothing. **cPanel plugin registration:** `install.json` is an array of plugin definitions passed to `install_plugin`/`uninstall_plugin` inside a **tar.gz archive** (with the icon file included). Required JSON fields per cPanel's `Cpanel::Themes::Assets::Link`: `type` ("link"), `id` (lowercase identifier), `name`, `group_id` (section: "files", "domains", etc.), `uri` (CGI path), `feature` (for Feature Manager), `order` (integer), `icon` (path relative to staging dir). The `feature` key (`gniza_restore`) allows admins to enable/disable per cPanel package.
### GnizaCPanel::UI ### GnizaCPanel::UI