Local environment setup
All environments for your project are read-only, requiring all work to be completed on your local environment and pushed to cloud environments. To start developing Magento, you need a configured local developer workspace, cloned Magento Commerce (Cloud) code from your Git branch, and knowledge of the deployment workflow. These instructions guide through the entire process to create a development workspace on your local system.
Project user account
Depending on the Project Owner, you may need to be invited by the owner to the project. This account gives you participation to the project and connects your local, credentials, and access to your company’s Magento Commerce (Cloud) account. The account includes all source code and deployment environments.
After you receive an invitation, you can complete tasks to create your local, pull code, and deploy your store.
We highly recommend having experience with the following technologies and methodologies:
- Magento technology stack
- Git for repository and code management, branching methodologies, and working with Magento Git code
- GitHub for managing your code and accessing Magento repos
- Fastly for CDN and caching, used in Staging and Production
- Galera Cluster for databases, used in Staging and Production (with triple reduncy failover in Production)
Prior to setting up your workspace, you may want to gather the following credentials and accounts:
- Magento Access Key: Provides secure access through a 32-character authentication token. The token authenticates between your account, the Magento 2 code repo (repo.magento.com), and any other Git services like GitHub and 3rd party accounts needed for development. You can create multiple Magento access keys. For the workspace setup, you can start with one specific key for your code repository. To generate a key, contact the Project Owner to Generate Magento authentication keys.
- Cloud Project account: The Project Owner or Technical Admin (Super User) should invite you to the Magento Commerce (Cloud) project. When you receive the e-mail invitiation, click the link and follow the prompts to create your account. See Set up an account for details.
- Magento Encryption Key: When importing an existing Magento system only, you will need to capture the Magento encryption key used to protect your access and data for the Magento database. For details on this key, see Resolve issues with encryption key
Create a local evironment
For development, you need to install and configure a local environment. All environments for Magento Commerce (Cloud) are read-only, including all Starter environments and all Pro Integration, Staging, and Production environments. Working in a local environment, you can write and test code prior to pushing it to a Integration environment for further testing and deployment to Staging and Production.
We recommend adding a virtual machine (VM) or Docker container and installing Magento Commerce. The environment should closely match cloud environments. To develop Magento code, you will clone the project Git code and create branches to develop your sites and stores in this local environment.
The following steps walk-through preparing your local environment, installing Magento, and starting development:
- Prepare for local environment setup
- Install Magento prerequisites
- Enable SSH keys
- Set up the Magento file system owner (optional)
- Clone and branch the project
- Install Magento
- First time deployment
If you have existing Magento custom code, we provide instructions to import. For more information, see First steps for importing Magento Commerce.