Upsun config

Upsun configuration file

Type object
File match **/.upsun/config.yml **/.upsun/config.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/upsun-config/latest.json
Source https://meta.upsun.com/schema/upsun

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

applications Record<string, object> required

For more information, see https://docs.upsun.com/create-apps/app-reference/single-runtime-image.html#primary-application-properties

routes Record<string, object | object>

Each route describes how an incoming URL is going to be processed by Upsun. More information:
https://docs.upsun.com/define-routes.html

services Record<string, object>

Each service listed will be deployed to power your Upsun project.
More information:
https://docs.upsun.com/add-services.html Full list of available services:
https://docs.upsun.com/add-services.html#available-services

Definitions

container_profile string | null

Leave blank to allow it to be set dynamically. More information: https://docs.upsun.com/manage-resources/adjust-resources.html#adjust-a-container-profile

mounts Record<string, object>

Directories that are writable even after the app is built. Allocated disk for mounts is defined with a separate resource configuration call using upsun resources:set. Contains a dictionary of mounts: https://docs.upsun.com/create-apps/app-reference/single-runtime-image.html#mounts

relationships Record<string, string | null | object>

Contains a dictionary of relationships: https://docs.upsun.com/create-apps/app-reference/single-runtime-image.html#relationships

primary boolean

If true, this route is the primary route of the environment

id string

A unique identifier for the route. See route identifiers: https://docs.upsun.com/define-routes.html#route-identifiers

attributes Record<string, string>

Arbitrary attributes attached to this resource: https://docs.upsun.com/define-routes.html#route-attributes

redirects object

Defines redirects for partial routes. For definition and options, see the redirect rules: https://docs.upsun.com/define-routes/redirects.html

paths Record<string, object> required

More information: https://docs.upsun.com/define-routes/redirects.html#partial-redirects

expires integer | string

Examples of valid values include 3600s, 1d, 2w, 3m. To disable caching for all your redirects, set expires to 0. You can also disable caching on a specific redirect:
https://docs.upsun.com/define-routes/redirects.html#disable-caching-on-your-redirects

Default: -1
tls object

The absolute URL or other route to which the given route should be redirected with an HTTP 301 status code. https://docs.upsun.com/define-routes/https.html#optional-configure-tls-connections

strict_transport_security object

https://docs.upsun.com/define-routes/https.html#optional-configure-tls-connections

Default:
{
  "preload": null,
  "include_subdomains": false,
  "enabled": false
}
3 nested properties
enabled boolean

If set to true, HSTS is enabled for 1 year.
If set to false, other properties are ignored.

Default: null
include_subdomains boolean

More information: https://docs.upsun.com/define-routes/https.html#enable-http-strict-transport-security-hsts

Default: false
preload boolean

To add your website to the HSTS preload list: https://hstspreload.org/. Thanks to this list, most browsers are informed that your site requires HSTS before an HSTS header response is even issued.

Default: false
min_version string

Note that TLS versions older than 1.2 are deprecated and are rejected by default.

Default: null
Values: "TLSv1.1" "TLSv1.0" "TLSv1.3" "TLSv1.2"
client_authentication string

The type of client authentication to request.

Default: null
client_certificate_authorities string[]

If not specified, a default set of trusted CAs will be used. More Information: https://docs.upsun.com/define-routes/https.html#enable-mtls

Default:
[]
to string

The absolute URL or other route to which the given route should be redirected with an HTTP 301 status code. A relative URL - '/destination', or absolute URL - 'https://example.com/' More information: https://docs.upsun.com/define-routes/redirects.html#partial-redirects

cache object
enabled boolean required
default_ttl integer
Default: 0
cookies string[]
Default:
[
  "*"
]
headers string[]
Default:
[
  "Accept",
  "Accept-Language"
]
upstream string

The name of the app to be served (as defined in your app configuration) followed by :http. Example: app:http More information: https://docs.upsun.com/define-routes.html#route-configuration-reference

size string

Leave blank to allow it to be set dynamically.

resources object
base_memory integer
Default: 64
memory_ratio integer
Default: 128