scalingo.json configuration

scalingo.json configuration files

Type object
File match scalingo.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/scalingo-json-configuration/latest.json
Source https://raw.githubusercontent.com/Scalingo/developers-documentation/refs/heads/master/scalingo.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Extracted from https://developers.scalingo.com

Properties

name string required

Complete name of the project

Default: "NameOfMyApp"
$schema string
description string

Description in one or two sentences of the app

website string

Official website of the application if any

repository string

Location of the GIT repository of the project

ref string

Branch name or commit ID of the code to use

stack string

Name of the stack to use : https://doc.scalingo.com/platform/internals/stacks/stacks

Default: "scalingo-22"
Values: "scalingo-22" "scalingo-20" "scalingo-18" "scalingo-14"
copy_parent_database_urls enum

Copy database credentials from parent app

Values: "true" "false" true false
formation Record<string, object>

Formation of containers when an app is created

The formation is the definition of the container which will be started once the application is deployed. (Either coming from a one-click deployment button, or a review app from the GitHub integration)

See https://doc.scalingo.com/platform/app/scaling

env Record<string, object | object | object | object | object>

The keys of the environment object are the name of the variables you want to add.

Note: supplying null or an empty string to value will remove the variable from the environment.

It can be used to delete environment variables present in the parent app.

See https://doc.scalingo.com/platform/app/environment

scripts object

The scripts.postdeploy key is now deprecated in favor of postdeploy hook in the Procfile.

More information on the dedicated page : https://doc.scalingo.com/platform/app/review-apps#run-a-task-after-the-first-deployment-of-a-review-app

Default:
{
  "first-deploy": "bundle exec rake db:deploy db:seed"
}
1 nested properties
first-deploy string

Job to run as postdeploy hook at the first deployment of a review app or one-click deployed app

addons object | string[]

If no addons key is specified, the default behaviour is to duplicate the addons from the parent application.

The addons field contains an array of object describing the addons you need to deploy for your review app.

See https://doc.scalingo.com/addons

Definitions

addons object | string[]

If no addons key is specified, the default behaviour is to duplicate the addons from the parent application.

The addons field contains an array of object describing the addons you need to deploy for your review app.

See https://doc.scalingo.com/addons

formation Record<string, object>

Formation of containers when an app is created

The formation is the definition of the container which will be started once the application is deployed. (Either coming from a one-click deployment button, or a review app from the GitHub integration)

See https://doc.scalingo.com/platform/app/scaling

env Record<string, object | object | object | object | object>

The keys of the environment object are the name of the variables you want to add.

Note: supplying null or an empty string to value will remove the variable from the environment.

It can be used to delete environment variables present in the parent app.

See https://doc.scalingo.com/platform/app/environment