Upsun User Documentation


Sign up

Get your free trial by clicking the link below.

Get your Upsun free trial

Active environment Anchor to this heading

An environment that’s deployed. See how to activate an environment.

Apex domain Anchor to this heading

An apex domain is a domain name that doesn’t include a subdomain.

For example, is an apex domain and is a subdomain.

Branch Anchor to this heading

Branching an environment means creating a new branch in the Git repository and an exact copy of that environment.

The new environment includes all of the parent environment’s:

  • Code
  • Running services and their configuration (only copies, not the data)
  • Data that’s stored on disk (databases, uploaded files, and so on)

This means that when you branch an environment, you also branch the complete infrastructure.

When you branch an environment, three things happen:

  • A new branch is created in Git.
  • Your apps are rebuilt on the new branch, if necessary. (This is skipped if the same code with the same variables has been built for any environment.)
  • The new branch is deployed.

To create a new branch from an existing environment:

  • Navigate to the environment you want to branch from.
  • Click Branch.
  • Enter a name for the new branch.
  • Select which environment type it should be.
  • Click Create branch.



To define the environment type for the branch, include --type <ENVIRONMENT_TYPE>.

For example, to create the branch develop as a preview environment (development type) from the branch main, run:

upsun branch develop main --type development

Cluster Anchor to this heading

Every active environment is deployed as a cluster, which is a collection of independent containers representing the different services that make up your web application. That may include a database container, an Elasticsearch container, a container for your application, and more. They’re always deployed together as a single unit.

Deprecated versions Anchor to this heading

Older versions of languages and services eventually reach the end of their lives. This means they stop getting security and other updates and may have security vulnerabilities.

When that happens, the versions in Upsun are deprecated. This means you can still use them in your project, but they aren’t fully secure. It’s also possible they’ll stop working at some point.

If you’re using a deprecated version, you should upgrade to a supported version as soon as possible.

Drush Anchor to this heading

Drush is a command-line shell and scripting interface for Drupal.

Drush aliases Anchor to this heading

Drush site aliases allow you to define short names that let you run Drush commands on specific local or remote Drupal installations. The Upsun CLI configures Drush aliases for you on your local environment (via upsun get or upsun drush-aliases). You can also configure them manually.

Environment Anchor to this heading

An environment is a standalone copy of your site, complete with code, data, and running services. Your production environment comes from the default branch and you can set up any other branch as a testing environment.

Environment type Anchor to this heading

Upsun offers three environment types:

  • Your production environment is your live site.
  • A development environment is an isolated environment where you can safely develop new features without affecting production.
  • A staging environment has a similar configuration to your production environment (but usually with less resources for cost optimization). It is useful to perform user acceptance testing in a production-like setting.

The phrase “preview environment” can apply to both a development or staging environment, as it merely describes a non-production environment.

Find out more about user roles on each environment type.

Inactive environment Anchor to this heading

An environment that isn’t deployed. It has no data of its own and no running services. If you reactivate it, it copies data from its parent.

See how to deactivate an environment.

Live environment Anchor to this heading

A publicly accessible environment that’s deployed from the Production branch under a production plan.

MB Anchor to this heading

MB stands for megabyte, which means 1,000,000 bytes. This unit is based on powers of 10.

Some reporting tools, such as those used by the CLI, use binary megabytes, also known as mebibytes and abbreviated as MiB. This unit is based on powers of 2 and so 1 MiB equals 10242 or 1,048,576 bytes. So 1 MB is less than 1 MiB.

So you may see differences in the numbers you configure for a disk (in MB) and the values reported when you check disk size with tools that report in MiB.

Merge Anchor to this heading

Merging an environment means copying any code changes from that environment into its parent environment and redeploying the parent.

When you merge an environment, three things happen:

  • Any code changes are merged via Git to the parent branch.
  • Your apps rebuilt on the parent branch, if necessary. (This is skipped if the same code with the same variables has been built for any environment.)
  • The parent branch is deployed.

PaaS Anchor to this heading

A Platform as a Service is an end-to-end hosting solution that includes workflow tools, APIs, and other functionality above and beyond basic hosting. The best example is Upsun(although we’re a little biased).

Preview environment Anchor to this heading

A preview environment is a non-production environment you can use to develop and/or test changes without affecting production.
A preview environment can either be a development environment or a staging environment. Staging environments have an identical software configuration to your production hardware but reduced hardware specs. They are useful to perform user acceptance testing.

Production plan Anchor to this heading

Project Anchor to this heading

A project is the site that you’re working on. Each project corresponds to one Git repository. A project can contain multiple apps that run in their own isolated containers. Each branch of a project can be deployed in its own environment.

Sync Anchor to this heading

Synchronizing an environment means copying changes from a parent into a child environment and then redeploying the child environment. You can synchronize only the code, only the data (databases, files), or both.

Be aware that sync has the same process and same concerns as backups.

Sync is only available if your branch has no unmerged commits and can be fast-forwarded.

It’s good practice to take a backup of your environment before synchronizing it.

Transport Layer Security (TLS) Anchor to this heading

TLS is the successor of Secure Socket Layer (SSL). It provides the cryptographic “S” in HTTPS. It’s often still referred to as SSL even though it has mostly replaced SSL for online encrypted connections.

Trial Anchor to this heading

When you create your first organization on Upsun, you are also activating your trial for that organization. This trial grants you a certain amount of time and resources to try out the Upsun platform, and comes with the following restrictions:

  1. A trial lasts for 5 days, which starts automatically from creating your first organization.

  2. A trial allows for one (1) active project at a time.

  3. For a trial project, the trial allows for two (2) active environments.

  4. At the organization level, there is a limit on the amount of resources available to your project:

    • 4.5 CPU
    • 12 GB RAM
    • 20 GB storage

If your trial ends before adding payment details, there are additional things to keep in mind:

  • When a trial expires, both the organization and the project are suspended.
  • Projects where no code has been pushed are deleted 1 day after a trial expires.
  • Projects where code has been pushed are deleted 5 days after the trial expires.
  • Even with the trial expiration, organizations and user accounts are preserved, rather than deleted.

Is this page helpful?