mapcache_seed (1)

mapcache_seed \kx -c /path/to/mapcache.xml [options]

mapcache_seed is an advanced seeding tool for mapcache, whose main features are:

•

configurable number of seeding threads, to speed up the rendering

•

ability to reseed tiles older than a certain timestamp

•

ability to seed tiles given a shapefile/OGR datasource

\*(T<-c\*(T>, \*(T<--config\*(T> file

Path to the mapcache.xml configuration file that contains the tilesets that need to be seeded.

\*(T<-t\*(T>, \*(T<--tileset\*(T> name

Name of the tileset that must be seeded.

\*(T<-g\*(T>, \*(T<--grid\*(T> name

Name of the grid that must be seeded (the selected tileset must reference the given grid).

\*(T<-z\*(T>, \*(T<--zoom\*(T> minzoom,maxzoom

(Optional) Start and end zoom levels that must be seeded, separated by a comma, e.g. 0,6.

\*(T<-M\*(T>, \*(T<--metasize\*(T> width,height

Override metatile size while seeding, e.g. 8,8.

\*(T<-e\*(T>, \*(T<--extent\*(T> minx,miny,maxx,maxy

(Optional) Bounding box of the area to seed.

\*(T<-o\*(T>, \*(T<--older\*(T> timestamp|now

(Optional) Only seed tiles that are older than the given value. The value can either be the string "now", or a date formatted like year/month/day hour:minute, e.g.: "2011/01/31 20:45". (Note that a full timestamp should be quoted).

\*(T<-n\*(T>, \*(T<--nthreads\*(T> number

Number of parallel threads that should be used to request tiles from the WMS source. The default is 1, but can be set higher if the WMS server can withstand parallel requests (as a rule of thumb, the value chosen here should never be much higher than the number of cpus on the WMS server). (Incompatible with \*(T<-p\*(T>/\*(T<--nprocesses\*(T>).

\*(T<-p\*(T>, \*(T<--nprocesses\*(T> number

Number of parallel processes that should be used to request tiles from the WMS source. (Incompatible with \*(T<-n\*(T>/\*(T<--nthreads\*(T>).

\*(T<-m\*(T>, \*(T<--mode\*(T> seed|delete|transfer

Mode the utility will be running in: either seed (default), delete or transfer.

\*(T<-x\*(T>, \*(T<--transfer\*(T> tileset

Name of tileset to transfer.

\*(T<-D\*(T>, \*(T<--dimension\*(T> DIMENSION=VALUE

Used to specify which dimension to use if the tileset supports dimensions. Can be used multiple times to set multiple dimensions, e.g. \*(T<-D\*(T> "DIM1=VAL1" \*(T<-D\*(T> "DIM2=VAL2".

\*(T<-h\*(T>, \*(T<--help\*(T>

Show help.

\*(T<-q\*(T>, \*(T<--quiet\*(T>

Don't print progress messages to the standard output.

\*(T<-f\*(T>, \*(T<--force\*(T>

Force tile recreation even if it already exists.

\*(T<-v\*(T>, \*(T<--verbose\*(T>

Print verbose debugging info (if compiled in).

Optional Commandline options when using OGR/GEOS.

At compile time, if OGR and GEOS where found on the system, the seeder tool supports additional options to seed only the tiles that cover an arbitrary geographical area.

Important: Note that for the time being, the OGR datasource should be in the same projection as the grid you are seeding, as there is no automatic reprojection from the datasource projection to the grid projection.

\*(T<-d\*(T>, \*(T<--ogr-datasource\*(T> datasource

OGR connection to the spatial source. Consult the OGR documentation for all that is supported. In the simplest case (e.g. a Shapefile), this is just the full filename of the shapefile.

\*(T<-l\*(T>, \*(T<--ogr-layer\*(T> layer

(Optional) For datasources that contain multiple layers (e.g. postgis, with multiple tables), determines which layer will be used.

\*(T<-s\*(T>, \*(T<--ogr-sql\*(T> SQL

OGR sql expression that can be applied (see http://www.gdal.org/ogr/ogr_sql.html).

\*(T<-w\*(T>, \*(T<--ogr-where\*(T> where

SQL "where" expression to filter out returned values. This would typically be used to select only the geometry of a given country if the datasource contains all the world contours.

The seeding utility must be run under the same user account as the user running the webserver. This is required so the permissions on the tiles created by the seeder are accessible by the webserver, and conversely so the seeder has the rights to write files to directories created by the webserver.

A sample seeding session goes like this:

\*(T<
        [user@host]$ sudo www-data
        [www-data@host]$ mapcache_seed -c /path/to/www/conf/mapcache.xml [options]
        [www-data@host]$ logout
        [user@host]$
      \*(T>

Seed the "osm" tileset with the "g"(google/web-mercator) grid:

\*(T<
        mapcache_seed -c mapcache.xml -t osm -g g
      \*(T>

Seed levels 0 through 12:

\*(T<
        mapcache_seed -c mapcache.xml -t osm -g g -z 0,12
      \*(T>

Given a shapefile that contains the world country countours, seed only the areas that are covered by land (i.e. skip the oceans). Also use 4 request threads in parallel:

\*(T<
        mapcache_seed -c mapcache.xml -t osm -g g -z 0,12 -n 4 -d /path/to/seed.shp
      \*(T>

Same as beforehand, but only seed the USA (notice the quote usage, required to create valid sql with a single-quoted 'US':

\*(T<
        mapcache_seed -c mapcache.xml -t osm -g g -z 0,12 -n 4 -d /path/to/seed.shp -w "FIPS_A2='US'"
      \*(T>

Reseed levels 0 to 12 (this could also be done by deleting the cache for levels 0 to 12 and doing a classic seed, but doing so this way does not slow down the access from web clients):

\*(T<
        mapcache_seed -c mapcache.xml -t osm -g g -z 0,12 -o now
      \*(T>