Operating system checks and QUICKSTART.md improvements

This commit is contained in:
ImreSamu 2016-11-30 03:34:19 +01:00
parent fb720bf943
commit 0d826d6cc4
2 changed files with 286 additions and 240 deletions

View File

@ -1,251 +1,288 @@
## Quickstart - for small extracts ## Quickstart - for small extracts
### Req: ### Req:
* linux x86_64 * CPU: AMD64 ( = Intel 64 bit)
* docker >=1.10 * The base docker debian images are x86_64 based, so the ARM,MIPS currently not supported!
* docker-compose >=1.7.1 * Operating system
* Linux is suggested
* The development and the testing platform is Linux.
* If you are using FreeBSD, Solaris, Windows, ...
* Please give a feedback, share your experience, write a tutorial
* bash
* git * git
* free disk space >= ~15Gb ( more is better! ) * make
* docker >=1.10
* https://www.docker.com/products/overview
* docker-compose >=1.7.1
* https://docs.docker.com/compose/install/
* disk space ( >= ~15Gb )
* for small extracts >= ~15Gb
* for big extracts ( continents, planet) > 20 ... 1000 Gb
* And depends on
* OpenStreetMap data size
* Zoom level
* memory ( >= 3Gb )
* for small extracts 3Gb-8Gb RAM
* for big extracts ( Europe, Planet) > 8-32 Gb
* internet connections
* for downloading docker images
* for downloading OpenStreetMap data from Geofabrik
Important: The ./quickstart.sh is for small extracts - not optimal for a Planet rendering !!
### First experiment - with albania ( small extracts! ) ### First experiment - with albania ( small extracts! )
```bash ```bash
git clone https://github.com/openmaptiles/openmaptiles.git git clone https://github.com/openmaptiles/openmaptiles.git
cd openmaptiles cd openmaptiles
./quickstart.sh ./quickstart.sh
``` ```
if you have problems check the ./quickstart.log! If you have problems with the quickstart
* check the ./quickstart.log!
* check again the system requirements
* check the current issues : https://github.com/openmaptiles/openmaptiles/issues
* create new issues:
* create a new gist https://gist.github.com/ from your ./quickstart.log
* double check: if this is not contain any sensitive informations about your system
* create a new issues: https://github.com/openmaptiles/openmaptiles/issues
* describe the problems
* add any important informations your environment
* and link your (quickstart.log) gist !
### Check other extracts ### Check other extracts
IF the previous step is working, IF the previous step is working,
THAN you can test other available quickstart extracts ( based on geofabrik extracts) ! THAN you can test other available quickstart extracts ( based on geofabrik extracts) !
* We are using https://github.com/julien-noblet/download-geofabrik tool * We are using https://github.com/julien-noblet/download-geofabrik tool
* The current extract list, and more informations -> `make list`
This is generating mbtiles for your area : [ MIN_ZOOM: "0" - MAX_ZOOM: "7" ] This is generating mbtiles for your area : [ MIN_ZOOM: "0" - MAX_ZOOM: "7" ]
```bash ```bash
./quickstart.sh africa ./quickstart.sh africa
./quickstart.sh alabama ./quickstart.sh alabama
./quickstart.sh alaska ./quickstart.sh alaska
./quickstart.sh albania ./quickstart.sh albania
./quickstart.sh alberta ./quickstart.sh alberta
./quickstart.sh alps ./quickstart.sh alps
./quickstart.sh alsace ./quickstart.sh alsace
./quickstart.sh andorra ./quickstart.sh andorra
./quickstart.sh antarctica ./quickstart.sh antarctica
./quickstart.sh aquitaine ./quickstart.sh aquitaine
./quickstart.sh argentina ./quickstart.sh argentina
./quickstart.sh arizona ./quickstart.sh arizona
./quickstart.sh arkansas ./quickstart.sh arkansas
./quickstart.sh asia ./quickstart.sh asia
./quickstart.sh australia ./quickstart.sh australia
./quickstart.sh austria ./quickstart.sh austria
./quickstart.sh auvergne ./quickstart.sh auvergne
./quickstart.sh azerbaijan ./quickstart.sh azerbaijan
./quickstart.sh azores ./quickstart.sh azores
./quickstart.sh bangladesh ./quickstart.sh bangladesh
./quickstart.sh bayern ./quickstart.sh bayern
./quickstart.sh belarus ./quickstart.sh belarus
./quickstart.sh belgium ./quickstart.sh belgium
./quickstart.sh belize ./quickstart.sh belize
./quickstart.sh berlin ./quickstart.sh berlin
./quickstart.sh bolivia ./quickstart.sh bolivia
./quickstart.sh botswana ./quickstart.sh botswana
./quickstart.sh bourgogne ./quickstart.sh bourgogne
./quickstart.sh brandenburg ./quickstart.sh brandenburg
./quickstart.sh brazil ./quickstart.sh brazil
./quickstart.sh bremen ./quickstart.sh bremen
./quickstart.sh bretagne ./quickstart.sh bretagne
./quickstart.sh buckinghamshire ./quickstart.sh buckinghamshire
./quickstart.sh bulgaria ./quickstart.sh bulgaria
./quickstart.sh california ./quickstart.sh california
./quickstart.sh cambridgeshire ./quickstart.sh cambridgeshire
./quickstart.sh cameroon ./quickstart.sh cameroon
./quickstart.sh canada ./quickstart.sh canada
./quickstart.sh centre ./quickstart.sh centre
./quickstart.sh cheshire ./quickstart.sh cheshire
./quickstart.sh chile ./quickstart.sh chile
./quickstart.sh china ./quickstart.sh china
./quickstart.sh colombia ./quickstart.sh colombia
./quickstart.sh colorado ./quickstart.sh colorado
./quickstart.sh connecticut ./quickstart.sh connecticut
./quickstart.sh cornwall ./quickstart.sh cornwall
./quickstart.sh corse ./quickstart.sh corse
./quickstart.sh croatia ./quickstart.sh croatia
./quickstart.sh cuba ./quickstart.sh cuba
./quickstart.sh cumbria ./quickstart.sh cumbria
./quickstart.sh cyprus ./quickstart.sh cyprus
./quickstart.sh dach ./quickstart.sh dach
./quickstart.sh delaware ./quickstart.sh delaware
./quickstart.sh denmark ./quickstart.sh denmark
./quickstart.sh derbyshire ./quickstart.sh derbyshire
./quickstart.sh devon ./quickstart.sh devon
./quickstart.sh dorset ./quickstart.sh dorset
./quickstart.sh ecuador ./quickstart.sh ecuador
./quickstart.sh egypt ./quickstart.sh egypt
./quickstart.sh england ./quickstart.sh england
./quickstart.sh essex ./quickstart.sh essex
./quickstart.sh estonia ./quickstart.sh estonia
./quickstart.sh ethiopia ./quickstart.sh ethiopia
./quickstart.sh europe ./quickstart.sh europe
./quickstart.sh fiji ./quickstart.sh fiji
./quickstart.sh finland ./quickstart.sh finland
./quickstart.sh florida ./quickstart.sh florida
./quickstart.sh france ./quickstart.sh france
./quickstart.sh germany ./quickstart.sh germany
./quickstart.sh gloucestershire ./quickstart.sh gloucestershire
./quickstart.sh greece ./quickstart.sh greece
./quickstart.sh greenland ./quickstart.sh greenland
./quickstart.sh guadeloupe ./quickstart.sh guadeloupe
./quickstart.sh guatemala ./quickstart.sh guatemala
./quickstart.sh guinea ./quickstart.sh guinea
./quickstart.sh guyane ./quickstart.sh guyane
./quickstart.sh hamburg ./quickstart.sh hamburg
./quickstart.sh hampshire ./quickstart.sh hampshire
./quickstart.sh hawaii ./quickstart.sh hawaii
./quickstart.sh herefordshire ./quickstart.sh herefordshire
./quickstart.sh hertfordshire ./quickstart.sh hertfordshire
./quickstart.sh hessen ./quickstart.sh hessen
./quickstart.sh hungary ./quickstart.sh hungary
./quickstart.sh iceland ./quickstart.sh iceland
./quickstart.sh idaho ./quickstart.sh idaho
./quickstart.sh illinois ./quickstart.sh illinois
./quickstart.sh india ./quickstart.sh india
./quickstart.sh indiana ./quickstart.sh indiana
./quickstart.sh indonesia ./quickstart.sh indonesia
./quickstart.sh iowa ./quickstart.sh iowa
./quickstart.sh irak ./quickstart.sh irak
./quickstart.sh iran ./quickstart.sh iran
./quickstart.sh italy ./quickstart.sh italy
./quickstart.sh japan ./quickstart.sh japan
./quickstart.sh jordan ./quickstart.sh jordan
./quickstart.sh kansas ./quickstart.sh kansas
./quickstart.sh kazakhstan ./quickstart.sh kazakhstan
./quickstart.sh kent ./quickstart.sh kent
./quickstart.sh kentucky ./quickstart.sh kentucky
./quickstart.sh kenya ./quickstart.sh kenya
./quickstart.sh kosovo ./quickstart.sh kosovo
./quickstart.sh kyrgyzstan ./quickstart.sh kyrgyzstan
./quickstart.sh lancashire ./quickstart.sh lancashire
./quickstart.sh latvia ./quickstart.sh latvia
./quickstart.sh lebanon ./quickstart.sh lebanon
./quickstart.sh leicestershire ./quickstart.sh leicestershire
./quickstart.sh lesotho ./quickstart.sh lesotho
./quickstart.sh liberia ./quickstart.sh liberia
./quickstart.sh libya ./quickstart.sh libya
./quickstart.sh liechtenstein ./quickstart.sh liechtenstein
./quickstart.sh limousin ./quickstart.sh limousin
./quickstart.sh lithuania ./quickstart.sh lithuania
./quickstart.sh lorraine ./quickstart.sh lorraine
./quickstart.sh louisiana ./quickstart.sh louisiana
./quickstart.sh luxembourg ./quickstart.sh luxembourg
./quickstart.sh macedonia ./quickstart.sh macedonia
./quickstart.sh madagascar ./quickstart.sh madagascar
./quickstart.sh maine ./quickstart.sh maine
./quickstart.sh malta ./quickstart.sh malta
./quickstart.sh manitoba ./quickstart.sh manitoba
./quickstart.sh martinique ./quickstart.sh martinique
./quickstart.sh maryland ./quickstart.sh maryland
./quickstart.sh massachusetts ./quickstart.sh massachusetts
./quickstart.sh mayotte ./quickstart.sh mayotte
./quickstart.sh mexico ./quickstart.sh mexico
./quickstart.sh michigan ./quickstart.sh michigan
./quickstart.sh minnesota ./quickstart.sh minnesota
./quickstart.sh mississippi ./quickstart.sh mississippi
./quickstart.sh missouri ./quickstart.sh missouri
./quickstart.sh mittelfranken ./quickstart.sh mittelfranken
./quickstart.sh moldova ./quickstart.sh moldova
./quickstart.sh monaco ./quickstart.sh monaco
./quickstart.sh mongolia ./quickstart.sh mongolia
./quickstart.sh montana ./quickstart.sh montana
./quickstart.sh montenegro ./quickstart.sh montenegro
./quickstart.sh morocco ./quickstart.sh morocco
./quickstart.sh nebraska ./quickstart.sh nebraska
./quickstart.sh nepal ./quickstart.sh nepal
./quickstart.sh netherlands ./quickstart.sh netherlands
./quickstart.sh nevada ./quickstart.sh nevada
./quickstart.sh niederbayern ./quickstart.sh niederbayern
./quickstart.sh niedersachsen ./quickstart.sh niedersachsen
./quickstart.sh nigeria ./quickstart.sh nigeria
./quickstart.sh norfolk ./quickstart.sh norfolk
./quickstart.sh norway ./quickstart.sh norway
./quickstart.sh nottinghamshire ./quickstart.sh nottinghamshire
./quickstart.sh nunavut ./quickstart.sh nunavut
./quickstart.sh oberbayern ./quickstart.sh oberbayern
./quickstart.sh oberfranken ./quickstart.sh oberfranken
./quickstart.sh oberpfalz ./quickstart.sh oberpfalz
./quickstart.sh ohio ./quickstart.sh ohio
./quickstart.sh oklahoma ./quickstart.sh oklahoma
./quickstart.sh ontario ./quickstart.sh ontario
./quickstart.sh oregon ./quickstart.sh oregon
./quickstart.sh oxfordshire ./quickstart.sh oxfordshire
./quickstart.sh pakistan ./quickstart.sh pakistan
./quickstart.sh paraguay ./quickstart.sh paraguay
./quickstart.sh pennsylvania ./quickstart.sh pennsylvania
./quickstart.sh peru ./quickstart.sh peru
./quickstart.sh philippines ./quickstart.sh philippines
./quickstart.sh picardie ./quickstart.sh picardie
./quickstart.sh poland ./quickstart.sh poland
./quickstart.sh portugal ./quickstart.sh portugal
./quickstart.sh quebec ./quickstart.sh quebec
./quickstart.sh reunion ./quickstart.sh reunion
./quickstart.sh romania ./quickstart.sh romania
./quickstart.sh saarland ./quickstart.sh saarland
./quickstart.sh sachsen ./quickstart.sh sachsen
./quickstart.sh saskatchewan ./quickstart.sh saskatchewan
./quickstart.sh schwaben ./quickstart.sh schwaben
./quickstart.sh scotland ./quickstart.sh scotland
./quickstart.sh serbia ./quickstart.sh serbia
./quickstart.sh shropshire ./quickstart.sh shropshire
./quickstart.sh slovakia ./quickstart.sh slovakia
./quickstart.sh slovenia ./quickstart.sh slovenia
./quickstart.sh somalia ./quickstart.sh somalia
./quickstart.sh somerset ./quickstart.sh somerset
./quickstart.sh spain ./quickstart.sh spain
./quickstart.sh staffordshire ./quickstart.sh staffordshire
./quickstart.sh suffolk ./quickstart.sh suffolk
./quickstart.sh surrey ./quickstart.sh surrey
./quickstart.sh sweden ./quickstart.sh sweden
./quickstart.sh switzerland ./quickstart.sh switzerland
./quickstart.sh syria ./quickstart.sh syria
./quickstart.sh taiwan ./quickstart.sh taiwan
./quickstart.sh tajikistan ./quickstart.sh tajikistan
./quickstart.sh tanzania ./quickstart.sh tanzania
./quickstart.sh tennessee ./quickstart.sh tennessee
./quickstart.sh texas ./quickstart.sh texas
./quickstart.sh thailand ./quickstart.sh thailand
./quickstart.sh thueringen ./quickstart.sh thueringen
./quickstart.sh turkey ./quickstart.sh turkey
./quickstart.sh turkmenistan ./quickstart.sh turkmenistan
./quickstart.sh ukraine ./quickstart.sh ukraine
./quickstart.sh unterfranken ./quickstart.sh unterfranken
./quickstart.sh uruguay ./quickstart.sh uruguay
./quickstart.sh us ./quickstart.sh us
./quickstart.sh utah ./quickstart.sh utah
./quickstart.sh uzbekistan ./quickstart.sh uzbekistan
./quickstart.sh vermont ./quickstart.sh vermont
./quickstart.sh vietnam ./quickstart.sh vietnam
./quickstart.sh virginia ./quickstart.sh virginia
./quickstart.sh wales ./quickstart.sh wales
./quickstart.sh washington ./quickstart.sh washington
./quickstart.sh wiltshire ./quickstart.sh wiltshire
./quickstart.sh wisconsin ./quickstart.sh wisconsin
./quickstart.sh wyoming ./quickstart.sh wyoming
./quickstart.sh yukon ./quickstart.sh yukon
``` ```
### Change MIN_ZOOM and MAX_ZOOM ### Change MIN_ZOOM and MAX_ZOOM
modify the settings in the `.env` file modify the settings in the `.env` file
* QUICKSTART_MIN_ZOOM=0 * QUICKSTART_MIN_ZOOM=0
* QUICKSTART_MAX_ZOOM=7 * QUICKSTART_MAX_ZOOM=7
and re-start `./quickstart.sh ` and re-start `./quickstart.sh `
* the new config file re-generating to here ./data/docker-compose-config.yml * the new config file re-generating to here ./data/docker-compose-config.yml
Hints:
* Small increments! Never starts with the MAX_ZOOM = 14
* The suggested MAX_ZOOM = 14 - use only with small extracts

