This tutorial guides you to the MapProxy installation process on Unix systems. For Windows refer to Installation on Windows.
This tutorial was created and tested with Debian 5.0, if you’re installing MapProxy on a different system you might need to change some package names.
MapProxy is registered at the Python Package Index (PyPI). If you have installed Python setuptools (python-setuptools on Debian) you can install MapProxy with sudo easy_install MapProxy. This is really easy but we recommend to not use this method.
Create a new virtual environment¶
If you don’t have virtualenv installed, you can download a self-contained version:
Next we create a new virtual environment for our proxy installation. It is a good idea to organize all your environments into a single directory. I use ~/venv for that. To create a new environment with the name mapproxy and to activate it call:
python virtualenv.py --distribute ~/venv/mapproxy source ~/venv/mapproxy/bin/activate
The last step is required every time you start working with your MapProxy installation.
MapProxy is written in Python, thus you will need a working Python installation. MapProxy works with Python 2.5, 2.6 and 2.7.
MapProxy has some dependencies, other libraries that are required to run. Most dependencies are small Python libraries that will be installed automatically when you install MapProxy. There are two exceptions for the base of MapProxy (libproj and PIL) and some for more advanced functionality (Shapely, GEOS, GDAL, lxml).
MapProxy uses the Proj4 C Library for all coordinate transformation tasks. Most distributions offer this library as a binary package. On Debian or Ubuntu you can install it with:
sudo aptitude install libproj0
The Python Image Library (PIL) is also included in most distributions. On Debian or Ubuntu you can install it with:
sudo aptitude install python-imaging
Shapely and GEOS¶
You will need Shapely to use the coverage feature of MapProxy. Shapely offers Python bindings for the GEOS library. You need Shapely >= 1.2.0 and GEOS >= 3.1.0:
sudo aptitude install libgeos-dev pip install Shapely
The coverage feature allows you to read geometries from OGR datasources (Shapefiles, PostGIS, etc.). This package is optional and only required for OGR datasource support. OGR is part of GDAL:
sudo aptitude install libgdal-dev
lxml is used for more advanced WMS FeatureInformation operations like XSL transformation or the concatenation of multiple documents. On Debian or Ubuntu you can install it with:
sudo aptitude install python-lxml
Your virtual environment should already contain pip, a tool to install Python packages. If not, easy_install pip is enough to get it.
To install you need to call:
pip install MapProxy
You specify the release version of MapProxy. E.g.:
pip install MapProxy==0.9.0
or to get the latest 0.9 version:
pip install "MapProxy>=0.9.0,<=0.9.99"
To check if the MapProxy was successfully installed, you can directly call the version module. You should see the installed version number.
python -m mapproxy.version
Create a configuration¶
To create a new set of configuration files for MapProxy call:
paster create -t mapproxy_conf mymapproxy
This will create a mymapproxy directory with an etc, var and tmp directory. The etc directory contains all configuration files. Refer to the configuration documentation for more information. With the default configuration all log files and the cached data will be placed in the var directory.
paster create takes a project name and not a path. You need to change (cd) to the directory where you want the configuration directory to be created.
Start the test server¶
To start a test server:
cd mymapproxy paster serve etc/develop.ini --reload
There is already a test layer configured that obtains data from the Omniscale OpenStreetMap WMS. Feel free to use this service for testing.
MapProxy comes with a demo service that lists all configured WMS and TMS layers. You can access that service at http://localhost:8080/demo/