# 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 image for self-hosted address lookup, mapping, and. It is open source and self-hosted, installable on Unraid and Docker Hub.

Canonical page: https://ourlocalhost.com/app/960/photon

## Description

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.

## Health score

70/100 (Good), based on 5 of 5 factors.
- Maintained: 100 (last commit 27 days ago)
- Popular: 50 (321 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)
- Light to run: 60 (2 GB minimum RAM, runs on ARM)
- Security check: 76 (no serious findings, 4 minor, CI, tests)

## Links

- Unraid: https://ca.unraid.net/apps/photon-0uhc5oy1q2avp2?q=Photon
- Docker Hub: https://hub.docker.com/r/rtuszik/photon-docker

## 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.

---
Source: Our Local Host (https://ourlocalhost.com/app/960/photon), the self-hosted and open-source app directory.
