Managing Plugins

This guide covers everything you need to know about installing, enabling, configuring, and removing plugins in your Shop Craft store.

Viewing Your Plugins

1. Log in to your Admin Panel
2. Go to Plugins in the sidebar

You will see a list of all installed plugins with their name, description, version, and current status (enabled or disabled).

Uploading a New Plugin

To install a new plugin from a ZIP file:

1. Go to Admin Panel > Plugins
2. Click the Upload Plugin button
3. Select the plugin .zip file from your computer
4. Wait for the upload and extraction to complete

The plugin will appear in your plugins list after a successful upload.

ZIP File Requirements

For a plugin ZIP to be accepted, it must:

• Contain a valid plugin.json manifest file
• The plugin.json must include at least a name and slug field
• The plugin slug must use only lowercase letters, numbers, and hyphens
• The slug must be unique -- you cannot upload a plugin with the same slug as an existing one

WARNING

If the ZIP file does not contain a valid plugin.json, the upload will fail. Make sure you are uploading the correct file from your plugin provider.

Enabling a Plugin

Plugins are disabled by default after upload. To enable a plugin:

1. Go to Admin Panel > Plugins
2. Find the plugin in the list
3. Click the Enable toggle

The plugin will start working immediately once enabled.

Disabling a Plugin

To temporarily turn off a plugin without removing it:

1. Go to Admin Panel > Plugins
2. Find the plugin in the list
3. Click the Disable toggle

The plugin will stop running, but its settings and files are preserved. You can re-enable it anytime.

TIP

Disabling a plugin is a safe way to troubleshoot issues. If something seems wrong, try disabling plugins one at a time to find the cause.

Configuring Plugin Settings

Most plugins have settings that you need to fill in before they will work (for example, API keys or account IDs).

1. Go to Admin Panel > Plugins
2. Find the plugin you want to configure
3. Click the Settings button (or gear icon)
4. Fill in the required fields
5. Click Save

Each plugin has its own settings form, dynamically generated from the plugin's settings schema. The form may include:

• Text fields -- for API keys, IDs, phone numbers
• Toggles -- for enabling/disabling specific features within the plugin
• Dropdowns -- for choosing between options (e.g., chat provider)
• Text areas -- for message templates or custom code
• Number fields -- for weights, dimensions, etc.

Deleting a Plugin

To permanently remove a plugin:

1. Go to Admin Panel > Plugins
2. Find the plugin you want to remove
3. Click the Delete button
4. Confirm the deletion

DANGER

Deleting a plugin removes it completely -- its files and settings are permanently erased. If you want to use it again later, you will need to upload it again and reconfigure its settings. If you just want to turn it off temporarily, use the Disable toggle instead.

Troubleshooting

Plugin upload fails with "Failed to open ZIP file"

• Make sure the file is a valid .zip archive and is not corrupted

Plugin upload fails with "Plugin must contain a plugin.json file"

• The ZIP may have the wrong structure. The plugin.json should be at the root of the ZIP or inside a single top-level folder

Plugin upload fails with "A plugin with slug already exists"

• A plugin with the same identifier is already installed. Delete the existing version first, then upload the new one

Plugin is enabled but does not seem to work

• Check that all required settings are filled in (especially API keys and IDs)
• Make sure the third-party service (e.g., Google Analytics, Shiprocket) is properly set up on their end
• Check storage/logs/laravel.log for any error messages from the plugin