Skip to main content

CatalogTemplate

idstringrequired
revisionintegerrequired

Possible values: >= 1

titlestringrequired
categoriesstring[]required
docsstringrequired
maintainerstring

Who maintains the template or the app. Absent when the template names none.

Possible values: non-empty and <= 100 characters

descriptionstring

Longer plain text for the template's page. Line breaks are meaningful; it is never markup. Absent when the template has none.

Possible values: non-empty and <= 2000 characters

links object

The addresses the template's page offers, each absolute https with a host and no credentials. A link the template does not set is absent.

projectstring

The app's project page.

Possible values: <= 2048 characters

supportstring

Where to get help with the app.

Possible values: <= 2048 characters

donatestring

Where to support the app's development.

Possible values: <= 2048 characters

screenshotCountintegerrequired

How many screenshots the template lists. Screenshot i of 0..screenshotCount-1 is getCatalogTemplateScreenshot.

Possible values: >= 0 and <= 8

sourcestringrequired

Where the template came from: hoserva for the curated catalog, a source id for a user-added source.

sourceKindCatalogSourceKindrequired

curated: Hoserva's own catalog. user_added: a source URL the user added.

Possible values: [curated, user_added]

signedbooleanrequired

True only when the source's installed archive passed a signature check; false for a template of an unsigned user-added source.

composestringrequired

The template's compose.yaml text, with its x-hoserva block.

privileges object[]required

Empty when the template asks for nothing beyond an ordinary container.

  • Array [
  • kindstringrequired

    Possible values: [privileged, host_network, host_pid, host_cgroup, device_cgroup_rules, added_capabilities, confinement_disabled, group_add, docker_socket, host_path, gpu_reservation, container_runtime]

    servicestringrequired

    The Compose service that asks for it.

    detailstring

    The path, process namespace, rules, capabilities, security options, groups, device reservations or runtime concerned, comma-separated when there are several (the entries of gpu_reservation are separated by a semicolon, each one listing its own driver, count or device ids and capabilities with commas); absent for privileged, host_network and host_cgroup.

    descriptionstringrequired

    Plain-language explanation of what it grants.

  • ]
  • CatalogTemplate
    {
    "id": "string",
    "revision": 0,
    "title": "string",
    "categories": [
    "string"
    ],
    "docs": "string",
    "maintainer": "string",
    "description": "string",
    "links": {
    "project": "string",
    "support": "string",
    "donate": "string"
    },
    "screenshotCount": 0,
    "source": "string",
    "sourceKind": "curated",
    "signed": true,
    "compose": "string",
    "privileges": [
    {
    "kind": "privileged",
    "service": "string",
    "detail": "string",
    "description": "string"
    }
    ]
    }