{"id":21001564,"url":"https://github.com/divio/aldryn-elasticsearch","last_synced_at":"2026-04-22T12:35:08.361Z","repository":{"id":38452893,"uuid":"72629672","full_name":"divio/aldryn-elasticsearch","owner":"divio","description":null,"archived":false,"fork":false,"pushed_at":"2022-06-03T13:16:14.000Z","size":11,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-01-20T09:46:46.223Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/divio.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-02T10:36:27.000Z","updated_at":"2022-06-03T13:16:18.000Z","dependencies_parsed_at":"2022-08-19T04:40:32.945Z","dependency_job_id":null,"html_url":"https://github.com/divio/aldryn-elasticsearch","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/divio%2Faldryn-elasticsearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/divio%2Faldryn-elasticsearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/divio%2Faldryn-elasticsearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/divio%2Faldryn-elasticsearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/divio","download_url":"https://codeload.github.com/divio/aldryn-elasticsearch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243419040,"owners_count":20287802,"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":[],"created_at":"2024-11-19T08:15:45.142Z","updated_at":"2025-12-28T12:26:10.229Z","avatar_url":"https://github.com/divio.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"**Deprecated**\n\nThis project is no longer supported.\n\nDivio will undertake no further development or maintenance of this project. If you are interested in continuing to \ndevelop it, use the fork functionality from GitHub. We are not able to transfer ownership of the repository to another \nparty.\n\n====================\nAldryn Elasticsearch\n====================\n\nSmall addon which helps configure the Elastic Search connection\nusing environment variables. Meant to be used as an Aldryn Addon together with aldryn-django.\n\nInstallation\n============\n\n**Aldryn Platform Users** ask support to provision ElasticSeearch for you.\n\nContributing\n============\n\nThis is a an open-source project. We'll be delighted to receive your\nfeedback in the form of issues and pull requests. Before submitting your\npull request, please review our `contribution guidelines\n\u003chttp://docs.django-cms.org/en/latest/contributing/index.html\u003e`_.\n\nWe're grateful to all contributors who have helped create and maintain this package.\nContributors are listed at the `contributors \u003chttps://github.com/divio/aldryn-elasticsearch/graphs/contributors\u003e`_\nsection.\n\nLocal docker setup\n==================\n\nFor local development add a ElasticSearch service to ``docker-compose.yml``::\n\n    es:\n        image: elasticsearch:2.4\n\nand add a link to it from the web service::\n\n    web:\n        links:\n          - \"es:es\"\n\nThen add the environment variable to configure the connection (on the default\naldryn setup: add to ``.env-local``)::\n\n    DEFAULT_ELASTICSEARCH_URL=es+http://es:9200/local-*\n\n\nUsage\n=====\n\nTo get a connection to the default index simply run::\n\n    from aldryn_elasticsearch.connection import es_conn, es_index\n    es_conn.search(index=es_index)\n\n\nTo get a connection to a specific index run::\n\n    from aldryn_elasticsearch.connection import get_connection\n    es_conn, es_index = get_connection(suffix='my-index-name')\n    es_conn.search(index=es_index)\n\nIf you want to use a different host URL than the default\n(read from the environment ``DEFAULT_ELASTICSEARCH_URL``) you can pass that like this::\n\n    from aldryn_elasticsearch.connection import get_connection\n    es_conn, es_index = get_connection(\n        url='es+http://elasticsearch:9200/local-*',\n        suffix='my-index-name',\n    )\n    es_conn.search(index=es_index)\n\n\nOther Stuff\n===========\n\n``DEFAULT_ELASTICSEARCH_URL`` environment variable\n\nSet an environment variable::\n\n    DEFAULT_ELASTICSEARCH_URL=es+http://hostname:9200/my-index-name\n\nThere is also native support for AWS ElasticSearch style connections::\n\n    DEFAULT_ELASTICSEARCH_URL=es+https+aws://AWS_ACCESS_KEY:AWS_SECRET_KEY@cluster-name.us-east-1.amazonaws.com/my-index-name\n\nThere is also support to define the index name with a wildcard ``*`` that can\nbe used for setting up multiple indeces.\n\nDebugging\n=========\n\nSet the ``ALDRYN_ELASTICSEARCH_DEBUG`` environment variable to True to get detailed\nlogs from Elasticsearch.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdivio%2Faldryn-elasticsearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdivio%2Faldryn-elasticsearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdivio%2Faldryn-elasticsearch/lists"}