Skip to content

Add disable upnp to manifest docs #475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add disable upnp to manifest docs #475

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 52 additions & 30 deletions docs/dev/references/manifest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ The Dappnode Package manifest defines all the necessary information for a Dappno
"port": 80
}
],
"disableUpnp": true,
"author": "Dappnode Association <admin@dappnode.io> (https://github.com/dappnode)",
"contributors": [
"Michael First <developerHanlder@project.io> (https://github.com/developerHanlder)",
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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})`.
Expand Down