Deploy Settings

Squadbase uses a YAML configuration file to define how your dashboard should be built and deployed. When you specify build and cloud environment settings, they're automatically applied during deployment.

The file is typically saved as squadbase.yml, but you can customize the filename by changing the Setting file path in the dashboard. The required configuration options vary depending on your runtime and framework.

version: '1'

build:
  framework: streamlit
  runtime: python3.11
  package_manager: pip
  entrypoint: app.py

deployment:
  provider: gcp
  gcp:
    memory: 1Gi
    cpu: 1
    timeout: 300
    concurrency: 80
    min_instances: 0
    max_instances: 10

version: '1'

build:
  framework: nextjs
  runtime: node20
  package_manager: npm

deployment:
  provider: aws
  aws:
    memory: 512
    timeout: 30
    provisioned_concurrency: 0
    ephemeral_storage: 512

version: '1'

build:
  framework: fastapi
  runtime: python3.11
  package_manager: pip

deployment:
  provider: aws
  aws:
    memory: 512
    timeout: 30
    provisioned_concurrency: 0
    ephemeral_storage: 512

version: '1'

build:
  framework: django
  runtime: python3.11
  package_manager: pip

deployment:
  provider: aws
  aws:
    memory: 512
    timeout: 30
    provisioned_concurrency: 0
    ephemeral_storage: 512

version: '1'

build:
  dockerfile: Dockerfile
  context: .
  build_args:
    NODE_ENV: production

deployment:
  provider: gcp
  gcp:
    memory: 1Gi
    cpu: 1
    timeout: 300
    concurrency: 80

Place your squadbase.yml in the root of your project's codebase.

Build

Configure build settings under the build: section.

Squadbase uses Docker to build your dashboards. For officially supported frameworks, you don't need to write your own Dockerfile—Squadbase provides one automatically. If you're using an unsupported framework or need to customize your environment (e.g., installing additional packages), you can provide your own Dockerfile.

Using an officially supported framework

When using a supported framework, configure the following settings:

When deploying with a supported framework, Squadbase provides the following capabilities:

• Invite-only cloud deployment
• Built-in user authentication
• User analytics
• Log monitoring
• User feedback collection

Using a custom Dockerfile

If a Dockerfile exists in your project root, Squadbase will use it instead of the framework-specific build settings. You can also specify a custom Dockerfile path using the dockerfile key.

Example:

build:
  dockerfile: docker/Dockerfile.prod
  context: .
  build_args:
    NODE_ENV: production
    API_KEY: ${API_KEY}

Deployment

Configure deployment settings under the deployment: section. Use provider to specify your cloud provider. If not specified, aws is used by default.

AWS

GCP

Pricing

Runtime charges are based on three metrics: memory usage, request count, and CPU usage. You're billed according to the compute specifications defined in your deployment settings.

GB-seconds and vCPU-seconds represent the cost of using 1 GB of memory or 1 vCPU for one second, respectively.