Fly.io

import { Required } from '@site/src/components/Tag'; import LaunchCommandEnvVars from './_launch-command-env-vars.md' import CiCdMention from './_ci-cd-mention.md' import CustomServerUrlOption from './_custom-server-url-option.md'

Fly.io is a platform for running containerized apps and microservices on servers around the world. It makes deploying and managing your apps straightforward with minimal setup.

Prerequisites

To deploy to Fly.io using Wasp CLI:

1. Create a Fly.io account

2. Fly requires you to add a payment method before you can deploy more than two Fly apps. To deploy Wasp apps, you need three Fly apps: the client, the server, and the database.

3. Install the fly CLI on your machine.

Deploying

Using the Wasp CLI, you can easily deploy a new app to Fly.io with just a single command:

wasp deploy fly launch my-wasp-app dfw

Two things to keep in mind:

1. Your app name (for example my-wasp-app) must be unique across all of Fly or deployment will fail.

2. If your account is a member of more than one organization on Fly.io, you will need to specify under which one you want to execute the command. To do that, provide an additional --org <org-slug> option. You can find out the names (slugs) of your organizations by running fly orgs list.

The launch command uses the app basename my-wasp-app and deploy it to the dfw region (dfw is short for Dallas, Texas (US)). Read more about Fly.io regions here.

The basename is used to create all three app tiers, resulting in three separate apps in your Fly dashboard:

• my-wasp-app-client
• my-wasp-app-server
• my-wasp-app-db

You'll notice that Wasp creates two new files in your project root directory:

• fly-server.toml
• fly-client.toml

You should include these files in your version control so that you can deploy your app with a single command in the future.

If your app requires any additional environment variables, use the wasp deploy fly cmd secrets set command. Read more in the API Reference section.

