ecosystem.json

PM2 ecosystem config file

ecosystem.jsonecosystem.ymlecosystem.yamlecosystem.config.jsonecosystem.config.ymlecosystem.config.yaml

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your ecosystem.json and it validates in your browser — nothing is uploaded.

Validate a ecosystem.json → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`apps`	`array`	The apps property is an array of object where each object contains the configuration for each process.
`deploy`	`object`	The deploy property is an object where each of its properties is an object which defines a deployment environment.
`deploy.production`	`object`	—
`deploy.production.key`	`string`	SSH key path. Defaults to $HOME/.ssh
`deploy.production.user`	`string`	SSH user
`deploy.production.host`	`oneOf`	SSH host
`deploy.production.ssh_options`	`oneOf`	SSH options with no command-line flag, see 'man ssh'
`deploy.production.ref`	`string`	GIT remote/branch
`deploy.production.repo`	`string`	GIT remote
`deploy.production.path`	`string`	path in the server
`deploy.production.pre-setup`	`string`	Pre-setup command or path to a script on your local machine
`deploy.production.post-setup`	`string`	Post-setup commands or path to a script on the host machine
`deploy.production.pre-deploy-local`	`string`	pre-deploy action
`deploy.production.post-deploy`	`string`	post-deploy action
`deploy.staging`	`object`	—
`deploy.staging.key`	`string`	SSH key path. Defaults to $HOME/.ssh
`deploy.staging.user`	`string`	SSH user
`deploy.staging.host`	`oneOf`	SSH host
`deploy.staging.ssh_options`	`oneOf`	SSH options with no command-line flag, see 'man ssh'
`deploy.staging.ref`	`string`	GIT remote/branch
`deploy.staging.repo`	`string`	GIT remote
`deploy.staging.path`	`string`	path in the server
`deploy.staging.pre-setup`	`string`	Pre-setup command or path to a script on your local machine
`deploy.staging.post-setup`	`string`	Post-setup commands or path to a script on the host machine
`deploy.staging.pre-deploy-local`	`string`	pre-deploy action
`deploy.staging.post-deploy`	`string`	post-deploy action
`deploy.development`	`object`	—
`deploy.development.key`	`string`	SSH key path. Defaults to $HOME/.ssh
`deploy.development.user`	`string`	SSH user
`deploy.development.host`	`oneOf`	SSH host
`deploy.development.ssh_options`	`oneOf`	SSH options with no command-line flag, see 'man ssh'
`deploy.development.ref`	`string`	GIT remote/branch
`deploy.development.repo`	`string`	GIT remote
`deploy.development.path`	`string`	path in the server
`deploy.development.pre-setup`	`string`	Pre-setup command or path to a script on your local machine
`deploy.development.post-setup`	`string`	Post-setup commands or path to a script on the host machine
`deploy.development.pre-deploy-local`	`string`	pre-deploy action
`deploy.development.post-deploy`	`string`	post-deploy action

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
64 properties, 95% carrying a description, max nesting depth 8.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$ref`	JSON Schema Core, draft 2020-12	§8.2.3.1 — Direct References with "$ref"
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`oneOf`	JSON Schema Core, draft 2020-12	§10.2.1.3 — "oneOf"
`patternProperties`	JSON Schema Core, draft 2020-12	§10.3.2.2 — "patternProperties"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`required`	JSON Schema Validation, draft 2020-12	§6.5.3 — "required"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas