mirror of
https://framagit.org/les/gancio.git
synced 2025-01-31 16:42:22 +01:00
Merge branch 'docs/nominatim' into 'master'
Docs/nominatim See merge request les/gancio!22
This commit is contained in:
les
commit
d36c4dc9fb
3 changed files with 165 additions and 0 deletions
7
docs/docker/nominatim/.env.example
Normal file
7
docs/docker/nominatim/.env.example
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
|
||||
NOMINATIM_PASSWORD=CeMA4M1kiDo0k
|
||||
|
||||
# Choose PBF_PATH to import a local file
|
||||
PBF_PATH=/nominatim/data/default.osm.pbf
|
||||
# PBF_URL= https://download.geofabrik.de/europe/italy/nord-est-latest.osm.pbf
|
||||
# REPLICATION_URL= https://download.geofabrik.de/europe/italy/nord-est-updates/
|
||||
19
docs/docker/nominatim/docker-compose.yml
Normal file
19
docs/docker/nominatim/docker-compose.yml
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
version: '3'
|
||||
|
||||
services:
|
||||
nominatim:
|
||||
container_name: nominatim
|
||||
image: mediagis/nominatim:4.2
|
||||
restart: always
|
||||
ports:
|
||||
- "8080:8080"
|
||||
environment:
|
||||
# see https://github.com/mediagis/nominatim-docker/tree/master/4.2#configuration for more options
|
||||
PBF_PATH: "${PBF_PATH}"
|
||||
PBF_URL: "${PBF_URL}"
|
||||
REPLICATION_URL: "${REPLICATION_URL}"
|
||||
NOMINATIM_PASSWORD: ${NOMINATIM_PASSWORD}
|
||||
volumes:
|
||||
- ./nominatim-data:/var/lib/postgresql/14/main
|
||||
- ./nominatim/data/"${PBF_PATH}":/nominatim/data/"${PBF_PATH}"
|
||||
shm_size: 1gb
|
||||
139
docs/install/nominatim.md
Normal file
139
docs/install/nominatim.md
Normal file
|
|
@ -0,0 +1,139 @@
|
|||
---
|
||||
layout: default
|
||||
title: Nominatim
|
||||
permalink: /install/nominatim
|
||||
parent: Install
|
||||
nav_order: 7
|
||||
---
|
||||
|
||||
## Nominatim installation
|
||||
{: .no_toc }
|
||||
|
||||
1. TOC
|
||||
{:toc}
|
||||
|
||||
---
|
||||
|
||||
## Testing
|
||||
For testing purposes you could skip the nominatim installation and use one of this geocoding providers that run a server for free:
|
||||
|
||||
- [https://photon.komoot.io/](https://photon.komoot.io/) [Terms of service](https://photon.komoot.io/)
|
||||
- [https://nominatim.openstreetmap.org/](https://nominatim.openstreetmap.org/) [Terms of service](https://operations.osmfoundation.org/policies/nominatim/)
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
From [https://nominatim.org/release-docs/latest/admin/Installation/](https://nominatim.org/release-docs/latest/admin/Installation/)
|
||||
|
||||
"A minimum of 2GB of RAM is required or installation will fail. For a full planet import 128GB of RAM or more are strongly recommended. Do not report out of memory problems if you have less than 64GB RAM."
|
||||
|
||||
### Planet mirrors
|
||||
There is a list of planet mirror at [https://wiki.openstreetmap.org/wiki/Planet.osm#Planet.osm_mirrors](https://wiki.openstreetmap.org/wiki/Planet.osm#Planet.osm_mirrors)
|
||||
There you can also find `Country and area extracts`, divided by `Worldwide extract sources` and `Regional extract sources`
|
||||
|
||||
### Download an extract
|
||||
For Nominatim to work, you will needs to import files in [PBF Format](https://wiki.openstreetmap.org/wiki/PBF_Format) in the PostGis database. Those files have extension `*.osm.pbf`.
|
||||
|
||||
Some of these mirrors provide also incremental updates via [OsmChange](https://wiki.openstreetmap.org/wiki/OsmChange), for example:
|
||||
- Provides updates but with a lower detail
|
||||
[https://download.geofabrik.de/europe/italy/nord-ovest-updates/nord-ovest-latest.osm.pbf](http://download.geofabrik.de/europe/italy/nord-ovest-latest.osm.pbf)
|
||||
[https://download.geofabrik.de/europe/italy/nord-ovest-updates/](https://download.geofabrik.de/europe/italy/nord-ovest-updates/)
|
||||
- Does not provide updates but as higher level of detail
|
||||
[https://osmit-estratti-test.wmcloud.org/dati/poly/province/pbf/015_Milano_poly.osm.pbf](https://osmit-estratti-test.wmcloud.org/dati/poly/province/pbf/015_Milano_poly.osm.pbf)
|
||||
|
||||
Needs to host multiple areas? Checkout [Osmium](https://osmcode.org/osmium-tool/manual.html), to merge multiple PBF files into one.
|
||||
|
||||
---
|
||||
|
||||
## Install on Debian
|
||||
There is a [detailed documentaion](https://nominatim.org/release-docs/latest/appendix/Install-on-Ubuntu-22/) for installing nominatim on `Ubuntu 22` that should be valid also to install on `Debian`.
|
||||
|
||||
### Setup
|
||||
[https://nominatim.org/release-docs/latest/appendix/Install-on-Ubuntu-22/#installing-the-required-software](https://nominatim.org/release-docs/latest/appendix/Install-on-Ubuntu-22/#installing-the-required-software)
|
||||
|
||||
### Building and Configuration
|
||||
|
||||
Get the source code from Github and change into the source directory
|
||||
```
|
||||
cd $USERHOME
|
||||
wget https://nominatim.org/release/Nominatim-4.2.0.tar.bz2
|
||||
tar xf Nominatim-4.2.0.tar.bz2
|
||||
```
|
||||
|
||||
The code must be built in a separate directory. Create this directory, then configure and build Nominatim in there:
|
||||
```
|
||||
mkdir $USERHOME/build
|
||||
cd $USERHOME/build
|
||||
cmake $USERHOME/Nominatim-4.2.0
|
||||
make
|
||||
```
|
||||
|
||||
### Setting up the webserver
|
||||
[https://nominatim.org/release-docs/latest/appendix/Install-on-Ubuntu-22/#setting-up-a-webserver](https://nominatim.org/release-docs/latest/appendix/Install-on-Ubuntu-22/#setting-up-a-webserver)
|
||||
|
||||
### Import the database
|
||||
[https://nominatim.org/release-docs/latest/admin/Import/](https://nominatim.org/release-docs/latest/admin/Import/)
|
||||
|
||||
---
|
||||
|
||||
## Install using docker
|
||||
|
||||
### Setup
|
||||
Make sure to have [Docker Engine](https://docs.docker.com/engine/install/),
|
||||
[Docker Compose](https://docs.docker.com/compose/install/) and [git](https://git-scm.com/downloads) installed:
|
||||
```bash
|
||||
sudo apt install docker docker-compose git
|
||||
```
|
||||
|
||||
### Clone the project
|
||||
From [https://github.com/mediagis/nominatim-docker](https://github.com/mediagis/nominatim-docker)
|
||||
|
||||
- Clone the project from sources
|
||||
```bash
|
||||
git clone git@github.com:mediagis/nominatim-docker.git
|
||||
# cd nominatim-docker/<version>
|
||||
cd nominatim-docker/4.2/contrib # released Nov 29, 2022
|
||||
docker-compose pull
|
||||
```
|
||||
|
||||
- Or, use the template at `docs/docker/nominatim`
|
||||
```
|
||||
cd /opt/gancio/docs/docker/nominatim
|
||||
docker-compose pull
|
||||
```
|
||||
|
||||
### Import the database
|
||||
See [Requirements](#requirements) about downloading the `.osm.pbf` files
|
||||
```bash
|
||||
cd docs/docker/nominatim/
|
||||
wget https://download.geofabrik.de/europe/italy/nord-ovest-updates/nord-ovest-latest.osm.pbf \
|
||||
./nominatim/data/default.osm.pbf
|
||||
```
|
||||
|
||||
### Configure the environment file
|
||||
```
|
||||
cd docs/docker/nominatim/
|
||||
cp .env.example .env
|
||||
```
|
||||
Create a random password for nominatim a add it to .env file
|
||||
```bash
|
||||
NOMINATIM_PASSWORD=random_password;
|
||||
NOMINATIM_PASSWORD=$(echo $NOMINATIM_PASSWORD | openssl passwd --stdin);
|
||||
echo $NOMINATIM_PASSWORD;
|
||||
sed -i -e 's/\(NOMINATIM_PASSWORD=\)\(.*\)/\1'$NOMINATIM_PASSWORD'/g' .env
|
||||
```
|
||||
|
||||
### Start nominatim-docker
|
||||
|
||||
Start your container:
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
Checkout the logs to see when data are imported to the database:
|
||||
```bash
|
||||
docker-compose logs -f
|
||||
```
|
||||
|
||||
Try out the search:
|
||||
|
||||
[http://0.0.0.0:8080/search?q=building](http://0.0.0.0:8080/search?q=building)
|
||||
Loading…
Reference in a new issue