Using a Custom Domain For Your App {#custom-domain}

Setting up a custom domain is a three-step process:

1. You need to add your domain to your Fly client app. You can do this by running:

wasp deploy fly cmd --context client certs create mycoolapp.com

:::note Use Your Domain Make sure to replace mycoolapp.com with your domain in all of the commands mentioned in this section. :::

This command will output the instructions to add the DNS records to your domain. It will look something like this:

You can direct traffic to mycoolapp.com by:

1: Adding an A record to your DNS service which reads

    A @ 66.241.1XX.154

You can validate your ownership of mycoolapp.com by:

2: Adding an AAAA record to your DNS service which reads:

    AAAA @ 2a09:82XX:1::1:ff40

2. You need to add the DNS records for your domain:

   This will depend on your domain provider, but it should be a matter of adding an A record for @ and an AAAA record for @ with the values provided by the previous command.

3. You need to set your domain as the WASP_WEB_CLIENT_URL environment variable for your server app:

wasp deploy fly cmd --context server secrets set WASP_WEB_CLIENT_URL=https://mycoolapp.com

That's it, your app should be available at https://mycoolapp.com!

Adding a www Subdomain

If you'd also like to access your app at https://www.mycoolapp.com, you can generate certificates for the www subdomain.

wasp deploy fly cmd --context client certs create www.mycoolapp.com

Once you do that, you will need to add another DNS record for your domain. It should be a CNAME record for www with the value of your root domain. Here's an example:

With the CNAME record (Canonical name), you are assigning the www subdomain as an alias to the root domain.

Your app should now be available both at the root domain https://mycoolapp.com and the www sub-domain https://www.mycoolapp.com.

:::caution CORS Configuration

Using the www and non-www domains at the same time will require you to update your CORS configuration to allow both domains. You'll need to provide custom CORS configuration in your server app to allow requests from both domains.

:::

Environment Variables {#flyio-cli-environment-variables}

Server Secrets

If your app requires any other server-side environment variables (like social auth secrets), you can set them:

1. Initially, in the launch or setup commands with the --server-secret option

2. After the app has already been deployed by using the secrets set command:

   Copy

   wasp deploy fly cmd secrets set GOOGLE_CLIENT_ID=<...> GOOGLE_CLIENT_SECRET=<...> --context=server
   

Client Environment Variables

If you've added any client-side environment variables to your app, pass them to the terminal session before running a deployment command, for example:

REACT_APP_ANOTHER_VAR=somevalue wasp deploy fly launch my-wasp-app dfw

or

REACT_APP_ANOTHER_VAR=somevalue wasp deploy fly deploy

Please note that you should do this for every deployment, not just the first time you set up the variables. One way to make sure you don't forget to add them is to create a deploy script in your package.json file:

{
  "scripts": {
    "deploy": "REACT_APP_ANOTHER_VAR=somevalue wasp deploy fly deploy"
  }
}

Then you can run npm run deploy to deploy your app.

Fly.io Regions

Fly.io runs applications physically close to users: in datacenters around the world, on servers we run ourselves. You can currently deploy your apps in 34 regions, connected to a global Anycast network that makes sure your users hit our nearest server, whether they’re in Tokyo, São Paolo, or Frankfurt.

You can find the list of all available Fly regions by running:

fly platform regions

Multiple Fly.io Organizations

If you have multiple organizations, you can specify a --org option. For example:

wasp deploy fly launch my-wasp-app dfw --org hive

Building Locally

Fly.io offers support for both locally built Docker containers and remotely built ones. However, for simplicity and reproducibility, the CLI defaults to the use of a remote Fly.io builder.

If you want to build locally, supply the --build-locally option to wasp deploy fly launch or wasp deploy fly deploy.

Using a custom PostgreSQL database

By default, Wasp uses the standard PostgreSQL Docker image provided by Fly.io when creating a new database for your app. However, if you have a need for a custom Docker image, e.g., your application requires specific PostgreSQL extensions (e.g., PostGIS), you can specify a Docker image with a custom PostgreSQL installation, with the --db-image <docker-image> flag.

Your custom PostgreSQL image must be compatible with Fly.io, as their platform has some requirements to work properly. Since these requirements are not readily documented, an easy way to ensure compatibility is to base your custom image off the official Fly.io PostgreSQL image: flyio/postgres-flex.

We have crafted a small guide on how to create a custom Docker image with PostGIS or pgvector for Fly.io. You can also use it as a starting point to create your own images with other extensions.

:::tip You only need to specify the Docker image once, when first creating the app with any of these commands:

wasp deploy fly create-db <region> --db-image <custom-postgres-image>
wasp deploy fly setup <app-name> <region> --db-image <custom-postgres-image>
wasp deploy fly launch <app-name> <region> --db-image <custom-postgres-image>

:::

API Reference

launch

launch is a convenience command that runs setup, create-db, and deploy in sequence.

wasp deploy fly launch <app-name> <region>

It accepts the following arguments:

• <app-name> <Required />

  The name of your app.

• <region> <Required />

  The region where your app will be deployed. Read how to find the available regions here.

Running wasp deploy fly launch is the same as running the following commands:

wasp deploy fly setup <app-name> <region>
wasp deploy fly create-db <region>
wasp deploy fly deploy

Environment Variables {#fly-launch-environment-variables}

Server

If you are deploying an app that requires any other environment variables (like social auth secrets), you can set them with the --server-secret option:

wasp deploy fly launch my-wasp-app dfw --server-secret GOOGLE_CLIENT_ID=<...> --server-secret GOOGLE_CLIENT_SECRET=<...>

Client

If you've added any client-side environment variables to your app, pass them to the terminal session before running the launch command, for example:

REACT_APP_ANOTHER_VAR=somevalue wasp deploy fly launch my-wasp-app dfw

setup

The setup command registers your client and server apps on Fly, and sets up needed environment variables. It only needs to be run once, when initially creating the app. It does not trigger a deploy for the client or server apps.

wasp deploy fly setup <app-name> <region>

It accepts the following arguments:

• <app-name> <Required />

  The name of your app.

• <region> <Required />

  The region where your app will be deployed. Read how to find the available regions here.

After running setup, Wasp creates two new files in your project root directory: fly-server.toml and fly-client.toml. You should include these files in your version control.

You can edit the fly-server.toml and fly-client.toml files to further configure your Fly deployments. Wasp will use the TOML files when you run deploy.

If you want to maintain multiple apps, you can add the --fly-toml-dir <abs-path> option to point to different directories, like "dev" or "staging".

:::caution Execute Only Once You should only run setup once per app. If you run it multiple times, it creates unnecessary apps on Fly. :::

create-db

The create-db command creates a new database for your app.

wasp deploy fly create-db <region>

It accepts the following arguments:

• <region> <Required />

  The region where your app will be deployed. Read how to find the available regions here.

:::caution Execute Only Once You should only run create-db once per app. If you run it multiple times, it creates multiple databases, but your app needs only one. :::

deploy

wasp deploy fly deploy

The deploy command pushes your built client and server live.

Run this command whenever you want to update your deployed app with the latest changes:

wasp deploy fly deploy

If you've added any client-side environment variables to your app, pass them to the terminal session before running the deploy command, for example:

REACT_APP_ANOTHER_VAR=somevalue wasp deploy fly deploy

You must specify your client-side environment variables every time you redeploy with the above command to ensure they are included in the build process.

cmd

If you want to run arbitrary Fly commands (for example fly secrets list for your server app), here's how to do it:

wasp deploy fly cmd secrets list --context server