Installation with Docker
Saleor is a 12-factor application that is configured using environment variables. We recommend using Docker because it takes care of all necessary dependencies.
Prerequisites
You need to install Docker Desktop and Docker Compose before following the instructions below.
To install Docker Desktop on Windows Home, please follow the instructions.
Installation
The following steps need to be performed inside a terminal window (Windows users may prefer to use the Windows Terminal, but the Command Prompt will also work).
Clone the repository and build Docker images:
git clone https://github.com/saleor/saleor-platform.git
cd saleor-platform
docker compose build
Saleor uses shared folders to enable live code reloading. If you're using Windows or MacOS you will need to:
- Add the cloned
saleor-platformdirectory to the list of shared directories in Docker (Settings -> Shared Drives or Preferences -> Resources -> File sharing). - Make sure that in Docker preferences, you have dedicated at least 5 GB of memory (Settings -> Advanced or Preferences -> Resources -> Advanced).
Apply database migrations:
docker compose run --rm api python3 manage.py migrate
Optionally, populate the database with sample data and create the admin user:
docker compose run --rm api python3 manage.py populatedb
Finally, create an admin account:
docker compose run --rm api python3 manage.py createsuperuser
Running the services
Use the following command to run all Saleor containers (from within the saleor-platform directory):
docker compose up
Both storefront and dashboard are relatively large frontend projects, and it might take up to a few minutes for them to compile, depending on your CPU. If nothing shows up on port 3001 or 9000, wait until Compiled successfully shows in the console output.
Troubleshooting
Make sure Docker and Docker Compose work before attempting to run Saleor. Unfortunately, we won't be able to assist with your Docker installation.
Windows versions before Windows 10 are not officially supported.
See also: