|
2 | 2 | [](https://github.com/bitExpert/ddev-gally/actions/workflows/tests.yml?query=branch%3Amain) |
3 | 3 | [](https://github.com/bitExpert/ddev-gally/commits) |
4 | 4 | [](https://github.com/bitExpert/ddev-gally/releases/latest) |
| 5 | +[](https://rheinneckar.social/@bitexpert) |
5 | 6 |
|
6 | 7 | # DDEV Gally |
7 | 8 |
|
8 | 9 | ## Overview |
9 | 10 |
|
| 11 | +[Gally](https://github.com/Elastic-Suite/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. |
| 12 | + |
10 | 13 | This add-on integrates Gally into your [DDEV](https://ddev.com/) project. |
11 | 14 |
|
12 | 15 | ## Installation |
13 | 16 |
|
14 | 17 | ```bash |
15 | | -ddev add-on get bitExpert/ddev-gally |
| 18 | +ddev add-on get https://github.com/bitExpert/ddev-gally |
16 | 19 | ddev restart |
17 | 20 | ``` |
18 | 21 |
|
19 | 22 | After installation, make sure to commit the `.ddev` directory to version control. |
20 | 23 |
|
21 | | -## Usage |
| 24 | +## Post-Installation steps |
22 | 25 |
|
23 | | -| Command | Description | |
24 | | -| ------- | ----------- | |
25 | | -| `ddev describe` | View service status and used ports for Gally | |
26 | | -| `ddev logs -s gally` | Check Gally logs | |
| 26 | +To initialize the Gally database, run `ddev gally-cli doctrine:migrations:migrate`. |
27 | 27 |
|
28 | | -## Advanced Customization |
| 28 | +To create a Gally user account, run `ddev gally-cli gally:user:create`. |
29 | 29 |
|
30 | | -To change the Docker image: |
| 30 | +The Gally instance can be accessed at `https://${DDEV_SITENAME}-gally.ddev.site` or via the hostname configured in `.ddev/.env.gally`. |
31 | 31 |
|
32 | | -```bash |
33 | | -ddev dotenv set .ddev/.env.gally --gally-docker-image="ddev/ddev-utilities:latest" |
34 | | -ddev add-on get bitExpert/ddev-gally |
35 | | -ddev restart |
36 | | -``` |
| 32 | +## Advanced Customization |
37 | 33 |
|
38 | 34 | Make sure to commit the `.ddev/.env.gally` file to version control. |
39 | 35 |
|
40 | 36 | All customization options (use with caution): |
41 | 37 |
|
42 | | -| Variable | Flag | Default | |
43 | | -| -------- | ---- | ------- | |
44 | | -| `GALLY_DOCKER_IMAGE` | `--gally-docker-image` | `ddev/ddev-utilities:latest` | |
45 | | - |
46 | | -## Credits |
| 38 | +| Variable | Default | |
| 39 | +|--------------------------|-----------------------------------------------------------| |
| 40 | +| GALLY_VERSION | 2.2.0 | |
| 41 | +| GALLY_HOSTNAME | ${DDEV_SITENAME}-gally.ddev.site | |
| 42 | +| GALLY_CATALOG_MEDIA_URL | https://${DDEV_SITENAME}.ddev.site/media/catalog/product/ | |
| 43 | +| GALLY_API_ROUTE_PREFIX | api | |
| 44 | +| GALLY_APP_ENV | prod | |
| 45 | +| GALLY_APP_DEBUG | 0 | |
| 46 | +| GALLY_APP_SECRET | Bh9Phhoceiyasa7iebf22hah6OdfN8oh | |
| 47 | +| GALLY_DB_HOST | gally-db | |
| 48 | +| GALLY_DB_PORT | 5432 | |
| 49 | +| GALLY_DB_NAME | gally | |
| 50 | +| GALLY_DB_USER | gally | |
| 51 | +| GALLY_DB_PASSWORD | gally | |
| 52 | +| POSTGRES_VERSION | 16 | |
| 53 | +| VARNISH_VERSION | 8.0 | |
| 54 | +| REDIS_HOST | redis | |
| 55 | +| REDIS_DB | 0 | |
| 56 | +| OPENSEARCH_HOST | opensearch | |
| 57 | +| OPENSEARCH_PORT | 9200 | |
| 58 | + |
| 59 | +## License |
| 60 | + |
| 61 | +The DDEV Gally Addon is released under the Apache-2.0 license. |
47 | 62 |
|
48 | | -**Contributed and maintained by [@bitExpert](https://github.com/bitExpert)** |
|
0 commit comments