Photon

Photon is an open-source geocoder for OpenStreetMap (OSM) data that provides search-as-you-type and reverse geocoding, deployed here as an unofficial Docker…

  • Development
  • Network Services
  • Other
  • Productivity
  • Tools & Utilities
  • Web & Publishing
Photon is an open-source geocoder for OpenStreetMap (OSM) data that provides search-as-you-type and reverse geocoding, deployed here as an unofficial Docker image for self-hosted address lookup, mapping, and integrations such as Dawarich.

Platform availability

Available on 1 of 10 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

70/100 Good

Maintained
100last commit 27 days ago
Popular
50321 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
602 GB minimum RAM, runs on ARM
Security check
76no serious findings, 4 minor, CI, tests

Availability: platform listings confirmed today, links checked 51 days ago

GitHub stars
321
Open issues
18
Last commit
2026-10-25
Latest release
2.5.0
License
Apache-2.0
Activity
rising

Checked 20 days ago - source: GitHub (rtuszik/photon-docker)

Resources & Compatibility

Minimum requirements: 2 GB RAM, 512 MB disk. ARM (e.g. Raspberry Pi) is supported.

Checked 54 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Pick your regions and languages first Set REGION and LANGUAGES in your config to the places and name languages you want, for example REGION=germany,austria and LANGUAGES=en,de. This tells Photon which data to download and index, so you avoid pulling the wrong or huge data set. source
  • Leave plenty of free disk space Photon’s first run may download a large data file before creating a smaller usable index. If the drive or Docker volume is too full, setup can fail and the container may not start. source
  • Start it and search on port 2322 Start it with docker compose up -d, which runs Photon as a background service, then test searches at http://localhost:2322/api?q=Harare. Use port 2322 for external computers; if it is blocked or unforwarded, searches from other devices fail with connection errors. source
  • Disk space Reserve at least 60 GB for the compressed planet index in db mode or 26 GB for the planet JSONL dump; indexes grow over time. source
  • Planet index size The planet index can be very large, around 60GB compressed in db mode or around 26GB in jsonl mode, so allocate sufficient disk space before starting. source

Fetched 17 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

How much disk space should I leave free before running Photon?

The planet index can be very large: about 60GB compressed in db mode and about 26GB as a planet JSONL dump in jsonl mode. Make sure the Docker volume has enough free space because the first run downloads a large file before creating the usable index.

How can I reduce downtime when Photon updates its index?

Set UPDATE_STRATEGY=PARALLEL so the container downloads the new index in the background and swaps it with minimal downtime. You can also set UPDATE_INTERVAL, for example 720h to check for updates every 30 days.

Can I run Photon for a specific country instead of the whole planet?

Yes. Set REGION to the continent, country, or planet you want, and in JSONL mode set LANGUAGES to the name languages you need. For example, REGION=germany,austria and LANGUAGES=en,de avoids pulling a huge planet dataset.

Which port should I expose and how do I confirm Photon is working?

Expose port 2322 and test with a query such as /api?q=Harare on localhost. For searches from other devices to work, port 2322 must be reachable and not blocked or unforwarded.

Answers sourced from github.com, github.com, github.com

Community

Collected 48 days ago - public community threads