Skip to content

bitExpert/ddev-gally

Repository files navigation

add-on registry tests last commit release Mastodon Follow

DDEV Gally

Overview

Gally is a next generation Searchandising Engine designed to easily create an API-first E-Commerce Search Engine that can still be customized to fit your needs.

This add-on integrates Gally into your DDEV project.

Installation

ddev add-on get bitExpert/ddev-gally
ddev restart

After installation, make sure to commit the .ddev directory to version control.

Gally Premium Installation

To install Gally Premium, set the GALLY_PREMIUM_NAME and GALLY_PREMIUM_TOKEN environment variables in .ddev/.env.gally before running ddev restart.

If you want to use the AI features of Gally, you need to enable AI support for Opensearch by adding the following lines to the environment section in the file .ddev/docker-compose.opensearch.yaml:

- plugins.ml_commons.only_run_on_ml_node=false
- plugins.ml_commons.allow_registering_model_via_url=true
- plugins.ml_commons.native_memory_threshold=100
- plugins.ml_commons.jvm_heap_memory_threshold=100

Post-Installation steps

To initialize the Gally database, run ddev gally-cli doctrine:migrations:migrate.

To create a Gally user account, run ddev gally-cli gally:user:create.

The Gally instance can be accessed at https://${DDEV_SITENAME}-gally.ddev.site or via the hostname configured in .ddev/.env.gally.

Advanced Customization

Make sure to commit the .ddev/.env.gally file to version control.

All customization options (use with caution):

Variable Default
GALLY_VERSION 2.2.0
GALLY_PREMIUM_NAME
GALLY_PREMIUM_TOKEN
GALLY_HOSTNAME ${DDEV_SITENAME}-gally.ddev.site
GALLY_CATALOG_MEDIA_URL https://${DDEV_SITENAME}.ddev.site/media/catalog/product/
GALLY_API_ROUTE_PREFIX api
GALLY_APP_ENV prod
GALLY_APP_DEBUG 0
GALLY_APP_SECRET Bh9Phhoceiyasa7iebf22hah6OdfN8oh
GALLY_DB_HOST gally-db
GALLY_DB_PORT 5432
GALLY_DB_NAME gally
GALLY_DB_USER gally
GALLY_DB_PASSWORD gally
POSTGRES_VERSION 16
VARNISH_VERSION 8.0
REDIS_HOST redis
REDIS_DB 0
OPENSEARCH_HOST opensearch
OPENSEARCH_PORT 9200

License

The DDEV Gally Addon is released under the Apache-2.0 license.