Local metadata are used to display information inside the About page. Metadata are composed by:

  • a JSON file named metadata.json, saved inside imageroot/ui/public/metadata.json
  • a PNG image for the logo named module_default_logo.png, saved inside imageroot/ui/src/assets/module_default_logo.png


The JSON format is very similar to the repository metadata, without id, logo and versions fields.

Example of metadata.json:

  "name": "kickstart",
  "description": {
    "en": "My kickstart module"
  "categories": [],
  "authors": [
      "name": "Name Surname",
      "email": ""
  "docs": {
    "documentation_url": "",
    "bug_url": "",
    "code_url": ""
  "source": ""

The categories field contains a list of string. Each string is a category that should describe the application usage scenario. It could be something like database or collaboration. Always use lower case strings without spaces.

The logo must be a PNG image and its size should be at least of 128x128 pixels.