Rename the default environment
You can set the name of your default/production environment when creating a project. To change it after project creation, follow the steps below. For consistency, the steps are all given using the CLI.
The examples below are based off of changing the default environment from
Replace these names with what suits your situation.
If your site is already live, remember that deactivating an environment is a destructive operation that can result in data loss. To minimize potential issues, take the following steps:
- Switch the default environment during non-peak hours.
- Keep your data by taking a backup of the
- Reduce your DNS time-to-live (TTL) to a minimum.
If you have a domain set for your default environment, remove it before changing the default branch.
Otherwise you get an error that
default domain must be a valid project domain.
To change the default branch, you need to be an admin for the project
The following steps depend of whether your project has a source integration.
If it doesn’t, Platform.sh is your primary remote repository for the project. If it does, GitHub, GitLab, or BitBucket hosts your primary remote repository for the project.
In your local copy of your repository, create a new environment from
platform environment:branch main old
In your local copy of the external repository, make sure your default branch is up to date:
git checkout old && git pull origin old
Then create the
main branch off of your default branch and push it to the remote repository:
git checkout -b main git push origin main
Source integrations include all branches, but don’t activate the corresponding environments in Platform.sh.
main environment by running the following command:
platform environment:activate main
If you have variables or other settings specific to your default environment, add those to the
For example, you may have variables for your production environment set to not be inheritable
(such as if you set them with
--inheritable=false through the CLI).
These variables aren’t added automatically to child environments and so you need to add them to the
main environment manually.
If you want the
main environment to send emails, turn on outgoing email.
main be your default, it needs to not be a child of
Use the following command to remove its parent and make it a top-level branch:
platform environment:info -e main parent -
You probably have other environments that are children of
For each environment, update its parent to
platform environment:info -e <ENVIRONMENT_NAME> parent main
To preserve your data on Platform.sh,
it’s best to switch your work in progress to be based off of
Close any open pull/merge requests and resubmit them against
If you want to continue working on branches after switching the default branch,
rebase them by running
git rebase --onto main <BRANCH_NAME>.
Once you resubmit a request, it appears under the
main environment on Platform.sh.
To change your default branch, you first need to deactivate the existing default branch to remove protections.
old environment without deleting it by running the following CLI command:
platform environment:delete --no-delete-branch old
old has been deactivated, set the project’s default branch to
platform project:info default_branch main
Whether or not you’re using a CDN,
if your site is live you have probably added a Platform.sh address somewhere when configuring a custom domain.
If you have a CDN, it’s with the CDN provider.
If you don’t have a CDN, it’s probably a
In either case, the setting probably has the old environment name as part of it. Update the setting to use the new environment name.
Verify that the new URL is correct by comparing it to the result from this command:
platform environment:info edge_hostname
If you no longer want the
old environment, such as to stop accidental use, delete it completely:
platform environment:delete --delete-branch old