Ces images permettent de simplifier grandement la mise en place d'une instance addok avec les données de références diffusées par la Base Adresse Nationale.
Les images Docker sont disponibles pour linux/amd64
et linux/arm64
. Elles sont donc parfaitement utilisables sur Apple Silicon ou Raspberry Pi sans couche d’émulation.
Nom du composant | Version |
---|---|
redis |
7.x |
python |
3.10.x |
addok |
1.1.2 |
addok-fr |
1.0.1 |
addok-france |
1.1.3 |
addok-csv |
1.1.0 |
addok-sqlite-store |
1.0.1 |
gunicorn |
21.0.1 |
Les guides suivants ont été rédigés pour un environnement Linux ou Mac. Ils peuvent être adaptés pour Windows.
- Au moins 6 Go de RAM disponible (à froid)
- 8 Go d'espace disque disponible (hors logs)
- Docker CE 1.10+
- Docker Compose 1.10+
unzip
ou équivalentwget
ou équivalent
Tout d'abord placez vous dans un dossier de travail, appelez-le par exemple ban
.
wget https://adresse.data.gouv.fr/data/ban/adresses/latest/addok/addok-france-bundle.zip
mkdir addok-data
unzip -d addok-data addok-france-bundle.zip
wget https://raw.githubusercontent.com/BaseAdresseNationale/addok-docker/master/docker-compose.yml
Suivant votre environnement, sudo
peut être nécessaire pour les commandes suivantes.
# Attachée au terminal
docker-compose up
# ou en arrière-plan
docker-compose up -d
Suivant les performances de votre machine, l'instance mettra entre 30 secondes et 2 minutes à démarrer effectivement, le temps de charger les données dans la mémoire vive.
- 90 secondes sur une VPS-SSD-3 OVH (2 vCPU, 8 Go)
- 50 secondes sur une VM EG-15 OVH (4 vCPU, 15 Go)
Par défaut l'instance écoute sur le port 7878
.
curl "http://localhost:7878/search?q=1+rue+de+la+paix+paris"
Nom du paramètre | Description |
---|---|
WORKERS |
Nombre de workers addok à lancer. Valeur par défaut : 1 . |
WORKER_TIMEOUT |
Durée maximale allouée à un worker pour effectuer une opération de géocodage. Valeur par défaut : 30 . |