Skip to content

Application manifest

Applications are described by a JSON manifest inspired to AppData and NPM package.json formats.

The manifest is used both for generating the "Applications" page and for a future App store.

Manifest must be placed under /usr/share/cockpit/nethserver/applications directory and named with the application id like <id>.json;


  • id: this tag contains the unique identifier for this application (required)
  • name: descriptive name of the application (required)
  • summary: describe what is the purpose of the application in few words (required)
  • description: include 2-3 paragraphs describing any important features. Each line should be an element of the array. Supports markdown format. (recommended)
  • icon: name of the icon file; the icon should be 256x256px (recommended)
  • screenshots: a list of screenshots; all screenshots should have a 16:9 aspect ratio, and should have a width that is no smaller than 620px (optional)
  • url: link to local application installation. (required for web applications)
  • homepage: this is a recommended tag for link project official site (optional)
  • external: this is a optional tag for applications that have only external link and not configuration settings
  • release: define the version and release date of this application (recommended)
  • provides: list of provided RPM packages (optional)
  • tags: list of keywords to help people discover content of the application (optional)
  • license: license of the application, please pick one from SPDX list (recommended)
  • bugs: the url of project's issue tracker and / or the email address to which issues should be reported (optional)
  • author: the name of of the author with optional email and urls fields. (recommended)
  • infoapi: an object describing an API script call that extends the manifest with runtime information

Images like screenshots and icons must be placed under /usr/share/cockpit/<application-id>/ directory.

The url field should contain the URL to access the installed Web application. It should

  • be empty, if the application doesn't have its own external Web interface
  • start with /, if the application is hosted under the default virtualhost; example: /webtop
  • contain a full URL if the application is hosted inside a dedicated virtual host, example: In this case, the application can generate the URL at runtime with an infoapi script

Manifest runtime overriding with infoapi

The manifest can describe how to invoke an API script during runtime that overrides the manifest itself.

The script output format must be a JSON string representing an object. The object is merged with the static manifest contents.

For instance, the script output can be:

    "url": ""

The object is merged with the static JSON manifest, overriding its url attribute.

To enable the API script invocation, set the infoapi attribute in the following way:

    // other manifest attributes,
    "infoapi": {
        "path": "nethserver-mattermost/read",
        "input": {
            "action": "custom-action"

The path attribute is mandatory and identifies an executable file under the usual API directory (/usr/libexec/nethserver/api/).

The input attribute is optional. It represents an input object for the API script that is copied over a base input object created by the system. The base object looks like:

    "action": "app-info",
    "location": {
        // JavaScript window.location converted to JSON


File /usr/share/cockpit/nethserver/applications/nextcloud.json:

    "id": "nethserver-netxtcloud",
    "name": "NextCloud",
    "summary": "Share your data",
    "description": [
        "Access, **share** and protect your files, calendars, contacts, communication & more at home and in your enterprise.",
        "Nextcloud puts your data at your fingertips, under your control."
    "icon": "icon.png",
    "screenshots": [
        { "caption": "Login", "image": "login.png" },
        { "caption": "Share data", "image": "data.png" }
    "url": "/nextcloud",
    "homepage": "",
    "provides": ["nextcloud", "nethserver-nextcloud"],
    "release": {
        "version": "12.0.2"
    "tags": [
    "license": "GPL-3.0",
    "bugs": {
        "url": "",
        "email": ""
    "author": {
        "name": "Nextcloud",
        "url": "",
        "email": ""