Skip to content

Upsun Integration

DDEV provides integration with the Upsun by Platform hosting system, allowing Upsun users to easily download database and files from Upsun to a local DDEV-managed environment.

DDEV’s Upsun integration pulls databases and files from an existing Upsun site/environment into your local system so you can develop locally.

Upsun Global Configuration

You need to obtain and configure an API token first. This only needs to be done once.

  1. Login to the Upsun Dashboard and go to My Profile → API Tokens. Create an API token DDEV can use.
  2. Add the API token to the web_environment section in your global DDEV configuration at ~/.ddev/global_config.yaml:
web_environment:
  - UPSUN_CLI_TOKEN=abcdeyourtoken

Upsun Per-Project Configuration

  1. Check out the Upsun site and configure it with ddev config. You’ll want to use ddev start and make sure the basic functionality is working.

  2. Add UPSUN_PROJECT and UPSUN_ENVIRONMENT variables to your project.

    • Either in .ddev/config.yaml or a .ddev/config.*.yaml file:

      web_environment:
- UPSUN_PROJECT=nf4amudfn23biyourproject
- UPSUN_ENVIRONMENT=main

    • Or with a command from your terminal:

      ddev config --web-environment-add="UPSUN_PROJECT=nf4amudfn23bi,UPSUN_ENVIRONMENT=main"

  3. Run ddev restart.

  4. Run ddev pull upsun. After you agree to the prompt, the current upstream databases and files will be downloaded.
  5. Optionally use ddev push upsun to push local files and database to Upsun. The ddev push command can potentially damage your production site, so we don’t recommend using it.

Usage

  • ddev pull upsun will connect to Upsun to download database and files. To skip downloading and importing either file or database assets, use the --skip-files and --skip-db flags.
  • If you need to change the upsun.yaml recipe, you can change it to suit your needs, but remember to remove the #ddev-generated line from the top of the file.