jansenj/photon-docker
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improved readme

Browse Source
This commit is contained in:
Ton Snoei 2023-03-20 22:32:55 +01:00
parent 52cdaee41b
commit 64ce31e55f
2 changed files with 10 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,13 +1,13 @@
Have your own geocoder up and running within the hour, you will require about 60GB of disk space and has no further dependencies.
Have your own geocoder up and running within the hour, you will require about 60GB of disk space and has no further dependencies. If you select a specific country, you can reduce the necessary disk space.
Feel free to fork and improve.
See this [blog post]() for mor info
See this [blog post](https://tonsnoei.nl/en/post/2023/03/20/set-up-your-own-geocoder-api/) for mor info
# Run
The image itself is pretty small, the first time the container is executed, a 60GB searchindex will be downloaded. The [blog post]() explains how to use only a specific country or region.
The image itself is pretty small, the first time the container is executed, a 60GB searchindex will be downloaded. The [blog post](https://tonsnoei.nl/en/post/2023/03/20/set-up-your-own-geocoder-api/) explains how to use only a specific country or region.
The data volume is exposed as `/photon/photon_data` and can be mounted, this way you'll only have to download the data once.
@ -22,12 +22,12 @@ docker run -p 2322:2322 -it tonsnoei/photon-geocoder:latest
```
http://localhost:2322/api?q=amsterdam
```
*For more details on the API check the photon [github repository](https://github.com/komoot/photon).*
*For more details on the API check the Photon [github repository](https://github.com/komoot/photon).*
## Build from git
https://github.com/thomasnordquist/photon-docker
https://github.com/tonsnoei/photon-docker
### With docker-compose
```bash
@ -37,12 +37,6 @@ docker-compose up
*Note: if you abort the download, you have to remove the volume `photon_data` before restarting the container*
### With `docker build`
```bash
docker build --tag thomasnordquist/photon-geocoder .
```
## FAQ
- How do I pass arguments to the `photon.jar` ?
@ -52,6 +46,6 @@ docker build --tag thomasnordquist/photon-geocoder .
*The container downloads the latest prebuilt search index, there is no immediate need to have nominatim installed.*
- What is photon ?
- What is Photon ?
*photon is a geocoder, check out [their website](https://photon.komoot.de/) and their [github repository](https://github.com/komoot/photon)*
*Photon is a geocoder, check out [their website](https://photon.komoot.de/) and their [github repository](https://github.com/komoot/photon)*

4
entrypoint.sh
View File

@ -9,8 +9,8 @@ if [ ! -d "/photon/photon_data/elasticsearch" ]; then
USER_AGENT="docker: thomasnordquist/photon-geocoder"
# If you want to install a specific region only, enable the line below and disable the current 'wget' row.
# Take a look at http://download1.graphhopper.com/public/extracts/by-country-code for your country
wget --user-agent="$USER_AGENT" -O - http://download1.graphhopper.com/public/extracts/by-country-code/nl/photon-db-nl-latest.tar.bz2 | bzip2 -cd | tar x
# wget --user-agent="$USER_AGENT" -O - http://download1.graphhopper.com/public/photon-db-latest.tar.bz2 | bzip2 -cd | tar x
# wget --user-agent="$USER_AGENT" -O - http://download1.graphhopper.com/public/extracts/by-country-code/nl/photon-db-nl-latest.tar.bz2 | bzip2 -cd | tar x
wget --user-agent="$USER_AGENT" -O - http://download1.graphhopper.com/public/photon-db-latest.tar.bz2 | bzip2 -cd | tar x
fi
# Start photon if elastic index exists