When you're developing and iterating on your product, you need a place to work freely while leaving your production code untouched. You might have a variety of environments such as Dev, Staging, QA, and Prod and push from one to the next as you work through the production cycle.
With Builder's environments, you can create environments to meet your company's workflow and sync environments, models, and content as needed.
To get the most out of this tutorial, you should have already have the following:
- Builder Admin permissions in a space with an Enterprise plan
By default, Builder offers three environments for Enterprise plans, which include the main environment. This means that in addition to the main environment that an Enterprise plan starts with, you can create two more.
If you'd like to add more than two environments to bring your total environment count beyond three, contact your Account Executive, email sales@builder.io, or reach out to us through our contact form.
- Go to the Space Settings.
- On the Environments tab, click the + New Environment button.
- In the dialogue that opens, enter a name for the new Environment.
- Click Create Environment. You can close the Creating your new environment notification as the process runs in the background. When the environment is ready, the Synced status changes to Completed.
- Click Enter to go into the new environment.
When you create an environment, make sure to integrate in the same way you integrate the main Space. For detailed instructions, refer to Integrating Pages.
The following video demonstrates creating an environment.
Click Enter to go into the new environment. To return to your main environment, select the main space from the top left sidebar or go to the Settings Environments tab and click Enter.
When an environment is created in Builder, it serves as a clone of the originating space. As a result, various settings from the original space are replicated in the environment during its creation. This includes user accounts, roles, and other space-level configurations.
Organization settings are not automatically synchronized between the original space and its associated environments after the initial creation.
This means that any changes made to the Organization settings in the original space, such as adding new users or modifying settings, will not be automatically propagated to the corresponding environments.
Example
Suppose the original space has five users with specific space settings enabled. During the creation of an environment, these users and their associated settings are duplicated in the environment.
However, if you subsequently add new users or modify settings in the original space, those changes will not be reflected in the existing environments.
To ensure consistency between the original space and its environments, a manual re-sync process must be initiated. By performing a re-sync, you can update the environment to mirror the current state of the original space, including any changes made to organization settings.
For instructions on re-syncing, read Re-syncing an Environment.
After you've set up environments, be sure to read Using Environments to learn how to leverage the available features.