Overview

The playbooks.json configuration file lets you specify various Play properties via code for faster deployments and precise details.

How it Works

Simply include a playbooks.json file at the root of your project and our system will automatically read and apply it when connecting or syncing your play. If for some reason, you encouter issues, make sure and check your console logs as each segment may break if you have the wrong configuration and / or properties.

The Configuration File

Playbooks.json
{
  "coverType": "",
  "cover": "",
  "video": "",
  "poster": "",
  "thumbnail": "",
  "name": "",
  "description": "",
  "variant": "",
  "setup": {
    "welcomeComplete": true,
    "basicsComplete": true,
    "connectionComplete": true,
    "mediaComplete": true,
    "techComplete": true,
    "demoComplete": true,
    "reviewComplete": true
  },
  "qualities": {
    "hasDemo": true,
    "hasReadme": true,
    "hasLicense": true,
    "hasDistribution": true
  },
  "demo": {
    "strategy": "",
    "subdomain": "",
    "port": 3000,
    "subdirectory": "",
    "dockerfile": "",
    "dockercompose": "",
    "image": "",
    "partial": "",
    "networks": [],
    "env": [{ "key": "", "value": "" }],
    "files": [{ "path": "", "content": "" }],
    "commands": [],
    "https": true;
  },
  "frameworks": [],
  "languages": [],
  "platforms": [],
  "packages": [],
  "tools": [],
  "tags": [],
}
PrevQuickstartNextComparisons