Portainer Templates logo

Portainer Templates

Saleor

Stack

CMS Publishing

Saleor - headless, GraphQL-first e-commerce (BSD-3): the API your custom storefront talks to, with a polished dashboard for the team. Official images, mirrored from the saleor-platform compose.

Configuration

Type
Compose
Platform
linux
Env vars
[email protected]ADMIN_PASSWORD=''ALLOWED_CLIENT_HOSTS=localhostALLOWED_HOSTS=localhost,apiAPI_URL=http://localhost:5000/graphql/DASHBOARD_URL=http://localhost:5001EMAIL_URL=consolemail://PUBLIC_URL=http://localhost:5000REDIS_AUTH=# openssl rand -base64 24SECRET_KEY=''
Source
Repo

Template by deployable-sh·Source

Report issue

Services

api

Configuration

Image
ghcr.io/saleor/saleor:3.23
Command
sh,-c,export RSA_PRIVATE_KEY="$(openssl genrsa 2048 2>/dev/null)"; exec uvicorn saleor.asgi:application --host=0.0.0.0 --port=8000 --workers=2 --lifespan=auto --ws=none --no-server-header --no-access-log --timeout-keep-alive=35 --timeout-graceful-shutdown=30 --limit-max-requests=10000
Ports
8000
Volumes
/app/media : media
Env vars
SECRET_KEY=${SECRET_KEY}DATABASE_URL=postgres://saleor:saleor-local-only@db:5432/saleorDEBUG=FalseALLOWED_HOSTS=${ALLOWED_HOSTS:-localhost,api}ALLOWED_CLIENT_HOSTS=${ALLOWED_CLIENT_HOSTS:-localhost}CELERY_BROKER_URL=redis://broker:6379/1CACHE_URL=redis://broker:6379/0EMAIL_URL=${EMAIL_URL:-consolemail://}PUBLIC_URL=${PUBLIC_URL:-http://localhost:5000}DASHBOARD_URL=${DASHBOARD_URL:-http://localhost:5001}DEFAULT_CHANNEL_SLUG=default-channel
Restart
unless-stopped

Image details

User: saleor

worker

Configuration

Image
ghcr.io/saleor/saleor:3.23
Command
sh,-c,export RSA_PRIVATE_KEY="$(openssl genrsa 2048 2>/dev/null)"; exec celery -A saleor --app=saleor.celeryconf:app worker -E -B
Volumes
/app/media : media
Env vars
SECRET_KEY=${SECRET_KEY}DATABASE_URL=postgres://saleor:saleor-local-only@db:5432/saleorDEBUG=FalseALLOWED_HOSTS=${ALLOWED_HOSTS:-localhost,api}ALLOWED_CLIENT_HOSTS=${ALLOWED_CLIENT_HOSTS:-localhost}CELERY_BROKER_URL=redis://broker:6379/1CACHE_URL=redis://broker:6379/0EMAIL_URL=${EMAIL_URL:-consolemail://}PUBLIC_URL=${PUBLIC_URL:-http://localhost:5000}DASHBOARD_URL=${DASHBOARD_URL:-http://localhost:5001}DEFAULT_CHANNEL_SLUG=default-channel
Restart
unless-stopped

Image details

User: saleor

migrate

Configuration

Image
ghcr.io/saleor/saleor:3.23
Command
sh,-c,export RSA_PRIVATE_KEY="$(openssl genrsa 2048 2>/dev/null)"; python3 manage.py migrate && (python3 manage.py createsuperuser --noinput || true) && sleep infinity
Env vars
SECRET_KEY=${SECRET_KEY}DATABASE_URL=postgres://saleor:saleor-local-only@db:5432/saleorDEBUG=FalseALLOWED_HOSTS=${ALLOWED_HOSTS:-localhost,api}ALLOWED_CLIENT_HOSTS=${ALLOWED_CLIENT_HOSTS:-localhost}CELERY_BROKER_URL=redis://broker:6379/1CACHE_URL=redis://broker:6379/0EMAIL_URL=${EMAIL_URL:-consolemail://}PUBLIC_URL=${PUBLIC_URL:-http://localhost:5000}DASHBOARD_URL=${DASHBOARD_URL:-http://localhost:5001}DEFAULT_CHANNEL_SLUG=default-channelDJANGO_SUPERUSER_EMAIL=${ADMIN_EMAIL}DJANGO_SUPERUSER_PASSWORD=${ADMIN_PASSWORD}
Restart
unless-stopped

