Upsun User Documentation

Upsun YAML structure

Sign up

Get your free trial by clicking the link below.

Get your Upsun free trial

In addition to the basic functions you should be familiar with, YAML structure is important. Upsun accepts a specific structure for YAML configuration files.

YAML file location Anchor to this heading

When you run the upsun project:init command, a default config.yaml file is generated in the .upsun folder. It contains the minimum default configuration based on your detected local stack. This YAML file is located in your .upsun directory, at the root of your project source code, and is a good starting point before customization.

โ”œโ”€โ”€ .upsun
|ย ย  โ””โ”€โ”€ config.yaml
โ””โ”€โ”€ <source code>

Mandatory top-level keys Anchor to this heading

In the config.yaml file, there are only three mandatory top-level YAML keys:

  • applications: this section of the file contains all of your app definitions
  • routes: this section of the file contains all of your route definitions (for each of your apps)
  • services: this section of the file contains all of your service definitions (for each of your apps)

This looks like:


    type: mariadb:10.6 # All available versions are: 10.6, 10.5, 10.4, 10.3

    type: upstream
    upstream: "app:http"

Below these three top-level key sections, you can use any of the available YAML tags you need.

Rules on YAML files Anchor to this heading

The following rules apply to YAML files contained in the .upsun folder:

Is this page helpful?