View File

@ -47,28 +47,37 @@ echo "====> : OpenMapTiles quickstart! [ https://github.com/openmaptiles/openmap
echo " : This will be logged to the $log_file file ( for debugging ) and to the screen" echo " : This will be logged to the $log_file file ( for debugging ) and to the screen"
echo " : Git version: $githash / Started: $STARTDATE " echo " : Git version: $githash / Started: $STARTDATE "
echo " : Your bash version: $BASH_VERSION" echo " : Your bash version: $BASH_VERSION"
echo " : Your system is:" echo " : Your OS: $OSTYPE"
lsb_release -a
echo " "
echo "-------------------------------------------------------------------------------------"
echo " : This is working on x86_64 ; Your kernel is:"
uname -r
uname -m
KERNEL_CPU_VER=$(uname -m) if [[ "$OSTYPE" == "linux-gnu" ]]; then
if [ "$KERNEL_CPU_VER" != "x86_64" ]; then
echo "ERR: Sorry this is working only on x86_64!" echo " : Your system is:"
exit 1 lsb_release -a
echo " "
echo "-------------------------------------------------------------------------------------"
echo " : This is working on x86_64 ; Your kernel is:"
uname -r
uname -m
KERNEL_CPU_VER=$(uname -m)
if [ "$KERNEL_CPU_VER" != "x86_64" ]; then
echo "ERR: Sorry this is working only on x86_64!"
exit 1
fi
echo " : --- Memory, CPU info ---- "
mem=$( grep MemTotal /proc/meminfo | awk '{print $2}' | xargs -I {} echo "scale=4; {}/1024^2" | bc )
echo "system memory (GB): ${mem} "
grep SwapTotal /proc/meminfo
echo cpu number: $(grep -c processor /proc/cpuinfo) x $(cat /proc/cpuinfo | grep "bogomips" | head -1)
cat /proc/meminfo | grep Free
else
echo " "
echo "Warning : This is not a Linux ... ( Less tested ... ) "
echo " "
fi fi
echo " : --- Memory, CPU info ---- "
mem=$( grep MemTotal /proc/meminfo | awk '{print $2}' | xargs -I {} echo "scale=4; {}/1024^2" | bc )
echo "system memory (GB): ${mem} "
grep SwapTotal /proc/meminfo
echo cpu number: $(grep -c processor /proc/cpuinfo) x $(cat /proc/cpuinfo | grep "bogomips" | head -1)
cat /proc/meminfo | grep Free
echo " " echo " "
echo "-------------------------------------------------------------------------------------" echo "-------------------------------------------------------------------------------------"