mediagis/nominatim

Nominatim Docker 镜像文档

!https://img.shields.io/badge/Nominatim%20Version-5.1.0-blue?style=flat-square !https://img.shields.io/github/actions/workflow/status/mediagis/nominatim-docker/ci.yml?branch=master&style=flat-square !https://img.shields.io/github/all-contributors/mediagis/nominatim-docker?style=flat-square !https://img.shields.io/docker/pulls/mediagis/nominatim?style=flat-square !https://img.shields.io/docker/image-size/mediagis/nominatim?style=flat-square

镜像概述和主要用途

Nominatim Docker 镜像是一个 100% 可正常工作的容器化解决方案，用于部署 https://github.com/openstreetmap/Nominatim 地理编码服务。Nominatim 是 OpenStreetMap (OSM) 项目的开源地理编码工具，支持从地址文本查询地理位置（正向地理编码）和从坐标反查地址（反向地理编码）。本镜像将 Nominatim 及其依赖组件（如 PostgreSQL 数据库、Apache Web 服务器）打包为单容器，提供便捷的部署和使用体验。

核心功能和特性

• 单容器集成：整合所有服务组件（Nominatim 核心、PostgreSQL、Apache）于单个容器，简化部署流程。
• 数据导入支持：通过环境变量配置 OSM PBF 数据文件 URL，自动完成数据下载与导入。
• API 访问：内置 Apache 服务器，提供 HTTP API 接口，支持标准 Nominatim 查询操作。
• 版本化镜像：提供不同版本的 Nominatim 镜像标签，适配不同需求场景。
• 即开即用：无需手动配置数据库和 Web 服务，启动容器后自动完成初始化流程。

使用场景和适用范围

• 开发与测试：快速搭建本地地理编码服务，用于应用开发调试。
• 小型应用部署：适用于数据量较小（如城市级 OSM 数据）的自托管地理编码需求。
• 演示环境：展示地理编码功能的轻量级部署方案。
• 定制数据场景：支持导入自定义 OSM PBF 数据，满足特定区域的地理编码需求。

详细使用方法和配置说明

快速启动

通过以下命令可快速部署一个使用小型数据集（如摩纳哥）的 Nominatim 服务：

bash
docker run -it \
  -e PBF_URL=https://download.geofabrik.de/europe/monaco-latest.osm.pbf \
  -p 8080:8080 \
  --name nominatim \
  docker.xuanyuan.run/mediagis/nominatim:5.1

参数说明：

• -e PBF_URL: 指定 OSM PBF 数据文件的下载 URL（必填），用于初始化数据库。
• -p 8080:8080: 端口映射，将容器内 Apache 服务的 8080 端口映射到主机的 8080 端口。
• --name nominatim: 容器名称，便于后续管理。
• mediagis/nominatim:5.1: 镜像名称及标签（Nominatim 5.1 版本）。

数据导入完成后，可通过 http://localhost:8080/search.php?q=avenue%20pasteur 访问 Nominatim API 进行地址查询。

访问不同版本

可通过指定标签拉取特定版本的 Nominatim 镜像，例如：

bash
# 拉取 Nominatim 5.1 版本
docker pull docker.xuanyuan.run/mediagis/nominatim:5.1

所有可用标签参见 https://hub.docker.com/r/mediagis/nominatim/tags%E3%80%82

环境变量配置

Docker Compose 部署示例

创建 docker-compose.yml 文件，内容如下：

yaml
version: '3'

services:
  nominatim:
    image: docker.xuanyuan.run/mediagis/nominatim:5.1
    container_name: nominatim
    ports:
      - "8080:8080"
    environment:
      - PBF_URL=https://download.geofabrik.de/europe/monaco-latest.osm.pbf
    volumes:
      - nominatim_data:/var/lib/postgresql/14/main  # 持久化数据库数据（可选）
    restart: unless-stopped

volumes:
  nominatim_data:  # 定义数据卷，用于持久化数据库文件

通过以下命令启动服务：

bash
docker-compose up -d

安全信息

关于 Nominatim 的最新安全版本支持和安全策略，参见官方文档：https://github.com/osm-search/Nominatim/blob/master/SECURITY.md%E3%80%82

项目目标与替代方案

项目目标

本项目旨在提供一个易用的单容器镜像，将所有服务组件整合在一起，简化部署流程。缺点是 Dockerfile 相对复杂，定制化难度较高。

替代方案

若需将各组件拆分为独立容器（如数据库、Web 服务分离），可参考项目：https://github.com/smithmicro/n7m%E3%80%82

贡献者

感谢以下贡献者对本项目的支持（emoji 说明）：