Create Magento App
Create ScandiPWA AppScandiPWA DocsGitHub
v2
v2
  • Create Magento App
  • Getting started
    • Getting Started
    • Prerequisites
      • Linux requirements
      • MacOS requirements
        • Apple Silicon
      • Windows requirements
    • Available commands
      • Start the application
      • Stop the application
      • Check application status
      • Enter application CLI
      • Explore application logs
      • Execute commands in Docker containers
      • Link a theme
      • Import database dump
      • ⚠️ Uninstall a project
    • Folder structure
    • Updating to New Releases
      • Testing Alpha Releases
    • Configuration File
      • System Configuration File
    • Supported Magento versions
    • How does it work?
    • Limitations
    • What Is New in Version 2
  • Usage guide
    • Using console commands
    • Accessing Docker containers
    • Linking a Scandi Theme
    • Enabling XDebug
    • Enabling SSL
    • Configuring PHP
    • Configuring Multi-Store
    • Configuring NewRelic
    • Access on the local network
    • Using custom domain
    • Using Enterprise Edition
    • Using OpenSearch
    • Importing database
      • Importing remote database
    • Converting legacy Docker setup to CMA
    • Improve Performance
  • Container images
    • PHP Images
      • PHP 8.4
      • PHP 8.3
      • PHP 8.2
      • PHP 8.1
      • PHP 7.4
      • PHP 7.3
      • PHP 7.2
    • ElasticSearch Images
      • ElasticSearch 6.8
  • Scripts Extensions
    • PHP Extensions
      • PHP Extensions Package
      • (deprecated) ionCube Extension
  • Troubleshooting
    • Common Issues
    • CMA Debugging
    • Uninstall CMA
Powered by GitBook
On this page
  • Using WSL
  • 1. Install WSL
  • 1.1 Install Windows Terminal (Optional)
  • 1.2 Install Visual Studio Code (Optional)
  • 2. Install Docker Desktop for Windows
  • 3. Enable WSL 2 integration in Docker Desktop settings
  • 4. Prepare the environment
  • 5. Start your application
  • Using VM

Was this helpful?

  1. Getting started
  2. Prerequisites

Windows requirements

PreviousApple SiliconNextAvailable commands

Last updated 3 days ago

Was this helpful?

Using WSL

1. Install WSL

To install WSL2 on Windows follow .

For we recommend choosing the latest Ubuntu release, as it has the best compatibility on Windows.

1.1 Install Windows Terminal (Optional)

On Windows with WSL, it is recommended to use . By using it you can open different shells and access different WSL distros in the same place, which is quite handy.

1.2 Install Visual Studio Code (Optional)

VSCode has excellent integration with WSL, so you can run commands, edit code and debug it inside a single editor. .

2. Install Docker Desktop for Windows

3. Enable WSL 2 integration in Docker Desktop settings

Go to Docker Desktop settings > General and make sure that Use the WSL 2 based engine checkbox is checked.

Then, go to Resources >WSL Integration and enable WSL integration into your distro.

Toggle your distro and click Apply & Restart.

4. Prepare the environment

If you don't have COMPOSER_AUTH environment variable or auth.json file in your project, CMA will run a setup wizard with detailed instructions for you to get access keys for the Magento repository. But you can also set up them manually by following the instructions below.

To work with Magento you need access keys to access the Magento repository.

  1. Generate Access Keypair

Now you have a public key and private key values.

To use them you have 2 options:

  1. Use COMPOSER_AUTH environmental variable

    This option is used as a global variable on your machine.

    Replace <public key> and <private key> with your public and private key.

    export COMPOSER_AUTH='{
        "http-basic":{
            "repo.magento.com": {
                "username": "<public key>",
                "password": "<private key>"
            }
        }
    }'

    Add the result to your .bashrc or .zshrc and reload your terminal.

  2. Use auth.json file

    This option is used on a per-project basis, so your credentials will be always correct no matter which project you are working on.

    Create auth.json file in the root of your project and inside put the following content using the same <public key> and <private key> you obtained before:

    {
        "http-basic":{
            "repo.magento.com": {
                "username": "<public key>",
                "password": "<private key>"
            }
        }
    }

5. Start your application

Using VM

Download and install .

Go to

Start command description can be found . To access Magento CLI, Composer and PHP use command.

As an option, you can run CMA on Windows using a Linux VM running in (free) or (paid). We recommend using or distros, although , and distros based on apt , pacman, yum, dnf package managers should also work. for this option is the same as installing on a regular Linux platform.

Docker Desktop for Windows
https://marketplace.magento.com/customer/accessKeys/
here
cli
Virtual Box
VMWare Workstation Player
Ubuntu
Fedora
Linux Mint
CentOS
Installation guide
this guide
step #6 Install your Linux distribution of choice
Windows Terminal
Developing in WSL