Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Qwant/docker_mimir
Docker Compose configuration for Qwant Maps geocoder, based on Mimirsbrunn (https://github.com/CanalTP/mimirsbrunn)
https://github.com/Qwant/docker_mimir
addresses docker-compose geocoding mimir points-of-interest qwant-maps search search-engine streets
Last synced: about 1 month ago
JSON representation
Docker Compose configuration for Qwant Maps geocoder, based on Mimirsbrunn (https://github.com/CanalTP/mimirsbrunn)
- Host: GitHub
- URL: https://github.com/Qwant/docker_mimir
- Owner: Qwant
- Archived: true
- Created: 2018-06-06T13:57:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-10-21T12:10:45.000Z (almost 3 years ago)
- Last Synced: 2024-07-14T17:44:14.231Z (about 2 months ago)
- Topics: addresses, docker-compose, geocoding, mimir, points-of-interest, qwant-maps, search, search-engine, streets
- Language: Python
- Homepage:
- Size: 111 KB
- Stars: 8
- Watchers: 7
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred - Qwant/docker_mimir - Docker Compose configuration for Qwant Maps geocoder, based on Mimirsbrunn (https://github.com/CanalTP/mimirsbrunn) (others)
README
[](https://www.python.org/downloads/release/python-350/)
⚠ This repository is no longer maintained
===
This repository was previously maintained together with a mirror containing our
deployment workflows. Keeping this repository independent from our
configurations turned out to be a lot of efforts for only few benefits.
# docker_mimir: Default [Mimir](https://github.com/CanalTP/mimirsbrunn) Import Tool
- This tool is the easiest way to import data for the [Mimir](https://github.com/CanalTP/mimirsbrunn) geocoding system.
- 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`.
- Running `docker_mimir` requires [pipenv](https://github.com/pypa/pipenv).
## How to use it
To 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:
```env
OSM_DIR=
ADDR_DIR=
COSMOGONY_DIR=
```
- Note that you don't need to set the variable that are not used in the configuration file.
- Once the variables are set, to run mimir you need to do:
```shell
pipenv run inv -f docker_settings.yaml load-in-docker-and-test
```
- The file `docker_settings.yaml` contains an example configuration to download and import data about Luxembourg.
- This will:
* run a `docker-compose up`.
* import some data in [Mimir](https://github.com/CanalTP/mimirsbrunn).
* run [geocoder-tester](https://github.com/QwantResearch/geocoder-tester) and write results in a local directory.
#### About Tests
- If you don't want to run the tests you can also use `invoke` chaining calls:
```
pipenv run inv -f docker_settings.yaml compose-up load-all compose-down
```
- 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.
- The file paths are given with the `--files` arguments, as follows:
```
pipenv run inv -f docker_settings.yaml load-in-docker-and-test --files my-docker-compose.yml --files my-other-compose.yml
```