Dogebox

A file called manifest.json is required for every pup. This file is consumed by Dogebox and describes metadata about the pup, as well as dependencies, ports to share, and a bunch of other configurable information.

Example

Reference

Prop	Type	Default
`manifestVersion`	`number`	-
`meta`	`PupManifestMeta`	-
`container`	`PupManifestContainer`	-
`interfaces?`	`PupManifestInterface[]`	`[]`
`dependencies?`	`PupManifestDependency[]`	`[]`
`metrics?`	`PupManifestMetric[]`	`[]`

Types

These types may be slightly out of date. For the moment, please confirm with the manifest.go file in the Dogebox source code.

PupManifestMeta

Prop	Type	Default
`name`	`string`	-
`version`	`string`	-
`logoPath?`	`string`	-
`shortDescription?`	`string`	-
`longDescription?`	`string`	-
`upstreamVersions?`	`Record<string, string>`	-

PupManifestContainer

Prop	Type	Default
`build`	`PupManifestBuild`	-
`services`	`PupManifestService[]`	`[]`
`exposes?`	`PupManifestExposeConfig[]`	`[]`
`requiresInternet?`	`boolean`	`false`

PupManifestBuild

Prop	Type	Default
`nixFile`	`string`	-
`nixFileSha256`	`string`	-

PupManifestService

Prop	Type	Default
`name`	`string`	-
`command`	`PupManifestCommand`	-

PupManifestCommand

Prop	Type	Default
`exec`	`string`	-
`cwd`	`string`	-
`env?`	`Record<string, string>`	`{}`

PupManifestExposeConfig

Prop	Type	Default
`name`	`string`	-
`type`	`"http" \| "tcp"`	-
`port`	`number`	-
`interfaces?`	`string[]`	`[]`
`listenOnHost?`	`boolean`	`false`
`webUI?`	`boolean`	`false`

PupManifestInterface

Prop	Type	Default
`name`	`string`	-
`version`	`string`	-
`permissionGroups`	`PupManifestPermissionGroup[]`	`[]`

PupManifestPermissionGroup

Prop	Type	Default
`name`	`string`	-
`description?`	`string`	-
`severity`	`number`	-
`routes?`	`string[]`	`[]`
`port`	`number`	-

PupManifestDependency

Prop	Type	Default
`interfaceName`	`string`	-
`interfaceVersion`	`string`	-
`permissionGroups`	`string[]`	`[]`
`source`	`PupManifestDependencySource`	-
`optional?`	`boolean`	`false`

PupManifestDependencySource

Prop	Type	Default
`sourceLocation`	`string`	-
`pupName`	`string`	-
`pupVersion`	`string`	-
`pupLogoBase64`	`string`	-

PupManifestMetric

Prop	Type	Default
`name`	`string`	-
`label`	`string`	-
`type`	`string`	-
`history?`	`number`	-

Manifest File