Skip to content

Latest commit

 

History

History
82 lines (61 loc) · 3.83 KB

example.md

File metadata and controls

82 lines (61 loc) · 3.83 KB

Configuration Example

docker run -it \
  # Sets the flatnode file, which is to reduce the load on the database when you plan to use multiple countries together bigger than 6GB
  # and highly recommended if you want to import the World!
  -v nominatim-flatnode:/nominatim/flatnode \

  # PostgreSQL Tuning, without the need to edit the .conf after the setup (Nominatim default recommended values)
  -e POSTGRES_SHARED_BUFFERS=2GB \
  -e POSTGRES_MAINTENANCE_WORK_MEM=10GB \
  -e POSTGRES_AUTOVACUUM_WORK_MEM=2GB \
  -e POSTGRES_WORK_MEM=50MB \
  -e POSTGRES_EFFECTIVE_CACHE_SIZE=24GB \
  -e POSTGRES_SYNCHRONOUS_COMMIT=off \
  -e POSTGRES_MAX_WAL_SIZE=1GB \
  -e POSTGRES_CHECKPOINT_TIMEOUT=10min \
  -e POSTGRES_CHECKPOINT_COMPLETION_TARGET=0.9 \

  # Sets the target for the initial file for the import. If the file is already on the local system, you use:
  # -e PBF_PATH=/path/to/your/planet-latest.osm.pbf   PBF_URL cannot be used together with PBF_PATH!
  -e PBF_URL=https://ftp5.gwdg.de/pub/misc/openstreetmap/planet.openstreetmap.org/pbf/planet-latest.osm.pbf \

  # Sets the Path, where Nominatim gets the map updates - the REPLICATION_URL is never a file.
  -e REPLICATION_URL=https://ftp5.gwdg.de/pub/misc/openstreetmap/planet.openstreetmap.org/replication/day/ \

  # How often upstream publishes diffs (in seconds, default: 86400). Requires REPLICATION_URL to be set.
  -e REPLICATION_UPDATE_INTERVAL=43200 \

  # How long to sleep if no update found yet (in seconds, default: 900). Requires REPLICATION_URL to be set.
  -e REPLICATION_RECHECK_INTERVAL=450 \

  # Configures the way the map files will be updated (default: none)
  -e UPDATE_MODE=continuous/once/catch-up/none \

  # Disables the updates to save space for example (default: false)
  -e FREEZE=true/false \

  #If you only want to use the Nominatim database for reverse lookups. (default: false)
  -e REVERSE_ONLY=true/false \

  # Whether to download and import Wikipedia primary importance data (true) or path to importance dump in the container. (default: false)
  -e IMPORT_WIKIPEDIA=true/false/path \

  # Whether to download and import Wikipedia data for secondary importance (true) or path to secondary importance dump in the container. (default: false)
  -e IMPORT_SECONDARY_WIKIPEDIA=true/false/path \

  #Whether to download and import the US postcode dump (true) or path to US postcode dump in the container. (default: false)
  -e IMPORT_US_POSTCODES=true/false/path \

  # Whether to download and import the GB postcode dump (true) or path to GB postcode dump in the container. (default: false)
  -e IMPORT_GB_POSTCODES=true/false/path \

  # Sets either an importfilter for a reduced data import or the full set and the full set with additional data (default: full):
  #   admin: Only import administrative boundaries and places.
  #   street: Like the admin style but also adds streets.
  #   address: Import all data necessary to compute addresses down to house number level.
  #   full: Default style that also includes points of interest.
  #   extratags: Like the full style but also adds most of the OSM tags into the extratags column.
  -e IMPORT_STYLE=admin/street/address/full/extratags \

  # Whether to download and import the Tiger address data (true) or path to a preprocessed Tiger address set in the container. (default: false)
  -e IMPORT_TIGER_ADDRESSES=true/false/path \

  # Sets the used threads at the import (default 16)
  -e THREADS=10 \

  # Sets the Docker tmpfs. Highly recommended for bigger imports like Europe. At least 1GB - ideally half of the available RAM.
  --shm-size=60g \

  # The password to connect to the database with (default: qaIACxO6wMR3)
  -e NOMINATIM_PASSWORD=supersafepassword \

  # Sets the ports of the container guest:host
  -p 8080:8080 \

  # Sets the name of the container
  --name nominatim \

  # Here you choose the Docker image and version
  mediagis/nominatim:5.2