diff --git a/readme.md b/readme.md index 595e94f..ea4f7be 100644 --- a/readme.md +++ b/readme.md @@ -2,7 +2,8 @@ A docker compose project to setup an OSM PostGIS database with automatic updates from OSM periodically. -The only file you need is a PBF file and run the docker compose project. +The only files you need is a PBF file, geojson (if you intent to restrict data download to +a smaller extent than the one specified by the PBF) and run the docker compose project. ## General architecture @@ -88,9 +89,9 @@ you to define a smaller area that you can work with. This is always desirable to limit the features being imported into the database rather than clipping them. -**NB:** Ensure you add a geojson covering the area you intent to clip into the clip folder. +**NB:** Ensure you add a geojson covering the area you intent to clip into the settings folder. The geojson can be the same extent of the administrative area of your country or it can be a -smaller extent +smaller extent. The CRS of the geojson should always be EPSG:4326. **NB:** It is encouraged to simplify the geometry for the `clip.geojson` as @@ -244,16 +245,24 @@ With -e, you can add some settings to PostGIS: ```bash - ALLOW_IP_RANGE= 0.0.0.0/0 ``` +More environment variables for Kartoza/postgis image can be found from https://github.com/kartoza/docker-postgis#environment-variables -# QGIS Server +# QGIS Server and Martin Vector tiles -You can run a QGIS Server front end to the OSM mirroir by using the provided +You can run a QGIS Server front end or martin vector tiles to the OSM mirror by using the provided docker-compose-web.yml file. For example: ```bash -docker-compose -f docker-compose.yml -f docker-compose-web.yml qgisserver up +docker-compose -f docker-compose.yml -f docker-compose-web.yml qgisserver up ``` +or +```bash +docker-compose -f docker-compose.yml -f docker-compose-web.yml martin up +``` +For more information about martin configuration and usage can be found from https://github.com/urbica/martin + + # Credits This application was designed and implemented by: