Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BaseAdresseNationale/addok-docker
Conteneurs Addok pour Docker
https://github.com/BaseAdresseNationale/addok-docker
Last synced: about 1 month ago
JSON representation
Conteneurs Addok pour Docker
- Host: GitHub
- URL: https://github.com/BaseAdresseNationale/addok-docker
- Owner: BaseAdresseNationale
- Created: 2017-11-02T15:21:46.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-10-31T13:32:20.000Z (about 2 years ago)
- Last Synced: 2024-07-29T13:34:47.350Z (6 months ago)
- Language: Shell
- Size: 82 KB
- Stars: 145
- Watchers: 15
- Forks: 24
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Conteneurs Addok pour Docker
Ces images permettent de simplifier grandement la mise en place d'une instance [addok](https://github.com/addok/addok) avec les données de références diffusées par la [Base Adresse Nationale](https://adresse.data.gouv.fr).
## Plateformes
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.
## Composants installés
| Nom du composant | Version |
| --- | --- |
| `redis` | `7.x` |
| `python` | `3.10.x` |
| `addok` | `1.0.3` |
| `addok-fr` | `1.0.1` |
| `addok-france` | `1.1.3` |
| `addok-csv` | `1.0.1` |
| `addok-sqlite-store` | `1.0.1` |
| `gunicorn` | `20.1.0` |
## Guides d'installation
Les guides suivants ont été rédigés pour un environnement Linux ou Mac. Ils peuvent être adaptés pour Windows.
### Pré-requis
* Au moins 6 Go de RAM disponible (à froid)
* 8 Go d'espace disque disponible (hors logs)
* [Docker CE 1.10+](https://docs.docker.com/engine/installation/)
* [Docker Compose 1.10+](https://docs.docker.com/compose/install/)
* `unzip` ou équivalent
* `wget` ou équivalent
### Installer une instance avec les données de la Base Adresse Nationale
Tout d'abord placez vous dans un dossier de travail, appelez-le par exemple `ban`.
#### Télécharger les données pré-indexées
```bash
wget https://adresse.data.gouv.fr/data/ban/adresses/latest/addok/addok-france-bundle.zip
```
#### Décompresser l'archive
```bash
mkdir addok-data
unzip -d addok-data addok-france-bundle.zip
```
#### Télécharger le fichier Compose
```bash
wget https://raw.githubusercontent.com/BaseAdresseNationale/addok-docker/master/docker-compose.yml
```
#### Démarrer l'instance
Suivant votre environnement, `sudo` peut être nécessaire pour les commandes suivantes.
```bash
# 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`.
#### Tester l'instance
```bash
curl "http://localhost:7878/search?q=1+rue+de+la+paix+paris"
```
### Paramètres avancés
| 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](http://docs.gunicorn.org/en/0.17.2/configure.html#timeout) pour effectuer une opération de géocodage. Valeur par défaut : `30`. |