Photon

Overview

Photon is an open-source geocoding solution built for OpenStreetMap (OSM) data, providing features such as search-as-you-type and reverse geocoding. This CA uses rtuszik's unofficial Docker image (see Project) for running Photon locally, enhancing data privacy and integration capabilities with services like Dawarich⁠.

Runtime arguments

Web UI: http://[IP]:[PORT:2322]/
Network: bridge
Shell: sh
Privileged: false
Extra Params: --restart=unless-stopped

Template configuration

App DataPathrw

Target: /photon/data
Default: /mnt/user/appdata/photon
Value: /mnt/user/appdata/photon

WebUI PortPorttcp

Target: 2322
Default: 2322
Value: 2322

Update StrategyVariable

Controls how index updates are handled. PARALLEL downloads the new index in the background then swaps with minimal downtime (requires 2x space). SEQUENTIAL stops Photon, deletes the existing index, downloads the new one, then restarts. DISABLED prevents automatic updates.

Target: UPDATE_STRATEGY
Default: DISABLED
Value: DISABLED

Update IntervalVariable

How often to check for updates. To reduce server load, it is recommended to set this to a long interval (e.g., 720h for 30 days) or disable updates altogether if you do not need the latest data.

Target: UPDATE_INTERVAL
Default: 30d
Value: 30d

RegionVariable

LARGE FILE SIZES! This might take up to 200GB depending on the selected region! Optional region for a specific dataset. Can be a continent (europe, asia), individual country/region (germany, usa, japan), country code (de, us, jp), or planet for worldwide data. See: https://github.com/rtuszik/photon-docker#available-regions

Target: REGION
Default: planet
Value: planet

Log LevelVariable

Controls logging verbosity. (DEBUG, INFO, ERROR)

Target: LOG_LEVEL
Default: INFO
Value: INFO

Force UpdateVariable

Forces an index update on container startup, regardless of UPDATE_STRATEGY. (TRUE, FALSE)

Target: FORCE_UPDATE
Default: FALSE
Value: FALSE

BASE_URLVariable

Custom base URL for index data downloads. Should point to the parent directory of index files. The default has been changed to a community mirror to reduce load on the GraphHopper servers.

Default: https://download1.graphhopper.com/public/
Value: https://download1.graphhopper.com/public/

Skip MD5 CheckVariable

Optionally skip MD5 verification of downloaded index files. (TRUE, FALSE)

Target: SKIP_MD5_CHECK
Default: FALSE
Value: FALSE

File UrlVariable

Photon executable parameters. See https://github.com/komoot/photon#running-photon.

Target: FILE_URL

Photon ParamsVariable

Optional notification URLs for Apprise to send status updates (e.g., download completion, errors). Supports multiple services like Pushover, Slack, email, etc. Example: pover://user@token,mailto://user:pass@gmail.com See: https://github.com/caronc/apprise

Target: PHOTON_PARAMS

Apprise UrlsVariable

The User ID for the photon process. Set this to your host user's ID (id -u) to prevent permission errors when using bind mounts.

Target: APPRISE_URLS

PUIDVariable

The Group ID for the photon process. Set this to your host group's ID (id -g) to prevent permission errors when using bind mounts.

Default: 99
Value: 99

PGIDVariable

Default: 100
Value: 100

Links

Template Support Docker Hub Project

Details

Repository

rtuszik/photon-docker

Registry

https://hub.docker.com/r/rtuszik/photon-docker

Last Updated2026-04-27

First Seen2025-10-06

Run Photon on Unraid.

Photon is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.

Explore Unraid OS