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

Update readme

Browse Source
This commit is contained in:
Thomas Nordquist 2017-07-19 14:09:19 +02:00
parent 84edf6f76e
commit b0e785b0a0
1 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -1,8 +1,12 @@
Docker: [![](https://images.microbadger.com/badges/image/thomasnordquist/photon-geocoder.svg)](https://microbadger.com/images/thomasnordquist/photon-geocoder "Get your own image badge on microbadger.com") [![Docker Pulls](https://img.shields.io/docker/pulls/thomasnordquist/photon-geocoder.svg)](https://hub.docker.com/r/thomasnordquist/photon-geocoder/) [![](https://images.microbadger.com/badges/version/thomasnordquist/photon-geocoder.svg)](https://microbadger.com/images/thomasnordquist/photon-geocoder "Get your own version badge on microbadger.com")
Github:
[![GitHub issues](https://img.shields.io/github/issues/thomasnordquist/photon-docker.svg)](https://github.com/thomasnordquist/photon-docker/issues) [![GitHub stars](https://img.shields.io/github/stars/thomasnordquist/photon-docker.svg)](https://github.com/thomasnordquist/photon-docker/stargazers) [![GitHub forks](https://img.shields.io/github/forks/thomasnordquist/photon-docker.svg)](https://github.com/thomasnordquist/photon-docker/network)
Have your own geocoder up and running within the hour, you will require about 60GB of disk space.
Have your own geocoder up and running within the hour, you will require about 60GB of disk space and has no further dependencies.
Feel free to fork and improve.
Feel free to fork and improve
# Run
@ -11,26 +15,33 @@ The data volume is exposed as `/photon/photon_data` and can be mounted, this way
## With `docker run`
```
```bash
docker run -p 2322:2322 -it thomasnordquist/photon-geocoder:latest
```
## Build and run from git
## Search
```
http://localhost:2322/api?q=berlin
```
*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
### With docker-compose
```
docker-compose build
```bash
docker-compose build #optional
docker-compose up
```
*Note: if you abort the download, you have to remove the volume `photon_data` before restarting the container*
### Without docker-compose
```
docker build --tag thomasnordquist/photon-geocoder:latest .
docker run -p 2322:2322 -it thomasnordquist/photon-geocoder:latest
### With `docker build`
```bash
docker build --tag thomasnordquist/photon-geocoder .
```
@ -45,4 +56,4 @@ docker run -p 2322:2322 -it thomasnordquist/photon-geocoder:latest
- 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)*