Skip to content

Options

kellerkinder-service edited this page Feb 7, 2024 · 11 revisions

kellerkinder.phpVersion

Allows to define the used PHP Version. For supported versions, see Different PHP versions

Example

kellerkinder.phpVersion = "php80";

kellerkinder.systemConfig

Define shopware system config values.

Example

kellerkinder.systemConfig = {
    "foo.bar.testString" = "false";
};

kellerkinder.additionalPhpConfig

Define additional php.ini settings, which are used for php-fpm and php-cli.

Example

kellerkinder.additionalPhpConfig = ''
    memory_limit = 200M
'';

kellerkinder.additionalPhpExtensions

Define additional PHP extensions that are included in php-fpm and php-cli.

Example

kellerkinder.additionalPhpExtensions = [
   "mailparse"
];

kellerkinder.additionalServerAlias

Define additional server aliases that are added to caddy.

Example

kellerkinder.additionalServerAlias = [
   "example.com"
];

kellerkinder.additionalVhostConfig

Define additional vhost configurations that are appended to the general vhost configuration.

Example

kellerkinder.additionalVhostConfig = ''
  tls internal
'';

kellerkinder.enableRabbitMq

Enables the RabbitMQ message broker and amqp PHP extension. Can be used for the Symfony message queue.

Example

kellerkinder.enableRabbitMq = true;

kellerkinder.enableElasticsearch

Enables the Elasticsearch service and configures Shopware to use Elasticsearch in addition to the default MySQL search. Only one of kellerkinder.enableElasticsearch or kellerkinder.enableOpenSearch should be enabled.

Example

kellerkinder.enableElasticsearch = true;

kellerkinder.enableOpenSearch

Enables the OpenSearch service and configures Shopware to use OpenSearch in addition to the default MySQL search. Only one of kellerkinder.enableElasticsearch or kellerkinder.enableOpenSearch should be enabled.

Example

kellerkinder.enableOpenSearch = true;

kellerkinder.importDatabaseDumps

You can import a list of links of database dumps by using the command importdb. Define a list of links like in the example below.

Supported files:

  • *.sql
  • *.gz
  • *.zip

Example

kellerkinder.importDatabaseDumps = [
    "http://localhost/dump.sql.gz"
    "http://localhost/admin_logins.sql"
];

kellerkinder.documentRoot

Changes the default document root (public) of caddy to the specified value

Example for the current folder

kellerkinder.documentRoot = ".";

kellerkinder.projectRoot

Changes the default root of the project to the specified value (no / as pre- or suffix required)

Example for a project folder inside the current folder

kellerkinder.projectRoot = "project";

kellerkinder.indexFile

Sets the caddy index file for the document root

Example

kellerkinder.indexFile = "shopware.php";

kellerkinder.staticFilePaths

Adjusts the defined matcher paths for caddy. You might want to adjust those to access/handle *.php files.

NOTE: The path can not be empty!

Example

kellerkinder.staticFilePaths = "myCustomFolder/*";

kellerkinder.fallbackMediaUrl

Fallback redirect URL for media not found on local storage. Best for CDN purposes without downloading them.

Example

kellerkinder.fallbackMediaUrl = "https://my-cool-cdn-in-public-staging.example-cdn.com";

kellerkinder.fallbackMediaPaths

Sets the paths to be redirected to the fallbackMediaUrl.

Example

kellerkinder.fallbackMediaPaths = "/media/* /thumbnail/*";

kellerkinder.additionalPackages

Define packages that should be installed additionally.

Example

kellerkinder.additionalPackages = [ pkgs.jpegoptim pkgs.optipng pkgs.gifsicle ];

kellerkinder.enableMysqlBinLog

Enables the MySQL Binary Log and adds configuration for it.

Example

kellerkinder.enableMysqlBinLog = false;

Ports

The configurable ports can be found here