Overview

! This is wip and a draft, how this works may change !

• Create files for new plugin
• npm install and compile plugin (TODO is this for sure needed?)
• Ensure directory is in docker (TODO this should not be nessicary long term)
• Add plugin in site administration

Creating plugin

Ensure you have the CLI tool installed (see…)

appbuilder plugin view

If you execute appbuilder plugin it will detail your options… For example appbuilder plugin new will create an empty plugin, while view sets up boilerplate.

This will create a new directory in your project: ab/develop/plugins

Make sure you setup any submodules in that directory

npm i
npm run watch

If there are no errors it should look similar to this:

Possible sources of errors

You will find a manifest.json in your new plugin. Make sure it references files that actually exist!

If your appbuilder breaks, you can open the database and remove broken references to plugin files. These are screenshots from a working system. Note how ABMinimode_web.mjs is a file in /dev/. If the file name was, say, ABMinimode_web.js your appbuilder would fail to load!

Adding To Docker

The files exist on your local machine, but not within docker! Make sure your docker-compose.dev.yml contains this:

services:
   web:
      image: docker.io/digiserve/ab-web:$AB_WEB_VERSION
      hostname: web
      volumes:
         - type: bind
           source: ./nginx/html
           target: /usr/share/nginx/html
         - files:/data
         - type: bind
           source: ./developer/web/assets
           target: /app/assets
         # This is where we load the plugins directory!!!
         - type: bind
           source: ./developer/plugins
           target: /app/assets/ab_plugins
      depends_on:
         - api_sails

Loading the Plugin

The plugin code is in docker, but it isn’t getting loaded yet! We need to go to site administration/Plugins and + Add it. console_logs

After refreshing the page, the plugin will be active. I had a simple console log: