Definition

Type: object

A wpm definition

root Resources
Type: object or null

Remote resources used by this definition

Each additional property must conform to the following schema

root Resources additionalProperties
Type: stringFormat: uri

root Schema
Type: string or null

JSON Schema definition for auto completions

root Service
Type: object

Information about what this definition executes

root Service Autostart
Type: boolean

Autostart this definition with wpmd

root Service Environment
Type: array of array or null

Environment variables inherited by all commands in this service definition

 No Additional Items

Each item of this array must be:

root Service Environment Environment items
Type: array

Must contain a minimum of 2 items

Must contain a maximum of 2 items

No Additional Items

Tuple Validation

Item at 1 must be:
root Service Environment Environment items Environment items item 0
Type: string
Item at 2 must be:
root Service Environment Environment items Environment items item 1
Type: string

root Service EnvironmentFile
Type: string or null

Path to an environment file, containing environment variables inherited by all commands in this service definition

root Service ExecStart
Type: object

Command executed by this service definition

root Service ExecStart Arguments
Type: array of string or null

Arguments passed to the executable

 No Additional Items

Each item of this array must be:

root Service ExecStart Arguments Arguments items
Type: string

root Service ExecStart Environment
Type: array of array or null

Environment variables for this command

 No Additional Items

Each item of this array must be:

root Service ExecStart Environment Environment items
Type: array

Must contain a minimum of 2 items

Must contain a maximum of 2 items

No Additional Items

Tuple Validation

Item at 1 must be:
root Service ExecStart Environment Environment items Environment items item 0
Type: string
Item at 2 must be:
root Service ExecStart Environment Environment items Environment items item 1
Type: string

root Service ExecStart EnvironmentFile
Type: string or null

Path to an environment file, containing environment variables for this command

root Service ExecStart Executable
Type: object

Executable (local file, remote file, or Scoop package)

root Service ExecStart Executable anyOf item 0
Type: object

A remote executable file verified using a SHA256 hash

root Service ExecStart Executable anyOf item 0 Hash
Type: string

Sha256 hash of the remote executable at

root Service ExecStart Executable anyOf item 0 Url
Type: stringFormat: uri

Url to a remote executable
root Service ExecStart Executable anyOf item 1
Type: string

A local executable file
root Service ExecStart Executable anyOf item 2
Type: object

An executable file with a Scoop package dependency

root Service ExecStart Executable anyOf item 2 anyOf ScoopPackage
Type: object

root Service ExecStart Executable anyOf item 2 anyOf item 0 Bucket
Type: enum (of string)

Bucket that the package is found in

Must be one of:

  • "Main"
  • "Extras"

root Service ExecStart Executable anyOf item 2 anyOf item 0 Package
Type: string

Name of the package

root Service ExecStart Executable anyOf item 2 anyOf item 0 Target
Type: string or null

Target executable in the package

root Service ExecStart Executable anyOf item 2 anyOf item 0 Version
Type: string

Version of the package
root Service ExecStart Executable anyOf item 2 anyOf item 1
Type: object

A Scoop package identified using a raw manifest

root Service ExecStart Executable anyOf item 2 anyOf item 1 Manifest
Type: stringFormat: uri

Url to a Scoop manifest

root Service ExecStart Executable anyOf item 2 anyOf item 1 Package
Type: string

Name of the package

root Service ExecStart Executable anyOf item 2 anyOf item 1 Target
Type: string or null

Target executable in the package

root Service ExecStart Executable anyOf item 2 anyOf item 1 Version
Type: string

Version of the package

root Service ExecStartPost
Type: array or null

Commands executed after ExecStart in this service definition

 No Additional Items

Each item of this array must be:

root Service ExecStartPost ServiceCommand
Type: object

A wpm definition command

Same definition as ExecStart

root Service ExecStartPre
Type: array or null

Commands executed before ExecStart in this service definition

 No Additional Items

Each item of this array must be:

root Service ExecStartPre ServiceCommand
Type: object

A wpm definition command

Same definition as ExecStart

root Service ExecStop
Type: array or null

Shutdown commands for this service definition

 No Additional Items

Each item of this array must be:

root Service ExecStop ServiceCommand
Type: object

A wpm definition command

Same definition as ExecStart

root Service ExecStopPost
Type: array or null

Post-shutdown cleanup commands for this service definition

 No Additional Items

Each item of this array must be:

root Service ExecStopPost ServiceCommand
Type: object

A wpm definition command

Same definition as ExecStart

root Service Healthcheck

Healthcheck for this service definition

root Service Healthcheck anyOf Healthcheck
Type: object

root Service Healthcheck anyOf item 0 oneOf item 0
Type: object
No Additional Properties

root Service Healthcheck anyOf item 0 oneOf item 0 Command
Type: object

A service liveness healthcheck based on the successful exit code of a command

root Service Healthcheck anyOf item 0 oneOf item 0 Command Arguments
Type: array of string or null

Arguments passed to the executable

 No Additional Items

Each item of this array must be:

root Service Healthcheck anyOf item 0 oneOf item 0 Command Arguments Arguments items
Type: string

root Service Healthcheck anyOf item 0 oneOf item 0 Command DelaySec
Type: integerFormat: uint64

The number of seconds to delay before checking for liveness

Value must be greater or equal to 0.0

root Service Healthcheck anyOf item 0 oneOf item 0 Command Environment
Type: array of array or null

Environment variables for this command

 No Additional Items

Each item of this array must be:

root Service Healthcheck anyOf item 0 oneOf item 0 Command Environment Environment items
Type: array

Must contain a minimum of 2 items

Must contain a maximum of 2 items

No Additional Items

Tuple Validation

Item at 1 must be:
root Service Healthcheck anyOf item 0 oneOf item 0 Command Environment Environment items Environment items item 0
Type: string
Item at 2 must be:
root Service Healthcheck anyOf item 0 oneOf item 0 Command Environment Environment items Environment items item 1
Type: string

root Service Healthcheck anyOf item 0 oneOf item 0 Command Executable
Type: string

Executable name or absolute path to an executable

root Service Healthcheck anyOf item 0 oneOf item 0 Command RetryLimit
Type: integer or nullFormat: uint8

The maximum number of retries (default: 5)
root Service Healthcheck anyOf item 0 oneOf item 1
Type: object
No Additional Properties

root Service Healthcheck anyOf item 0 oneOf item 1 Process
Type: object

A process liveness healthcheck either based on an automatic PID or an optional binary

root Service Healthcheck anyOf item 0 oneOf item 1 Process DelaySec
Type: integerFormat: uint64

The number of seconds to delay before checking for liveness

Value must be greater or equal to 0.0

root Service Healthcheck anyOf item 0 oneOf item 1 Process Target
Type: string or null

An optional binary with which to check process liveness
root Service Healthcheck anyOf item 1
Type: null

root Service Kind
Type: enum (of string) Default: "Simple"

Type of service definition

Must be one of:

  • "Simple"
  • "Oneshot"
  • "Forking"

root Service Restart
Type: enum (of string) Default: "Never"

Restart strategy for this service definition

Must be one of:

  • "Never"
  • "Always"
  • "OnFailure"

root Service RestartSec
Type: integer or nullFormat: uint64

Time to sleep in seconds before attempting to restart service (default: 1s)

root Service WorkingDirectory
Type: string or null

Working directory for this service definition

root Unit
Type: object

Information about this definition and its dependencies

root Unit Description
Type: string or null

Description of this definition

root Unit Name
Type: string

Name of this definition, must be unique

root Unit Requires
Type: array of string or null

Dependencies of this definition, validated at runtime

 No Additional Items

Each item of this array must be:

root Unit Requires Requires items
Type: string