Skip to content

gateway

The gateway configuration type allows creating and updating gateways.

Configuration files must have a name ending with .dstack.yml (e.g., .dstack.yml or gateway.dstack.yml are both acceptable) and can be located in the project's root directory or any nested folder. Any configuration can be applied via dstack apply.

Examples

type: gateway
name: example-gateway

backend: aws
region: eu-west-1
domain: example.com

Root reference

name - (Optional) The gateway name.

default - (Optional) Make the gateway default.

backend - The gateway backend.

region - The gateway region.

domain - (Optional) The gateway domain, e.g. example.com.

public_ip - (Optional) Allocate public IP for the gateway. Defaults to True.

certificate - (Optional) The SSL certificate configuration. Defaults to type: lets-encrypt.

certificate[type=lets-encrypt]

type - Automatic certificates by Let's Encrypt. Must be lets-encrypt.

certificate[type=acm]

type - Certificates by AWS Certificate Manager (ACM). Must be acm.

arn - The ARN of the wildcard ACM certificate for the domain.