Custom Plugins - Manage Estimated Reading Time: 5 Minutes Custom Plugins - Manage opens the Custom Plugin Installer. Use it to upload a custom plugin from your computer, upload a new version of a plugin, and select which version is active. You do not need access to the Ubersmith server. Note: Custom plugin code is shared by all brands. When you upload a plugin or change its version, the change applies to every brand. Turn on the Custom Plugin Installer The Custom Plugin Installer is off by default. Two conditions must be true before you can use it: Server configuration: a server administrator must turn on web upload. Permission: your role must have the View permission for Custom Plugins installer. Turn on web upload A server administrator must do these steps on the Ubersmith server: In /usr/local/ubersmith/docker-compose.override.yml, add this line to the environment section of the web service: environment: PLUGIN_WEB_INSTALLER_ENABLE: 1 Recreate the Ubersmith containers: # cd /usr/local/ubersmith # docker compose rm -sf # ./ubersmith_start.sh For more information, see Ubersmith and Docker. Give permissions to a role Set the permissions for Admin Portal > Settings > Global Settings > Custom Plugins installer on the role: Permission What it lets the user do View Open the Custom Plugins list and the details of each plugin. Create Upload a new plugin, upload a new version, and make a version active. Delete Delete an old uploaded version. Check the requirements Go to Settings > Global Settings > Customization > Plugins. Click Custom Plugins - Manage. If a requirement is not met, the Custom Plugin Installer page shows an error. The Requirements table shows the status of the server configuration and your permission. The Permissions table shows which actions your role can do. The Overview and Technical Details sections, lower on the same page, give more information about the installer. When all requirements are met, Custom Plugins - Manage opens the Custom Plugins list. To see the requirements page again, click Installer Information. The Custom Plugins list The Custom Plugins list shows all custom plugins, with these columns: Name, Version, Identifier, Namespace, Directory, and Actions. The list includes plugins that you uploaded and plugins that Custom Plugins - Refresh found. To see the details of a plugin, click manage. Upload a new plugin Prepare the zip file The zip file must meet these requirements: It contains one plugin folder at its root. The plugin folder contains a bootstrap.php file and a valid manifest.json file. The manifest.json file contains values for sdk_version, identifier, name, namespace, and version. The identifier, namespace, and directory of the plugin are not used by a different plugin. It contains only one plugin. It is not larger than the upload limit of the server (16 MB on a standard installation). Upload the plugin On the Custom Plugins list, click Upload New Plugin. In Plugin, select the zip file. Click Install. Ubersmith scans the file for malware, then installs the plugin. The new plugin shows in the Custom Plugins list. It also shows in the Custom Plugins table on the Plugins page. You do not need to click Custom Plugins - Refresh. A new plugin is disabled when it is installed. To enable and configure it, go to the Plugins page and click the name of the plugin. For more information, see Using Plugins. If the upload fails The popup shows an error message. These are the most frequent errors: Error What to do Invalid file type. Please upload a .zip file. Upload a .zip file. No plugin found. A plugin must contain both bootstrap.php and manifest.json files. Make sure that the plugin folder contains both files. Multiple plugins found. Only one plugin per zip file is allowed. Put each plugin in a different zip file. A plugin with identifier (or namespace, or directory) "…" already exists. Change the value in manifest.json, or upload the file as a new version of the existing plugin. invalid fields specified Add the missing fields to manifest.json. Malicious attachment detected. The malware scan found a problem in the file. Do not install the file. Upload a new version of a plugin On the Custom Plugins list, click manage for the plugin. Click Upload new version. In Plugin, select the zip file. Click Update. The identifier and namespace in the new manifest.json file must be the same as in the installed plugin. If they are different, Ubersmith does not install the new version. When the upload is complete, the new version becomes the active version immediately. Ubersmith keeps the old version on the server. Note: A version change can take up to 2 minutes to apply everywhere in Ubersmith. Manage the versions of a plugin The plugin details page shows the Name, Version, Identifier, Namespace, Bootstrap Directory, Current active version (on disk), and Description of the plugin. The Versions on Disk table shows each version on the server. The Active column shows Yes for the version that Ubersmith uses. To go back to an older version: click Make Active for that version, then click Yes. Ubersmith uses that version immediately. To delete an old version: click Delete for that version, then click Yes. You cannot undo this. Note: You cannot delete the active version. You also cannot delete the version that you first installed. You can delete only versions that you uploaded with Upload new version. What Custom Plugins - Manage does not do It does not uninstall plugins. To stop using a plugin, disable it on the Plugins page. It does not enable plugins. Use the Plugins page to enable and configure a plugin for each brand.