{"id":13557379,"url":"https://github.com/Qwant/docker_mimir","last_synced_at":"2025-04-03T11:31:54.179Z","repository":{"id":52703896,"uuid":"136336372","full_name":"Qwant/docker_mimir","owner":"Qwant","description":"Docker Compose configuration for Qwant Maps geocoder, based on Mimirsbrunn (https://github.com/CanalTP/mimirsbrunn)","archived":true,"fork":false,"pushed_at":"2021-10-21T12:10:45.000Z","size":114,"stargazers_count":8,"open_issues_count":5,"forks_count":8,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-11-04T07:35:59.516Z","etag":null,"topics":["addresses","docker-compose","geocoding","mimir","points-of-interest","qwant-maps","search","search-engine","streets"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Qwant.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-06T13:57:06.000Z","updated_at":"2024-05-26T01:27:25.000Z","dependencies_parsed_at":"2022-08-22T10:21:25.555Z","dependency_job_id":null,"html_url":"https://github.com/Qwant/docker_mimir","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Qwant%2Fdocker_mimir","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Qwant%2Fdocker_mimir/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Qwant%2Fdocker_mimir/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Qwant%2Fdocker_mimir/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Qwant","download_url":"https://codeload.github.com/Qwant/docker_mimir/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246993110,"owners_count":20865938,"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":["addresses","docker-compose","geocoding","mimir","points-of-interest","qwant-maps","search","search-engine","streets"],"created_at":"2024-08-01T12:04:18.823Z","updated_at":"2025-04-03T11:31:49.161Z","avatar_url":"https://github.com/Qwant.png","language":"Python","funding_links":[],"categories":["Python","others"],"sub_categories":[],"readme":"[![Python 3.5](https://img.shields.io/badge/python-3.5-blue.svg)](https://www.python.org/downloads/release/python-350/)\n![pipenv](https://img.shields.io/badge/pipenv-\u003e%3D%209.0.1-brightgreen.svg)\n\n⚠ This repository is no longer maintained\n===\n\nThis repository was previously maintained together with a mirror containing our\ndeployment workflows. Keeping this repository independent from our\nconfigurations turned out to be a lot of efforts for only few benefits.\n\n# docker_mimir: Default [Mimir](https://github.com/CanalTP/mimirsbrunn) Import Tool\n\n- This tool is the easiest way to import data for the [Mimir](https://github.com/CanalTP/mimirsbrunn) geocoding system.\n- Basically `docker_mimir` is an import pipeline based on [invoke](https://github.com/pyinvoke/invoke). The easiest way to configure `invoke` is to create a custom configuration file. All possible variables are commented in the default configuration file: `invoke.yaml`.\n- Running `docker_mimir` requires [pipenv](https://github.com/pypa/pipenv).\n\n## How to use it\n\nTo configure the required data directories, some environment variable can be set (in cli or in a `.env` file in the directory). The env variables that can be set as follows:\n\n```env\nOSM_DIR=\u003cpath to osm data dir\u003e\nADDR_DIR=\u003cpath to addresses data dir\u003e\nCOSMOGONY_DIR=\u003cpath to cosmogony data dir\u003e\n```\n\n- Note that you don't need to set the variable that are not used in the configuration file.\n- Once the variables are set, to run mimir you need to do:\n\n```shell\npipenv run inv -f docker_settings.yaml load-in-docker-and-test\n```\n\n- The file `docker_settings.yaml` contains an example configuration to download and import data about Luxembourg.\n- This will:\n  * run a `docker-compose up`.\n  * import some data in [Mimir](https://github.com/CanalTP/mimirsbrunn).\n  * run [geocoder-tester](https://github.com/QwantResearch/geocoder-tester) and write results in a local directory.\n\n#### About Tests\n\n- If you don't want to run the tests you can also use `invoke` chaining calls:\n\n```\npipenv run inv -f docker_settings.yaml compose-up load-all compose-down\n```\n\n- Some other `docker-compose` files can also be given (this will use [the docker compose override mechanism](https://docs.docker.com/compose/extends/#different-environments)). It will for example make it possible to use customly build image to run tests on a given Mimir (or [Fafnir](https://github.com/QwantResearch/fafnir), [Cosmogony](https://github.com/osm-without-borders/cosmogony), ...) branch.\n\n- The file paths are given with the `--files` arguments, as follows:\n\n```\npipenv run inv -f docker_settings.yaml load-in-docker-and-test --files my-docker-compose.yml --files my-other-compose.yml\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FQwant%2Fdocker_mimir","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FQwant%2Fdocker_mimir","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FQwant%2Fdocker_mimir/lists"}