config-schema.json

{
    "$schema": "http://json-schema.org/draft-06/schema#",
    "$ref": "#/definitions/root",
    "definitions": {
        "root": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "parameters": {
                    "$ref": "#/definitions/parameters"
                },
                "shopware": {
                    "$ref": "#/definitions/shopware"
                },
                "storefront": {
                    "$ref": "#/definitions/storefront"
                },
                "elasticsearch": {
                    "$ref": "#/definitions/elasticsearch"
                }
            },
            "title": "Root"
        },
        "parameters": {
            "type": "object",
            "additionalProperties": true,
            "title": "Parameters"
        },
        "shopware": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "filesystem": {
                    "$ref": "#/definitions/filesystem"
                },
                "cdn": {
                    "$ref": "#/definitions/cdn"
                },
                "increment": {
                    "$ref": "#/definitions/increment"
                },
                "api": {
                    "$ref": "#/definitions/api"
                },
                "admin_worker": {
                    "$ref": "#/definitions/admin_worker"
                },
                "auto_update": {
                    "$ref": "#/definitions/auto_update"
                },
                "store": {
                    "$ref": "#/definitions/shopware_store"
                },
                "sitemap": {
                    "$ref": "#/definitions/sitemap"
                },
                "deployment": {
                    "$ref": "#/definitions/deployment"
                },
                "media": {
                    "$ref": "#/definitions/media"
                },
                "dal": {
                    "$ref": "#/definitions/dal"
                },
                "cart": {
                    "$ref": "#/definitions/cart"
                },
                "number_range": {
                    "$ref": "#/definitions/number_range"
                },
                "sales_channel_context": {
                    "$ref": "#/definitions/sales_channel_context"
                },
                "html_sanitizer": {
                    "$ref": "#/definitions/html_sanitizer"
                },
                "logger": {
                    "$ref": "#/definitions/logger"
                },
                "cache": {
                    "$ref": "#/definitions/cache"
                },
                "mail": {
                    "$ref": "#/definitions/mail"
                },
                "profiler": {
                  "$ref": "#/definitions/profiler"
                }
            },
            "title": "Shopware"
        },
        "profiler": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "integrations": {
                    "type": "array",
                    "uniqueItems": true,
                    "items": {
                        "anyOf": [
                            {
                                "type": "string",
                                "enum": ["Symfony", "Datadog", "Tideways"]
                            },
                            {
                                "type": "string"
                            }
                        ]
                    }
                }
            },
            "title": "Enabled profiler, available since 6.4.11.0"
        },
        "mail": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "update_mail_variables_on_send": {
                    "type": "boolean",
                    "title": "Configure mail template variable update on each mail sending. This setting should be disabled on productive installations. "
                }
            },
            "title": "Mail Template configuration, Available since 6.4.11.0"
        },
        "admin_worker": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "enable_admin_worker": {
                    "type": "boolean"
                },
                "poll_interval": {
                    "type": "integer"
                },
                "transports": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            },
            "title": "Admin worker"
        },
        "api": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "max_limit": {
                    "type": "integer"
                },
                "api_browser": {
                    "$ref": "#/definitions/api_browser"
                },
                "store": {
                    "$ref": "#/definitions/api_store"
                },
                "rate_limiter": {
                    "$ref": "#/definitions/rate_limiter"
                }
            },
            "title": "API"
        },
        "api_browser": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "auth_required": {
                    "type": "boolean"
                }
            },
            "title": "API browser"
        },
        "rate_limiter": {
            "type": "object",
            "additionalProperties": true,
            "properties": {
                "login": {
                    "$ref": "#/definitions/rate_limiter_config"
                },
                "guest_login": {
                    "$ref": "#/definitions/rate_limiter_config"
                },
                "oauth": {
                    "$ref": "#/definitions/rate_limiter_config"
                },
                "reset_password": {
                    "$ref": "#/definitions/rate_limiter_config"
                },
                "user_recovery": {
                    "$ref": "#/definitions/rate_limiter_config"
                },
                "contact_form": {
                    "$ref": "#/definitions/rate_limiter_config"
                },
                "notification": {
                    "$ref": "#/definitions/rate_limiter_config"
                },
                "newsletter_form": {
                    "$ref": "#/definitions/rate_limiter_config"
                }
            },
            "title": "RateLimiter"
        },
        "rate_limiter_config": {
            "type": "object",
            "additionalProperties": true,
            "properties": {
                "enabled": {
                    "type": "boolean"
                },
                "policy": {
                    "type": "string"
                },
                "reset": {
                    "type": "string"
                },
                "limits": {
                    "type": [
                        "object",
                        "array"
                    ]
                }
            },
            "title": "Rate limiter config"
        },
        "api_store": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "context_lifetime": {
                    "type": "string"
                }
            },
            "title": "API store"
        },
        "auto_update": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "enabled": {
                    "type": "boolean"
                }
            },
            "title": "Auto update"
        },
        "cache": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "redis_prefix": {
                    "type": "string"
                },
                "invalidation": {
                    "$ref": "#/definitions/cache_invalidation"
                }
            },
            "title": "Cache"
        },
        "cache_invalidation": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "delay": {
                    "type": "integer"
                },
                "count": {
                    "type": "integer"
                },
                "http_cache": {
                    "$ref": "#/definitions/cache_invalidation_states"
                },
                "product_listing_route": {
                    "$ref": "#/definitions/cache_invalidation_states"
                },
                "product_detail_route": {
                    "$ref": "#/definitions/cache_invalidation_states"
                },
                "product_review_route": {
                    "$ref": "#/definitions/cache_invalidation_states"
                },
                "product_search_route": {
                    "$ref": "#/definitions/cache_invalidation_states"
                },
                "product_suggest_route": {
                    "$ref": "#/definitions/cache_invalidation_states"
                },
                "product_cross_selling_route": {
                    "$ref": "#/definitions/cache_invalidation_states"
                },
                "payment_method_route": {
                    "$ref": "#/definitions/cache_invalidation_states"
                },
                "shipping_method_route": {
                    "$ref": "#/definitions/cache_invalidation_states"
                },
                "navigation_route": {
                    "$ref": "#/definitions/cache_invalidation_states"
                },
                "category_route": {
                    "$ref": "#/definitions/cache_invalidation_states"
                },
                "landing_page_route": {
                    "$ref": "#/definitions/cache_invalidation_states"
                },
                "language_route": {
                    "$ref": "#/definitions/cache_invalidation_states"
                },
                "currency_route": {
                    "$ref": "#/definitions/cache_invalidation_states"
                },
                "country_route": {
                    "$ref": "#/definitions/cache_invalidation_states"
                },
                "country_state_route": {
                    "$ref": "#/definitions/cache_invalidation_states"
                },
                "salutation_route": {
                    "$ref": "#/definitions/cache_invalidation_states"
                },
                "sitemap_route": {
                    "$ref": "#/definitions/cache_invalidation_states"
                }
            },
            "title": "Cache invalidation"
        },
        "cache_invalidation_states": {
            "type": "array",
            "title": "Cache invalidation states",
            "items": {
                "type": "string",
                "enum": [
                    "logged-in",
                    "cart-filled"
                ]
            }
        },
        "cart": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "expire_days": {
                    "type": "integer"
                },
                "compress": {
                    "type": "boolean",
                    "description": "All carts, which stored in redis, are compressed via gzcompress. This option is only available if redis is used."
                },
                "redis_url": {
                    "type": "string",
                    "description": "The redis url to connect to. All carts will be saved in Redis instead of mysql"
                }
            },
            "title": "Cart"
        },
        "number_range": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "increment_storage": {
                    "description": "The storage engine used for the increments. Note that you need to configure a `redis_url` if you want to use the `Redis` storage.",
                    "anyOf": [
                        {
                            "type": "string",
                            "enum": ["SQL", "Redis"]
                        },
                        {
                            "type": "string"
                        }
                    ],
                    "default": "SQL"
                },
                "redis_url": {
                    "type": "string",
                    "description": "The redis url to connect to. All number range states will be saved in Redis instead of sql"
                }
            },
            "title": "Number Range"
        },
        "cdn": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "url": {
                    "type": "string"
                },
                "strategy": {
                    "type": "string"
                }
            },
            "title": "CDN"
        },
        "dal": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "batch_size": {
                    "type": "integer"
                },
                "max_rule_prices": {
                    "type": "integer"
                },
                "versioning": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "expire_days": {
                            "type": "integer"
                        }
                    }
                }
            },
            "title": "DAL"
        },
        "deployment": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "blue_green": {
                    "type": "string"
                }
            },
            "title": "Deployment"
        },
        "filesystem": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "private": {
                    "$ref": "#/definitions/file_system_type"
                },
                "public": {
                    "$ref": "#/definitions/file_system_type"
                },
                "temp": {
                    "$ref": "#/definitions/file_system_type"
                },
                "theme": {
                    "$ref": "#/definitions/file_system_type"
                },
                "asset": {
                    "$ref": "#/definitions/file_system_type"
                },
                "sitemap": {
                    "$ref": "#/definitions/file_system_type"
                },
                "allowed_extensions": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            },
            "title": "Filesystem"
        },
        "file_system_type": {
            "type": [
                "object",
                "null"
            ],
            "additionalProperties": true
        },
        "html_sanitizer": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "cache_dir": {
                    "type": "string"
                },
                "cache_enabled": {
                    "type": "boolean"
                },
                "sets": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "properties": {
                            "name": {
                                "type": "string"
                            },
                            "tags": {
                                "type": "array",
                                "items": {
                                    "type": "string"
                                }
                            },
                            "attributes": {
                                "type": "array",
                                "items": {
                                    "type": "string"
                                }
                            },
                            "options": {
                                "type": "array",
                                "items": {
                                    "type": "object"
                                }
                            }
                        },
                        "title": "Set"
                    }
                },
                "fields": {
                    "type": "array",
                    "items": {
                        "type": "object",
                        "additionalProperties": false,
                        "properties": {
                            "name": {
                                "type": "string"
                            },
                            "sets": {
                                "type": "array",
                                "items": {
                                    "type": "string"
                                }
                            }
                        },
                        "title": "Field"
                    }
                }
            },
            "title": "HTMLSanitizer"
        },
        "increment": {
            "type": "object",
            "additionalProperties": true,
            "patternProperties": {
                "^.*$": {
                    "$ref": "#/definitions/increment_config"
                }
            },
            "required": [
                "message_queue",
                "user_activity"
            ],
            "title": "Increment pools"
        },
        "increment_config": {
            "type": "object",
            "additionalProperties": true,
            "properties": {
                "type": {
                    "enum": [
                        "mysql",
                        "redis",
                        "array"
                    ],
                    "type": "string"
                }
            },
            "required": [
                "type"
            ],
            "allOf": [
                {
                    "if": {
                        "properties": {
                            "type": {
                                "const": "redis"
                            }
                        }
                    },
                    "then": {
                        "properties": {
                            "config": {
                                "type": "object",
                                "additionalProperties": false,
                                "properties": {
                                    "url": {
                                        "type": "string"
                                    }
                                },
                                "required": [
                                    "url"
                                ]
                            }
                        },
                        "required": [
                            "config"
                        ]
                    }
                }
            ],
            "title": "Increment storage config"
        },
        "logger": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "file_rotation_count": {
                    "type": "integer"
                },
                "exclude_exception": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            },
            "title": "Logger"
        },
        "media": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "enable_url_upload_feature": {
                    "type": "boolean"
                },
                "enable_url_validation": {
                    "type": "boolean"
                }
            },
            "title": "Media"
        },
        "sitemap": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "batchsize": {
                    "type": "integer"
                },
                "custom_urls": {
                    "type": "null"
                },
                "excluded_urls": {
                    "type": "null"
                }
            },
            "title": "sitemap"
        },
        "shopware_store": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "frw": {
                    "type": "boolean"
                }
            },
            "title": "Shopware store"
        },
        "sales_channel_context": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "expire_days": {
                    "type": "integer"
                }
            },
            "title": "Sales channel context"
        },
        "storefront": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "csrf": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "enabled": {
                            "type": "boolean",
                            "default": true,
                            "title": "Toggles CSRF"
                        },
                        "mode": {
                            "type": "string",
                            "enum": [
                                "ajax",
                                "twig"
                            ],
                            "default": "twig",
                            "title": "CSRF implementation type"
                        }
                    },
                    "title": "CSRF configuration for the PHP storefront"
                },
                "reverse_proxy": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "enabled": {
                            "type": "boolean",
                            "default": false
                        },
                        "ban_method": {
                            "type": "string",
                            "default": "BAN",
                            "title": "HTTP method used to purge the cache at the remote server"
                        },
                        "ban_headers": {
                            "type": [
                                "object",
                                "null"
                            ],
                            "title": "The headers that should be send on a single purge"
                        },
                        "hosts": {
                            "type": "array",
                            "items": {
                                "type": "string"
                            },
                            "title": "List of reverse proxy servers"
                        },
                        "max_parallel_invalidations": {
                            "type": "integer",
                            "default": 2,
                            "title": "Max parallel requests to the external server"
                        },
                        "redis_url": {
                            "type": "string",
                            "title": "Redis URL"
                        },
                        "purge_all": {
                            "type": [
                                "object",
                                "null"
                            ],
                            "additionalProperties": false,
                            "properties": {
                                "ban_method": {
                                    "type": "string",
                                    "default": "BAN",
                                    "title": "HTTP method used to purge the cache at the remote server"
                                },
                                "ban_headers": {
                                    "type": [
                                        "object",
                                        "null"
                                    ],
                                    "title": "The headers that should be send on a single purge"
                                },
                                "urls": {
                                    "type": "array",
                                    "items": {
                                        "type": "string"
                                    }
                                }
                            }
                        },
                        "fastly": {
                            "type": "object",
                            "additionalProperties": false,
                            "properties": {
                                "enabled": {
                                    "type": "boolean",
                                    "default": false
                                },
                                "instance_tag": {
                                    "type": "string",
                                    "default": ""
                                },
                                "api_key": {
                                    "type": "string",
                                    "title": "Fastly API key"
                                },
                                "service_id": {
                                    "type": "string",
                                    "title": "Fastly service ID"
                                },
                                "soft_purge": {
                                    "type": "string",
                                    "enum": ["1", "0"],
                                    "default": "0"
                                }
                            }
                        }
                    },
                    "title": "Reverse proxy configuration"
                },
                "http_cache": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "ignored_url_parameters": {
                            "type": "array",
                            "items": {
                                "type": "string"
                            }
                        },
                        "stale_while_revalidate": {
                            "type": ["integer", "null"],
                            "default": null
                        },
                        "stale_if_error": {
                            "type": ["integer", "null"],
                            "default": null
                        }
                    },
                    "title": "Http cache configuration"
                },
                "theme": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "config_loader_id": {
                            "type": "string"
                        },
                        "theme_path_builder_id": {
                            "type": "string"
                        },
                        "available_theme_provider": {
                            "type": "string"
                        }
                    },
                    "title": "Theme loader configuration"
                }
            },
            "title": "Storefront bundle configuration"
        },
        "elasticsearch": {
            "title": "Elasticsearch",
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "enabled": {
                    "type": ["string", "boolean"],
                    "description": "Enable Elasticsearch Searching",
                    "default": false
                },
                "indexing_enabled": {
                    "type": ["string", "boolean"],
                    "description": "Enable Elasticsearch Indexing",
                    "default": false
                },
                "indexing_batch_size": {
                    "type": ["string", "integer"],
                    "description": "Elasticsearch Batch Size",
                    "default": 100
                },
                "hosts": {
                    "type": "string",
                    "description": "Elasticsearch Hosts",
                    "default": "localhost:9200"
                },
                "index_prefix": {
                    "type": "string",
                    "description": "Elasticsearch Index Prefix",
                    "default": "sw"
                },
                "throw_exception": {
                    "type": ["string", "boolean"],
                    "description": "Throw exception when Elasticsearch queries failing",
                    "default": false
                },
                "product": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "custom_fields_mapping": {
                            "type": ["object", "null"],
                            "title": "Custom Field Mapping of Product"
                        }
                    }
                },
                "ssl": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "verify_server_cert": {
                            "type": "boolean",
                            "default": true
                        },
                        "cert_path": {
                            "type": ["boolean", "string"],
                            "default": false
                        },
                        "cert_key_path": {
                            "type": ["boolean", "string"],
                            "default": false
                        }
                    }
                },
                "index_settings": {
                    "type": "object",
                    "additionalProperties": true,
                    "properties": {
                        "number_of_shards": {
                            "type": ["integer", "null"],
                            "default": 3
                        },
                        "number_of_replicas": {
                            "type": ["integer", "null"],
                            "default": 3
                        },
                        "mapping.total_fields.limit": {
                            "type": "integer",
                            "default": 50000
                        },
                        "mapping.nested_fields.limit": {
                            "type": "integer",
                            "default": 500
                        },
                        "mapping.nested_objects.limit": {
                            "type": "integer",
                            "default": 1000000
                        }
                    }
                },
                "analysis": {
                    "type": "object",
                    "title": "Analysis Config"
                },
                "dynamic_templates": {
                    "type": "array",
                    "title": "Dynamic Templates Config"
                }
            }
        }
    }
}