{"id":20329331,"url":"https://github.com/ddev/ddev-elasticsearch","last_synced_at":"2025-04-11T20:41:31.754Z","repository":{"id":37789685,"uuid":"470760591","full_name":"ddev/ddev-elasticsearch","owner":"ddev","description":"Elasticsearch add-on for DDEV","archived":false,"fork":false,"pushed_at":"2025-04-11T10:18:45.000Z","size":129,"stargazers_count":10,"open_issues_count":4,"forks_count":13,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-11T11:24:05.213Z","etag":null,"topics":["ddev-get"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ddev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["ddev"],"custom":["https://www.paypal.com/donate/?hosted_button_id=MCNCSZHC7LHSQ","https://ddev.com/support-ddev/"]}},"created_at":"2022-03-16T21:44:04.000Z","updated_at":"2025-04-11T10:13:40.000Z","dependencies_parsed_at":"2024-02-16T03:22:44.184Z","dependency_job_id":"c9db67fe-9d84-44fd-9fc1-9d35fdf12fcf","html_url":"https://github.com/ddev/ddev-elasticsearch","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":"ddev/ddev-addon-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddev%2Fddev-elasticsearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddev%2Fddev-elasticsearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddev%2Fddev-elasticsearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddev%2Fddev-elasticsearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ddev","download_url":"https://codeload.github.com/ddev/ddev-elasticsearch/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248478737,"owners_count":21110753,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ddev-get"],"created_at":"2024-11-14T20:10:12.411Z","updated_at":"2025-04-11T20:41:31.745Z","avatar_url":"https://github.com/ddev.png","language":"Shell","funding_links":["https://github.com/sponsors/ddev","https://www.paypal.com/donate/?hosted_button_id=MCNCSZHC7LHSQ","https://ddev.com/support-ddev/"],"categories":[],"sub_categories":[],"readme":"[![tests](https://github.com/ddev/ddev-elasticsearch/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/ddev/ddev-elasticsearch/actions/workflows/tests.yml?query=branch%3Amain)\n[![last commit](https://img.shields.io/github/last-commit/ddev/ddev-elasticsearch)](https://github.com/ddev/ddev-elasticsearch/commits)\n[![release](https://img.shields.io/github/v/release/ddev/ddev-elasticsearch)](https://github.com/ddev/ddev-elasticsearch/releases/latest)\n\n# DDEV Elasticsearch\n\n## Overview\n\n[Elasticsearch](https://www.elastic.co/elasticsearch) is an open source distributed, RESTful search and analytics engine, scalable data store, and vector database capable of addressing a growing number of use cases.\n\nThis add-on integrates Elasticsearch into your [DDEV](https://ddev.com/) project.\n\n## Installation\n\n```bash\nddev add-on get ddev/ddev-elasticsearch\nddev restart\n```\n\nAfter installation, make sure to commit the `.ddev` directory to version control.\n\n### Using Elasticsearch 8\n\n```bash\nddev add-on get ddev/ddev-elasticsearch\ncp .ddev/elasticsearch/docker-compose.elasticsearch8.yaml .ddev/\nddev restart\n```\n\n### Switching between Elasticsearch 7 and 8\n\nAll Elasticsearch data is stored in a Docker volume, so if you're switching versions or setups, you may want to start fresh by removing the volume:\n\n```bash\n# remove old elasticsearch volume (if this is downgrade)\nddev stop\ndocker volume rm ddev-$(ddev status -j | docker run -i --rm ddev/ddev-utilities jq -r '.raw.name')_elasticsearch\n```\n\n## Usage\n\nTo access the Elasticsearch container from within the web container, use the hostname `elasticsearch` and port `9200`. For example, the server URL might be `http://elasticsearch:9200`. Alternatively, you can use the `ddev.site` URLs to access it via HTTP or HTTPS: `http://\u003cprojectname\u003e.ddev.site:9200` and `https://\u003cprojectname\u003e.ddev.site:9201`. These URLs are also available from the host.\n\n\u003e [!TIP]\n\u003e What about Kibana support? Use this [add-on](https://github.com/JanoPL/ddev-kibana).\n\n### Advanced Customization\n\nAvoid modifying the provided `docker-compose.elasticsearch.yaml` file. Instead, create a `docker-compose.elasticsearch_extras.yaml` file for any customizations. For more information on defining additional services with Docker Compose, please refer to the [official DDEV documentation](https://ddev.readthedocs.io/en/stable/users/extend/custom-compose-files/).\n\n### Minor Version Bump\n\nTo change the minor version of Elasticsearch:\n\n```bash\nddev dotenv set .ddev/.env.elasticsearch --elasticsearch-docker-image=elasticsearch:7.17.14\nddev restart\n```\n\nMake sure to commit the `.ddev/.env.elasticsearch` file to version control.\n\n### Memory Limit\n\nBy default, this configuration limits the memory usage of the `elasticsearch` service to 512MB. This should be sufficient for most projects. However, if the service stops unexpectedly, you may need to increase the maximum memory allocation for Docker and/or the `elasticsearch` service. To do so, modify the `ES_JAVA_OPTS` environment variable in the `docker-compose.elasticsearch_extras.yaml` file.\n\nExample for 2GB:\n\n```yaml\nservices:\n  elasticsearch:\n    environment:\n      - \"ES_JAVA_OPTS=-Xms2g -Xmx2g\"\n```\n\nYou can use `ddev logs -s elasticsearch` to investigate the Elasticsearch daemon's activity or to troubleshoot RAM-related crashes.\n\n## Additional Resources\n\n* There are two related answers to the [Stack Overflow question](https://stackoverflow.com/questions/54575785/how-can-i-use-an-elasticsearch-add-on-container-service-with-ddev) on ddev and Elasticsearch.\n* @juampynr's Lullabot [article on Drupal 8 and Elasticsearch](https://www.lullabot.com/articles/indexing-content-from-drupal-8-to-elasticsearch) is helpful for Drupal users.\n\n## Credits\n\n**Originally Contributed by [dacostafilipe](https://github.com/dacostafilipe) with contributions by [@Morgy93](https://github.com/Morgy93), [@amitaibu](https://github.com/amitaibu), [@aronnovak](https://github.com/aronnovak) and others**\n\n**Maintained by [@aronnovak](https://github.com/aronnovak)**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fddev%2Fddev-elasticsearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fddev%2Fddev-elasticsearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fddev%2Fddev-elasticsearch/lists"}