What is reflex cloud config?

The following command:

generates a cloud.yml configuration file used to deploy your Reflex app to the Reflex cloud platform. This file tells Reflex how and where to run your app in the cloud.

Configuration File Structure

The cloud.yml file uses YAML format and supports the following structure. All fields are optional and will use sensible defaults if not specified:

Configuration Options Reference

Option

Type

Default

Description

name

string

folder name

Deployment identifier in dashboard

description

string

empty

Description of deployment

regions

object

sjc: 1

Region deployment mapping

vmtype

string

c1m1

Virtual machine specifications

hostname

string

null

Custom subdomain

envfile

string

.env

Environment variables file path

project

uuid

null

Project uuid

projectname

string

null

Project name

packages

array

empty

Additional system packages

include_db

boolean

false

Include local sqlite

strategy

string

auto

Deployment strategy

Configuration Options

For details of specific sections click the links in the table.

Projects

Organize deployments using projects:

You can also specify a project uuid instead of name:

You can go to the homepage of the project in the reflex cloud dashboard to find your project uuid in the url https://cloud.reflex.dev/project/uuid

Apt Packages

Install additional system packages your application requires. Package names are based on the apt package manager:

Include SQLite

Include local sqlite database:

This is not persistent and will be lost on restart. It is recommended to use a database service instead.

Strategy

Deployment strategy: Available strategies:

  • immediate: [Default] Deploy immediately
  • rolling: Deploy in a rolling manner
  • bluegreen: Deploy in a blue-green manner
  • canary: Deploy in a canary manner, boot as single machine verify its health and then restart the rest.

Multi-Environment Setup

Development (cloud-dev.yml):

Staging (cloud-staging.yml):

Production (cloud-prod.yml):

Deploy with specific configuration files:

Built with Reflex