Using plugins
Installing, updating and removing plugins
Add features to your site such as SEO, forms and statistics — install from the Plugin Store in one click, update, switch off or remove without losing data
On this page
Plugins add features to your site. You can switch them on and off at any time, and their data stays when they are off. Manage them under Plugins (Settings group, needs manage_options), which has the tabs Installed, Plugin store and Upload .zip.
Installing from the Plugin Store#
- Go to Plugins → Plugin store (or the 🛍 Find plugins button)
- Search, or sort by popular / most downloaded / top rated / newest / trending
- Open a plugin to see its details, versions, reviews and the permissions it asks for, then press Install
- The confirmation dialog lists every permission — check them and press Approve and install
- A newly installed plugin is still off — press Activate now in the notice at the bottom of the screen (CMS 2.3.0), or go to the Installed tab and press Activate. The plugin's menus, admin pages and blocks appear right away
- If the plugin has settings to fill in, press Settings on its card
If a plugin needs other plugins first, the dialog lists them with the versions required — press Install all (each one asks for its permissions separately). Plugins under Works with are optional.
Package signatures#
Since CMS 2.4.0 every package from the official Plugin Store carries a digital signature (Ed25519), checked before every install. A package changed after it left the store, swapped for another version or sent without a signature is not installed — nothing to set up.
With a Plugin Store of your own (STORE_URL), the system remembers that store's key the first time it signs a package and refuses any other key after that. You can also set the key yourself with STORE_PUBLIC_KEY (see .env variables).
Installing from a .zip file#
Use this when you got the plugin file yourself, or the server cannot reach the Store (download the .zip from the plugin's page on the store website).
- Go to Plugins → Upload .zip
- Drop the file, or press Choose a .zip file (the file must contain
manifest.json) - Approve the permissions, then activate it on the Installed tab
Install files only from plugins you trust. Files that don't come from the Store are not reviewed by the team.
Updating#
When the Store has a new version, the plugin's card shows New version vX — press Update. Settings and the on/off state stay as they were (uploading a .zip of a higher version upgrades too).
- If the new version asks for more permissions, the plugin is switched off with a list of the new permissions — press Approve and activate when ready
- If the update changes a data table in a way that could lose data, the system asks you to tick "I understand data may be lost" first, and backs the table up before changing it
Switching off#
Press Deactivate on the card — all data stays, and you can switch it on again at any time. While it is off, the plugin's blocks on pages are not shown (the pages don't break) and they come back when it is on again.
If other plugins need this one, the system warns that they will be switched off too (Deactivate all).
Removing a plugin#
- Press Delete on the card
- Choose whether to delete the plugin's data too:
- Unticked — the data is kept and used again if you reinstall
- Ticked — the plugin's tables (
p_<id>_*), settings and background jobs are deleted; the system keeps a backup of the tables for 7 days
- Press Delete plugin
Reviewing a plugin#
On the plugin's details (the Reviews tab), give 1–5 stars and write a short review, then press Send review (one review per plugin per day).
Plugins that run a separate program#
External-service plugins show the badge "Server program · not connected" — open the plugin's Settings, then:
- Run the plugin's program (e.g. add it as a service in the CMS's
docker-compose.yml, following the example on the settings page) and give it the secret asANASAKI_PLUGIN_SECRET - Enter the plugin program address, e.g.
http://service-name:9000 - Press Test connection, then activate it
WebAssembly and JavaScript plugins skip this step — install and use them right away.
