New environment¶
Project creation
If you are looking for information on how to create a new project, please refer to the 'create a new project' page for more details.
Introduction¶
This page walks you through the process of creating a new environment within an existing project. Environments are essential for testing, staging, and deploying your applications. The steps outlined below assume you have the necessary permissions (e.g., Architect role) to access and manage environments within your project.
Prerequisites¶
Before you begin, ensure you have the following:
- Appropriate Permissions: You must have an Architect role or equivalent permissions to create environments.
- Existing Project: The environment must be added to an existing project where the project type and install profile have already been set.
Step 1: Access the environment creation option¶
Where to find the environment creation option¶
To create a new environment, navigate to the Environments tab in your project. If you have the correct permissions, you will see a '+' card at the top of the tab, which allows you to initiate the creation of a new environment.
Step 2: Filling out environment details¶
How to create an environment¶
After clicking the '+' card, you will be taken to a page with a form that needs to be completed:
- Project Type: This field is fixed as the project type was set when the project was initially created.
- Install Profile: Similar to the project type, the install profile is also fixed at this stage.
- Environment Name: Provide a unique name for your environment.
- Description (Optional): You may add a description, which can be helpful if this environment is being created for a specific feature or purpose.
- Server Selection: Select the server on which the environment will be hosted.
Step 3: Server configuration¶
The server you select plays a crucial role in determining the technical specifications of the environment, including:
- PHP Version(s): The available PHP versions will be determined by the server. This step is only visible if the project type requires PHP to function.
- NodeJS Version(s): The available NodeJS versions will be determined by the server. This step is only visible if the project type requires NodeJS to function.
- Deployment Methods: The server also influences the available deployment methods.
Step 4: Monitoring environment creation¶
Once you confirm your choices and submit the form, you will be redirected to the Environments tab. Here, you can monitor the status of your new environment as it is being created.
Environment creation may take some time. You can leave the page and return later or keep track of the process via the notifications (accessible through the bell icon in the header).
Step 5: Accessing the new environment¶
After the environment has been successfully created, it will appear in the Environments tab. From here, you can access and manage your new environment.
You can also explore detailed settings and configurations for the environment by selecting it from the list.
Conclusion¶
Creating an environment in your project is a straightforward process involving a few essential steps. By following this guide, you can quickly set up a new environment, configure server settings, and monitor the creation progress. Once the environment is ready, you can access it from the Environments tab to begin testing or deploying your applications.
Next steps¶
Depending on your project and the chosen deployment method, some manual steps may still be necessary before you can deploy or use your new environment. Be sure to read the corresponding entries for your chosen deployment method.