From 4482d7bc03a4cd6eb72b7ec180074eb1c5d0d23e Mon Sep 17 00:00:00 2001 From: Luka Gulin Date: Wed, 16 Apr 2025 16:30:28 +0200 Subject: [PATCH] Add disable upnp to manifest docs --- docs/dev/references/manifest.md | 82 +++++++++++++++++++++------------ 1 file changed, 52 insertions(+), 30 deletions(-) diff --git a/docs/dev/references/manifest.md b/docs/dev/references/manifest.md index 299c3ac43..af2bd9620 100644 --- a/docs/dev/references/manifest.md +++ b/docs/dev/references/manifest.md @@ -67,6 +67,7 @@ The Dappnode Package manifest defines all the necessary information for a Dappno "port": 80 } ], + "disableUpnp": true, "author": "Dappnode Association (https://github.com/dappnode)", "contributors": [ "Michael First (https://github.com/developerHanlder)", @@ -94,36 +95,37 @@ The Dappnode Package manifest defines all the necessary information for a Dappno ## Properties reference -| Property | Type | Required | -| ------------------------------------- | ---------- | ------------ | -| [name](#name) | `string` | **Required** | -| [version](#version) | `string` | **Required** | -| [upstreamVersion](#upstreamversion) | `string` | Optional | -| [shortDescription](#shortdescription) | `string` | Optional | -| [description](#description) | `string` | **Required** | -| [type](#type) | `enum` | **Required** | -| [chain](#chain) | `enum` | Optional | -| [mainService](#mainservice) | `string` | Optional | -| [dockerTimeout](#dockertimeout) | `string` | Optional | -| [dependencies](#dependencies) | `object` | Optional | -| [requirements](#requirements) | `object` | Optional | -| [globalEnvs](#globalenvs) | `object` | Optional | -| [architectures](#architectures) | `enum[]` | Optional | -| [backup](#backup) | `object[]` | Optional | -| [changelog](#changelog) | `string` | Optional | -| [warnings](#warnings) | `object` | Optional | -| [updateAlerts](#updatealerts) | `object[]` | Optional | -| [disclaimer](#disclaimer) | `object` | Optional | -| [style](#style) | `object` | Optional | -| [exposable](#exposable) | `object[]` | Optional | -| [author](#author) | `string` | Optional | -| [contributors](#contributors) | `string[]` | Optional | -| [categories](#categories) | `enum[]` | Optional | -| [keywords](#keywords) | `string[]` | Optional | -| [links](#links) | `object` | Optional | -| [repository](#repository) | `object` | Optional | -| [bugs](#bugs) | `object` | Optional | -| [license](#license) | `string` | **Required** | +| Property | Type | Required | +| ------------------------------------- | ----------------------- | ------------ | +| [name](#name) | `string` | **Required** | +| [version](#version) | `string` | **Required** | +| [upstreamVersion](#upstreamversion) | `string` | Optional | +| [shortDescription](#shortdescription) | `string` | Optional | +| [description](#description) | `string` | **Required** | +| [type](#type) | `enum` | **Required** | +| [chain](#chain) | `enum` | Optional | +| [mainService](#mainservice) | `string` | Optional | +| [dockerTimeout](#dockertimeout) | `string` | Optional | +| [dependencies](#dependencies) | `object` | Optional | +| [requirements](#requirements) | `object` | Optional | +| [globalEnvs](#globalenvs) | `object` | Optional | +| [architectures](#architectures) | `enum[]` | Optional | +| [backup](#backup) | `object[]` | Optional | +| [changelog](#changelog) | `string` | Optional | +| [warnings](#warnings) | `object` | Optional | +| [updateAlerts](#updatealerts) | `object[]` | Optional | +| [disclaimer](#disclaimer) | `object` | Optional | +| [style](#style) | `object` | Optional | +| [exposable](#exposable) | `object[]` | Optional | +| [disableUpnp](#disableupnp) | `object[]` or `boolean` | Optional | +| [author](#author) | `string` | Optional | +| [contributors](#contributors) | `string[]` | Optional | +| [categories](#categories) | `enum[]` | Optional | +| [keywords](#keywords) | `string[]` | Optional | +| [links](#links) | `object` | Optional | +| [repository](#repository) | `object` | Optional | +| [bugs](#bugs) | `object` | Optional | +| [license](#license) | `string` | **Required** | ### name @@ -814,6 +816,26 @@ Examples: Single exposable service item +### disableupnp + +Controls UPnP port forwarding for this package. By default, DAppNode attempts to create UPnP port mappings for all ports defined in the docker-compose file. This property can either disable UPnP completely for the package or selectively disable it for specific ports. + +- is optional +- type: `boolean` or `number[]` + +If set to `true`, UPnP will be disabled for all ports in this package. +If set as an array of numbers, UPnP will be disabled only for the specified ports. + +Examples: + +```json +true +``` + +```json +[8545, 30303] +``` + ### author Main author of this Dappnode Package. Must follow the structure `${name} <${email}> (${githubUserLink})`.