Image details

User: saleor

dashboard

Configuration

Image
ghcr.io/saleor/saleor-dashboard:3.23
Ports
80
Env vars
API_URL=${API_URL:-http://localhost:5000/graphql/}
Restart
unless-stopped

Image details

User: saleor

web-api

Configuration

Image
caddy:2-alpine
Command
caddy,reverse-proxy,--from,:5000,--to,api:8000
Ports
5000:5000
Restart
unless-stopped

Image details

Pulls: 730.7M
User: library
Created: Apr 14, 2020
Updated: 1 day ago
Status: active

web-dashboard

Configuration

Image
caddy:2-alpine
Command
caddy,reverse-proxy,--from,:5000,--to,dashboard:80
Ports
5001:5000
Restart
unless-stopped

Image details

Pulls: 730.7M
User: library
Created: Apr 14, 2020
Updated: 1 day ago
Status: active

broker

Configuration

Image
valkey/valkey:8
Command
valkey-server,--maxmemory-policy,noeviction,--protected-mode,no
Ports
6379
Restart
unless-stopped

Image details

Pulls: 302.3M
User: valkey
Created: Apr 02, 2024
Updated: 11 hours ago
Status: active

db

Configuration

Image
postgres:15
Volumes
/var/lib/postgresql/data : dbdata
Env vars
POSTGRES_USER=saleorPOSTGRES_PASSWORD=saleor-local-onlyPOSTGRES_DB=saleor
Restart
unless-stopped

Image details

Pulls: 11.6B
User: stackbrew
Created: Jun 05, 2014
Updated: 1 hour ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Saleor

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Saleor, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

name: saleor

x-api-env: &api-env
  SECRET_KEY: ${SECRET_KEY}
  DATABASE_URL: postgres://saleor:saleor-local-only@db:5432/saleor
  DEBUG: "False"
  ALLOWED_HOSTS: ${ALLOWED_HOSTS:-localhost,api}
  ALLOWED_CLIENT_HOSTS: ${ALLOWED_CLIENT_HOSTS:-localhost}
  CELERY_BROKER_URL: redis://broker:6379/1
  CACHE_URL: redis://broker:6379/0
  EMAIL_URL: ${EMAIL_URL:-consolemail://}
  PUBLIC_URL: ${PUBLIC_URL:-http://localhost:5000}
  DASHBOARD_URL: ${DASHBOARD_URL:-http://localhost:5001}
  DEFAULT_CHANNEL_SLUG: default-channel

services:
  api:
    image: ghcr.io/saleor/saleor:3.23
    restart: unless-stopped
    command:
      - sh
      - -c
      - 'export RSA_PRIVATE_KEY="$(openssl genrsa 2048 2>/dev/null)"; exec uvicorn saleor.asgi:application --host=0.0.0.0 --port=8000 --workers=2 --lifespan=auto --ws=none --no-server-header --no-access-log --timeout-keep-alive=35 --timeout-graceful-shutdown=30 --limit-max-requests=10000'
    environment: *api-env
    ports:
      - "8000"
    volumes:
      - media:/app/media
    depends_on:
      - db
      - broker

  worker:
    image: ghcr.io/saleor/saleor:3.23
    restart: unless-stopped
    command:
      - sh
      - -c
      - 'export RSA_PRIVATE_KEY="$(openssl genrsa 2048 2>/dev/null)"; exec celery -A saleor --app=saleor.celeryconf:app worker -E -B'
    environment: *api-env
    volumes:
      - media:/app/media
    depends_on:
      - db
      - broker

  migrate:
    image: ghcr.io/saleor/saleor:3.23
    restart: unless-stopped
    command:
      - sh
      - -c
      - 'export RSA_PRIVATE_KEY="$(openssl genrsa 2048 2>/dev/null)"; python3 manage.py migrate && (python3 manage.py createsuperuser --noinput || true) && sleep infinity'
    environment:
      <<: *api-env
      DJANGO_SUPERUSER_EMAIL: ${ADMIN_EMAIL}
      DJANGO_SUPERUSER_PASSWORD: ${ADMIN_PASSWORD}
    depends_on:
      - db

  dashboard:
    image: ghcr.io/saleor/saleor-dashboard:3.23
    restart: unless-stopped
    environment:
      API_URL: ${API_URL:-http://localhost:5000/graphql/}
    ports:
      - "80"

  web-api:
    image: caddy:2-alpine
    command: ["caddy", "reverse-proxy", "--from", ":5000", "--to", "api:8000"]
    restart: unless-stopped
    ports:
      - "5000:5000"
    depends_on:
      - api

  web-dashboard:
    image: caddy:2-alpine
    command: ["caddy", "reverse-proxy", "--from", ":5000", "--to", "dashboard:80"]
    restart: unless-stopped
    ports:
      - "5001:5000"
    depends_on:
      - dashboard

  broker:
    image: valkey/valkey:8
    command: ["valkey-server", "--maxmemory-policy", "noeviction", "--protected-mode", "no"]
    restart: unless-stopped
    ports:
      - "6379"

  db:
    image: postgres:15
    restart: unless-stopped
    environment:
      POSTGRES_USER: saleor
      POSTGRES_PASSWORD: saleor-local-only
      POSTGRES_DB: saleor
    volumes:
      - dbdata:/var/lib/postgresql/data

volumes:
  media:
  dbdata:

Or deploy it directly from the source:

git clone https://github.com/deployable-sh/stacks
cd stacks
docker compose -f saleor/compose.yaml up -d

More install options in our documentation.

Container Documentation

web-api Documentation

Caddy 2 is a powerful, enterprise-ready, open source web server with automatic HTTPS written in Go.

web-dashboard Documentation

Caddy 2 is a powerful, enterprise-ready, open source web server with automatic HTTPS written in Go.

broker Documentation

Valkey is a high-performance data structure server that primarily serves key/value workloads.

db Documentation

The PostgreSQL object-relational database system provides reliability and data integrity.

Serve Saleor on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying saleor.example.com to http://api:8000

Add this to your Caddyfile

saleor.example.com {
	reverse_proxy http://api:8000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:5000 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :5000
  • Stop the other service, or pick a different host port. In 5000:5000 only the left number is yours to change, the right one belongs to the app.

Published on a random port

This template exposes 8000 without setting a host port, so Docker picks a random free one on every deploy.

  • Find it in the Ports column of Portainer's container list, or with docker port <container>

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:5000. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, saleor can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 5000

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/saleor/saleor:3.23

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Saleor is a Compose stack, a set of containers (8 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 8 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • api runs ghcr.io/saleor/saleor:3.23, starts after db, broker
  • worker runs ghcr.io/saleor/saleor:3.23, starts after db, broker
  • migrate runs ghcr.io/saleor/saleor:3.23, starts after db
  • dashboard runs ghcr.io/saleor/saleor-dashboard:3.23
  • web-api runs caddy:2-alpine, starts after api
  • web-dashboard runs caddy:2-alpine, starts after dashboard
  • broker runs valkey/valkey:8
  • db runs postgres:15

Ports

A port is the door the app answers on. A mapping like 5000:5000 means it's reachable on port 5000 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 8000, published on a random host port
  • 80, published on a random host port
  • 5000:5000
  • 5001:5000
  • 6379, published on a random host port

Volumes

A volume is where Saleor keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /app/media kept in the media volume Docker manages
  • /var/lib/postgresql/data kept in the dbdata volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Saleor takes 17 of them, all with defaults you can leave alone or tweak:

  • SECRET_KEY, pulled from your own environment
  • DATABASE_URL, defaults to postgres://saleor:saleor-local-only@db:5432/saleor
  • DEBUG, defaults to False
  • ALLOWED_HOSTS, defaults to localhost,api
  • ALLOWED_CLIENT_HOSTS, defaults to localhost
  • CELERY_BROKER_URL, defaults to redis://broker:6379/1
  • CACHE_URL, defaults to redis://broker:6379/0
  • EMAIL_URL, defaults to consolemail://
  • PUBLIC_URL, defaults to http://localhost:5000
  • DASHBOARD_URL, defaults to http://localhost:5001
  • DEFAULT_CHANNEL_SLUG, defaults to default-channel
  • DJANGO_SUPERUSER_EMAIL, pulled from your own environment
  • DJANGO_SUPERUSER_PASSWORD, pulled from your own environment
  • API_URL, defaults to http://localhost:5000/graphql/
  • POSTGRES_USER, defaults to saleor
  • POSTGRES_PASSWORD, defaults to saleor-local-only
  • POSTGRES_DB, defaults to saleor

Restart policy

The restart policy here is unless-stopped, so Docker restarts Saleor after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like api) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Saleor up. Add the template list to Portainer once, then deploying Saleor is a click rather than a wall of config.