/usr/share/doc/mapproxy/html/seed.html is in mapproxy-doc 1.9.0-3+deb9u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 | <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Seeding — MapProxy 1.8.2a0 Docs</title>
<link rel="stylesheet" href="_static/basic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/bootstrap-3.3.6/css/bootstrap.min.css" type="text/css" />
<link rel="stylesheet" href="_static/bootstrap-3.3.6/css/bootstrap-theme.min.css" type="text/css" />
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/mapproxy.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.8.2a0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="_static/js/jquery-fix.js"></script>
<script type="text/javascript" src="_static/bootstrap-3.3.6/js/bootstrap.min.js"></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="MapProxy 1.8.2a0 Docs" href="index.html" />
<link rel="next" title="Coverages" href="coverages.html" />
<link rel="prev" title="Caches" href="caches.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
</head>
<body role="document">
<div id="navbar" class="navbar navbar-default ">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a href="index.html" class="pull-left"><img src="_static/logo.png" height="50">
</a>
<a class="navbar-brand" href="index.html">
<span>
MapProxy</span>
<span>1.8.2a0</span>
</a>
</div>
<div class="collapse navbar-collapse nav-collapse">
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-md-3">
<div id="sidebar" class="bs-sidenav" role="complementary"><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="install_windows.html">Installation on Windows</a></li>
<li class="toctree-l1"><a class="reference internal" href="install_osgeo4w.html">Installation on OSGeo4W</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="services.html">Services</a></li>
<li class="toctree-l1"><a class="reference internal" href="sources.html">Sources</a></li>
<li class="toctree-l1"><a class="reference internal" href="caches.html">Caches</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Seeding</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#mapproxy-seed">mapproxy-seed</a></li>
<li class="toctree-l2"><a class="reference internal" href="#configuration">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="#seeds"><code class="docutils literal"><span class="pre">seeds</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#cleanups"><code class="docutils literal"><span class="pre">cleanups</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#id7"><code class="docutils literal"><span class="pre">coverages</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#old-configuration">Old Configuration</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="coverages.html">Coverages</a></li>
<li class="toctree-l1"><a class="reference internal" href="mapproxy_util.html">mapproxy-util</a></li>
<li class="toctree-l1"><a class="reference internal" href="mapproxy_util_autoconfig.html">mapproxy-util autoconfig</a></li>
<li class="toctree-l1"><a class="reference internal" href="deployment.html">Deployment</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration_examples.html">Configuration examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="inspire.html">INSPIRE View Service</a></li>
<li class="toctree-l1"><a class="reference internal" href="labeling.html">WMS Labeling</a></li>
<li class="toctree-l1"><a class="reference internal" href="auth.html">Authentication and Authorization</a></li>
<li class="toctree-l1"><a class="reference internal" href="decorate_img.html">Decorate Image</a></li>
<li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="mapproxy_2.html">MapProxy 2.0</a></li>
</ul>
</div>
</div>
<div class="col-md-8">
<div class="section" id="seeding">
<h1>Seeding<a class="headerlink" href="#seeding" title="Permalink to this headline">¶</a></h1>
<p>The MapProxy creates all tiles on demand. To improve the performance for commonly
requested views it is possible to pre-generate these tiles. The <code class="docutils literal"><span class="pre">mapproxy-seed</span></code> script does this task.</p>
<p>The tool can seed one or more polygon or BBOX areas for each cached layer.</p>
<p>MapProxy does not seed the tile pyramid level by level, but traverses the tile pyramid depth-first, from bottom to top. This is optimized to work <cite>with</cite> the caches of your operating system and geospatial database, and not against.</p>
<div class="section" id="mapproxy-seed">
<h2>mapproxy-seed<a class="headerlink" href="#mapproxy-seed" title="Permalink to this headline">¶</a></h2>
<p>The command line script expects a seed configuration that describes which tiles from which layer should be generated. See <a class="reference internal" href="#configuration">configuration</a> for the format of the file.</p>
<div class="section" id="options">
<h3>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h3>
<dl class="option">
<dt id="cmdoption-s">
<span id="cmdoption--seed-conf"></span><code class="descname">-s</code><code class="descclassname"> <seed.yaml></code><code class="descclassname">, </code><code class="descname">--seed-conf</code><code class="descclassname">==<seed.yaml></code><a class="headerlink" href="#cmdoption-s" title="Permalink to this definition">¶</a></dt>
<dd><p>The seed configuration. You can also pass the configuration as the last argument to <code class="docutils literal"><span class="pre">mapproxy-seed</span></code></p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-f">
<span id="cmdoption--proxy-conf"></span><code class="descname">-f</code><code class="descclassname"> <mapproxy.yaml></code><code class="descclassname">, </code><code class="descname">--proxy-conf</code><code class="descclassname">=<mapproxy.yaml></code><a class="headerlink" href="#cmdoption-f" title="Permalink to this definition">¶</a></dt>
<dd><p>The MapProxy configuration to use. This file should describe all caches and grids that the seed configuration references.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-c">
<span id="cmdoption--concurrency"></span><code class="descname">-c</code><code class="descclassname"> N</code><code class="descclassname">, </code><code class="descname">--concurrency</code><code class="descclassname"> N</code><a class="headerlink" href="#cmdoption-c" title="Permalink to this definition">¶</a></dt>
<dd><p>The number of concurrent seed worker. Some parts of the seed tool are CPU intensive
(image splitting and encoding), use this option to distribute that load across multiple
CPUs. To limit the concurrent requests to the source WMS see
<a class="reference internal" href="sources.html#wms-source-concurrent-requests-label"><span class="std std-ref">concurrent_requests</span></a></p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-n">
<span id="cmdoption--dry-run"></span><code class="descname">-n</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--dry-run</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-n" title="Permalink to this definition">¶</a></dt>
<dd><p>This will simulate the seed/cleanup process without requesting, creating or removing any tiles.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption--summary">
<code class="descname">--summary</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption--summary" title="Permalink to this definition">¶</a></dt>
<dd><p>Print a summary of all seeding and cleanup tasks and exit.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-i">
<span id="cmdoption--interactive"></span><code class="descname">-i</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--interactive</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-i" title="Permalink to this definition">¶</a></dt>
<dd><p>Print a summary of each seeding and cleanup task and ask if <code class="docutils literal"><span class="pre">mapproxy-seed</span></code> should seed/cleanup that task. It will query for each task before it starts.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption--seed">
<code class="descname">--seed</code><code class="descclassname">=<task1,task2,..></code><a class="headerlink" href="#cmdoption--seed" title="Permalink to this definition">¶</a></dt>
<dd><p>Only seed the named seeding tasks. You can select multiple tasks with a list of comma seperated names, or you can use the <code class="docutils literal"><span class="pre">--seed</span></code> option multiple times.
You can use <code class="docutils literal"><span class="pre">ALL</span></code> to select all tasks.
This disables all cleanup tasks unless you also use the <code class="docutils literal"><span class="pre">--cleanup</span></code> option.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption--cleanup">
<code class="descname">--cleanup</code><code class="descclassname">=<task1,task2,..></code><a class="headerlink" href="#cmdoption--cleanup" title="Permalink to this definition">¶</a></dt>
<dd><p>Only cleanup the named tasks. You can select multiple tasks with a list of comma seperated names, or you can use the <code class="docutils literal"><span class="pre">--cleanup</span></code> option multiple times.
You can use <code class="docutils literal"><span class="pre">ALL</span></code> to select all tasks.
This disables all seeding tasks unless you also use the <code class="docutils literal"><span class="pre">--seed</span></code> option.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption--continue">
<code class="descname">--continue</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption--continue" title="Permalink to this definition">¶</a></dt>
<dd><p>Continue an interrupted seed progress. MapProxy will start the seeding progress at the begining if the progress file (<code class="docutils literal"><span class="pre">--progress-file</span></code>) was not found. MapProxy can only continue if the previous seed was started with the <code class="docutils literal"><span class="pre">--progress-file</span></code> or <code class="docutils literal"><span class="pre">--continue</span></code> option.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption--progress-file">
<code class="descname">--progress-file</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption--progress-file" title="Permalink to this definition">¶</a></dt>
<dd><p>Filename where MapProxy stores the seeding progress for the <code class="docutils literal"><span class="pre">--continue</span></code> option. Defaults to <code class="docutils literal"><span class="pre">.mapproxy_seed_progress</span></code> in the current working directory. MapProxy will remove that file after a successful seed.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption--use-cache-lock">
<code class="descname">--use-cache-lock</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption--use-cache-lock" title="Permalink to this definition">¶</a></dt>
<dd><p>Lock each cache to prevent multiple parallel <cite>mapproxy-seed</cite> calls to work on the same cache.
It does not lock normal operation of MapProxy.</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption--log-config">
<code class="descname">--log-config</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption--log-config" title="Permalink to this definition">¶</a></dt>
<dd><p>The logging configuration file to use.</p>
</dd></dl>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.5.0: </span><code class="docutils literal"><span class="pre">--continue</span></code> and <code class="docutils literal"><span class="pre">--progress-file</span></code> option</p>
</div>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.7.0: </span><code class="docutils literal"><span class="pre">--log-config</span></code> option</p>
</div>
</div>
<div class="section" id="examples">
<h3>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h3>
<p>Seed with concurrency of 4:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">mapproxy</span><span class="o">-</span><span class="n">seed</span> <span class="o">-</span><span class="n">f</span> <span class="n">mapproxy</span><span class="o">.</span><span class="n">yaml</span> <span class="o">-</span><span class="n">c</span> <span class="mi">4</span> <span class="n">seed</span><span class="o">.</span><span class="n">yaml</span>
</pre></div>
</div>
<p>Print summary of all seed tasks and exit:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">mapproxy</span><span class="o">-</span><span class="n">seed</span> <span class="o">-</span><span class="n">f</span> <span class="n">mapproxy</span><span class="o">.</span><span class="n">yaml</span> <span class="o">-</span><span class="n">s</span> <span class="n">seed</span><span class="o">.</span><span class="n">yaml</span> <span class="o">--</span><span class="n">summary</span> <span class="o">--</span><span class="n">seed</span> <span class="n">ALL</span>
</pre></div>
</div>
<p>Interactively select which tasks should be seeded:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">mapproxy</span><span class="o">-</span><span class="n">seed</span> <span class="o">-</span><span class="n">f</span> <span class="n">mapproxy</span><span class="o">.</span><span class="n">yaml</span> <span class="o">-</span><span class="n">s</span> <span class="n">seed</span><span class="o">.</span><span class="n">yaml</span> <span class="o">-</span><span class="n">i</span>
</pre></div>
</div>
<p>Seed task1 and task2 and cleanup task3 with concurrency of 2:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">mapproxy</span><span class="o">-</span><span class="n">seed</span> <span class="o">-</span><span class="n">f</span> <span class="n">mapproxy</span><span class="o">.</span><span class="n">yaml</span> <span class="o">-</span><span class="n">s</span> <span class="n">seed</span><span class="o">.</span><span class="n">yaml</span> <span class="o">-</span><span class="n">c</span> <span class="mi">2</span> <span class="o">--</span><span class="n">seed</span> <span class="n">task1</span><span class="p">,</span><span class="n">task2</span> \
<span class="o">--</span><span class="n">cleanup</span> <span class="n">task3</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The configuration changed with MapProxy 1.0.0, the old format with <code class="docutils literal"><span class="pre">seeds</span></code> and <code class="docutils literal"><span class="pre">views</span></code> is still supported but will be deprecated in the future. See <a class="reference internal" href="#seed-old-configuration"><span class="std std-ref">below</span></a> for information about the old format.</p>
</div>
<p>The configuration is a YAML file with three sections:</p>
<dl class="docutils">
<dt><code class="docutils literal"><span class="pre">seeds</span></code></dt>
<dd>Configure seeding tasks.</dd>
<dt><code class="docutils literal"><span class="pre">cleanups</span></code></dt>
<dd>Configure cleanup tasks.</dd>
<dt><code class="docutils literal"><span class="pre">coverages</span></code></dt>
<dd>Configure coverages for seeding and cleanup tasks.</dd>
</dl>
<div class="section" id="example">
<h3>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">seeds</span><span class="p">:</span>
<span class="n">myseed1</span><span class="p">:</span>
<span class="p">[</span><span class="o">...</span><span class="p">]</span>
<span class="n">myseed2</span>
<span class="p">[</span><span class="o">...</span><span class="p">]</span>
<span class="n">cleanups</span><span class="p">:</span>
<span class="n">mycleanup1</span><span class="p">:</span>
<span class="p">[</span><span class="o">...</span><span class="p">]</span>
<span class="n">mycleanup2</span><span class="p">:</span>
<span class="p">[</span><span class="o">...</span><span class="p">]</span>
<span class="n">coverages</span><span class="p">:</span>
<span class="n">mycoverage1</span><span class="p">:</span>
<span class="p">[</span><span class="o">...</span><span class="p">]</span>
<span class="n">mycoverage2</span><span class="p">:</span>
<span class="p">[</span><span class="o">...</span><span class="p">]</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="seeds">
<h2><code class="docutils literal"><span class="pre">seeds</span></code><a class="headerlink" href="#seeds" title="Permalink to this headline">¶</a></h2>
<p>Here you can define multiple seeding tasks. A task defines <em>what</em> should be seeded. Each task is configured as a dictionary with the name of the task as the key. You can use the names to select single tasks on the command line of <code class="docutils literal"><span class="pre">mapproxy-seed</span></code>.</p>
<p><code class="docutils literal"><span class="pre">mapproxy-seed</span></code> will always process one tile pyramid after the other. Each tile pyramid is defined by a cache and a corresponding grid. A cache with multiple grids consists of multiple tile pyramids. You can configure which tile pyramid you want to seed with the <code class="docutils literal"><span class="pre">caches</span></code> and <code class="docutils literal"><span class="pre">grids</span></code> options.</p>
<p>You can further limit the part of the tile pyramid with the <code class="docutils literal"><span class="pre">levels</span></code> and <code class="docutils literal"><span class="pre">coverages</span></code> options.</p>
<p>Each seed tasks takes the following options:</p>
<div class="section" id="caches">
<h3><code class="docutils literal"><span class="pre">caches</span></code><a class="headerlink" href="#caches" title="Permalink to this headline">¶</a></h3>
<p>A list with the caches that should be seeded for this task. The names should match the cache names in your MapProxy configuration.</p>
</div>
<div class="section" id="grids">
<h3><code class="docutils literal"><span class="pre">grids</span></code><a class="headerlink" href="#grids" title="Permalink to this headline">¶</a></h3>
<p>A list with the grid names that should be seeded for the <code class="docutils literal"><span class="pre">caches</span></code>.
The names should match the grid names in your mapproxy configuration.
All caches of this tasks need to support the grids you specify here.
By default, the grids that are common to all configured caches will be seeded.</p>
</div>
<div class="section" id="levels">
<h3><code class="docutils literal"><span class="pre">levels</span></code><a class="headerlink" href="#levels" title="Permalink to this headline">¶</a></h3>
<p>Either a list of levels that should be seeded, or a dictionary with <code class="docutils literal"><span class="pre">from</span></code> and <code class="docutils literal"><span class="pre">to</span></code> that define a range of levels. You can omit <code class="docutils literal"><span class="pre">from</span></code> to start at level 0, or you can omit <code class="docutils literal"><span class="pre">to</span></code> to seed till the last level.
By default, all levels will be seeded.</p>
<p>Examples:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># seed multiple levels</span>
<span class="n">levels</span><span class="p">:</span> <span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">9</span><span class="p">]</span>
<span class="c1"># seed a single level</span>
<span class="n">levels</span><span class="p">:</span> <span class="p">[</span><span class="mi">3</span><span class="p">]</span>
<span class="c1"># seed from level 0 to 10 (including level 10)</span>
<span class="n">levels</span><span class="p">:</span>
<span class="n">to</span><span class="p">:</span> <span class="mi">10</span>
<span class="c1"># seed from level 3 to 6 (including level 3 and 6)</span>
<span class="n">levels</span><span class="p">:</span>
<span class="n">from</span><span class="p">:</span> <span class="mi">3</span>
<span class="n">to</span><span class="p">:</span> <span class="mi">6</span>
</pre></div>
</div>
</div>
<div class="section" id="coverages">
<h3><code class="docutils literal"><span class="pre">coverages</span></code><a class="headerlink" href="#coverages" title="Permalink to this headline">¶</a></h3>
<p>A list with coverage names. Limits the seed area to the coverages. By default, the whole coverage of the grids will be seeded.</p>
</div>
<div class="section" id="refresh-before">
<h3><code class="docutils literal"><span class="pre">refresh_before</span></code><a class="headerlink" href="#refresh-before" title="Permalink to this headline">¶</a></h3>
<p>Regenerate all tiles that are older than the given date. The date can either be absolute or relative. By default, existing tiles will not be refreshed.</p>
<p>MapProxy can also use the last modification time of a file. File paths should be relative to the proxy configuration or absolute.</p>
<p>Examples:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># absolute as ISO time</span>
<span class="n">refresh_before</span><span class="p">:</span>
<span class="n">time</span><span class="p">:</span> <span class="mi">2010</span><span class="o">-</span><span class="mi">10</span><span class="o">-</span><span class="mi">21</span><span class="n">T12</span><span class="p">:</span><span class="mi">35</span><span class="p">:</span><span class="mi">00</span>
<span class="c1"># relative from the start time of the seed process</span>
<span class="n">refresh_before</span><span class="p">:</span>
<span class="n">weeks</span><span class="p">:</span> <span class="mi">1</span>
<span class="n">days</span><span class="p">:</span> <span class="mi">7</span>
<span class="n">hours</span><span class="p">:</span> <span class="mi">4</span>
<span class="n">minutes</span><span class="p">:</span> <span class="mi">15</span>
<span class="c1"># modification time of a given file</span>
<span class="n">refresh_before</span><span class="p">:</span>
<span class="n">mtime</span><span class="p">:</span> <span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">file</span>
</pre></div>
</div>
</div>
<div class="section" id="id1">
<h3>Example<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">seeds</span><span class="p">:</span>
<span class="n">myseed1</span><span class="p">:</span>
<span class="n">caches</span><span class="p">:</span> <span class="p">[</span><span class="n">osm_cache</span><span class="p">]</span>
<span class="n">coverages</span><span class="p">:</span> <span class="p">[</span><span class="n">germany</span><span class="p">]</span>
<span class="n">grids</span><span class="p">:</span> <span class="p">[</span><span class="n">GLOBAL_MERCATOR</span><span class="p">]</span>
<span class="n">levels</span><span class="p">:</span>
<span class="n">to</span><span class="p">:</span> <span class="mi">10</span>
<span class="n">myseed2</span>
<span class="n">caches</span><span class="p">:</span> <span class="p">[</span><span class="n">osm_cache</span><span class="p">]</span>
<span class="n">coverages</span><span class="p">:</span> <span class="p">[</span><span class="n">niedersachsen</span><span class="p">,</span> <span class="n">bremen</span><span class="p">,</span> <span class="n">hamburg</span><span class="p">]</span>
<span class="n">grids</span><span class="p">:</span> <span class="p">[</span><span class="n">GLOBAL_MERCATOR</span><span class="p">]</span>
<span class="n">refresh_before</span><span class="p">:</span>
<span class="n">weeks</span><span class="p">:</span> <span class="mi">3</span>
<span class="n">levels</span><span class="p">:</span>
<span class="n">from</span><span class="p">:</span> <span class="mi">11</span>
<span class="n">to</span><span class="p">:</span> <span class="mi">15</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="cleanups">
<h2><code class="docutils literal"><span class="pre">cleanups</span></code><a class="headerlink" href="#cleanups" title="Permalink to this headline">¶</a></h2>
<p>Here you can define multiple cleanup tasks. Each task is configured as a dictionary with the name of the task as the key. You can use the names to select single tasks on the command line of <code class="docutils literal"><span class="pre">mapproxy-seed</span></code>.</p>
<div class="section" id="id2">
<h3><code class="docutils literal"><span class="pre">caches</span></code><a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
<p>A list with the caches where you want to cleanup old tiles. The names should match the cache names in your mapproxy configuration.</p>
</div>
<div class="section" id="id3">
<h3><code class="docutils literal"><span class="pre">grids</span></code><a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
<p>A list with the grid names for the <code class="docutils literal"><span class="pre">caches</span></code> where you want to cleanup.
The names should match the grid names in your mapproxy configuration.
All caches of this tasks need to support the grids you specify here.
By default, the grids that are common to all configured caches will be used.</p>
</div>
<div class="section" id="id4">
<h3><code class="docutils literal"><span class="pre">levels</span></code><a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
<p>Either a list of levels that should be cleaned up, or a dictionary with <code class="docutils literal"><span class="pre">from</span></code> and <code class="docutils literal"><span class="pre">to</span></code> that define a range of levels. You can omit <code class="docutils literal"><span class="pre">from</span></code> to start at level 0, or you can omit <code class="docutils literal"><span class="pre">to</span></code> to cleanup till the last level.
By default, all levels will be cleaned up.</p>
<p>Examples:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># cleanup multiple levels</span>
<span class="n">levels</span><span class="p">:</span> <span class="p">[</span><span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">9</span><span class="p">]</span>
<span class="c1"># cleanup a single level</span>
<span class="n">levels</span><span class="p">:</span> <span class="p">[</span><span class="mi">3</span><span class="p">]</span>
<span class="c1"># cleanup from level 0 to 10 (including level 10)</span>
<span class="n">levels</span><span class="p">:</span>
<span class="n">to</span><span class="p">:</span> <span class="mi">10</span>
<span class="c1"># cleanup from level 3 to 6 (including level 3 and 6)</span>
<span class="n">levels</span><span class="p">:</span>
<span class="n">from</span><span class="p">:</span> <span class="mi">3</span>
<span class="n">to</span><span class="p">:</span> <span class="mi">6</span>
</pre></div>
</div>
</div>
<div class="section" id="id5">
<h3><code class="docutils literal"><span class="pre">coverages</span></code><a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
<p>A list with coverage names. Limits the cleanup area to the coverages. By default, the whole coverage of the grids will be cleaned up.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Be careful when cleaning up caches with large coverages and levels with lots of tiles (>14).
Without <code class="docutils literal"><span class="pre">coverages</span></code>, the seed tool works on the file system level and it only needs to check for existing tiles if they should be removed. With <code class="docutils literal"><span class="pre">coverages</span></code>, the seed tool traverses the whole tile pyramid and needs to check every posible tile if it exists and if it should be removed. This is much slower.</p>
</div>
</div>
<div class="section" id="remove-all">
<h3><code class="docutils literal"><span class="pre">remove_all</span></code><a class="headerlink" href="#remove-all" title="Permalink to this headline">¶</a></h3>
<p>When set to true, remove all tiles regardless of the time they were created. You still limit the tiles with the <code class="docutils literal"><span class="pre">levels</span></code> and <code class="docutils literal"><span class="pre">coverage</span></code> options. MapProxy will try to remove tiles in a more efficient way with this option. For example: It will remove complete level directories for <code class="docutils literal"><span class="pre">file</span></code> caches instead of comparing each tile with a timestamp.</p>
</div>
<div class="section" id="remove-before">
<h3><code class="docutils literal"><span class="pre">remove_before</span></code><a class="headerlink" href="#remove-before" title="Permalink to this headline">¶</a></h3>
<p>Remove all tiles that are older than the given date. The date can either be absolute or relative. <code class="docutils literal"><span class="pre">remove_before</span></code> defaults to the start time of the seed process, so that newly created tile will not be removed.</p>
<p>MapProxy can also use the last modification time of a file. File paths should be relative to the proxy configuration or absolute.</p>
<p>Examples:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># absolute as ISO time</span>
<span class="n">remove_before</span><span class="p">:</span>
<span class="n">time</span><span class="p">:</span> <span class="mi">2010</span><span class="o">-</span><span class="mi">10</span><span class="o">-</span><span class="mi">21</span><span class="n">T12</span><span class="p">:</span><span class="mi">35</span><span class="p">:</span><span class="mi">00</span>
<span class="c1"># relative from the start time of the seed process</span>
<span class="n">remove_before</span><span class="p">:</span>
<span class="n">weeks</span><span class="p">:</span> <span class="mi">1</span>
<span class="n">days</span><span class="p">:</span> <span class="mi">7</span>
<span class="n">hours</span><span class="p">:</span> <span class="mi">4</span>
<span class="n">minutes</span><span class="p">:</span> <span class="mi">15</span>
<span class="c1"># modification time of a given file</span>
<span class="n">remove_before</span><span class="p">:</span>
<span class="n">mtime</span><span class="p">:</span> <span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">file</span>
</pre></div>
</div>
</div>
<div class="section" id="id6">
<h3>Example<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cleanups</span><span class="p">:</span>
<span class="n">highres</span><span class="p">:</span>
<span class="n">caches</span><span class="p">:</span> <span class="p">[</span><span class="n">osm_cache</span><span class="p">]</span>
<span class="n">grids</span><span class="p">:</span> <span class="p">[</span><span class="n">GLOBAL_MERCATOR</span><span class="p">,</span> <span class="n">GLOBAL_SPERICAL</span><span class="p">]</span>
<span class="n">remove_before</span><span class="p">:</span>
<span class="n">days</span><span class="p">:</span> <span class="mi">14</span>
<span class="n">levels</span><span class="p">:</span>
<span class="n">from</span><span class="p">:</span> <span class="mi">16</span>
<span class="n">old_project</span><span class="p">:</span>
<span class="n">caches</span><span class="p">:</span> <span class="p">[</span><span class="n">osm_cache</span><span class="p">]</span>
<span class="n">grids</span><span class="p">:</span> <span class="p">[</span><span class="n">GLOBAL_MERCATOR</span><span class="p">]</span>
<span class="n">coverages</span><span class="p">:</span> <span class="p">[</span><span class="n">mypolygon</span><span class="p">]</span>
<span class="n">levels</span><span class="p">:</span>
<span class="n">from</span><span class="p">:</span> <span class="mi">14</span>
<span class="n">to</span><span class="p">:</span> <span class="mi">18</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="id7">
<h2><code class="docutils literal"><span class="pre">coverages</span></code><a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h2>
<p>There are three different ways to describe the extent of a seeding or cleanup task.</p>
<ul class="simple">
<li>a simple rectangular bounding box,</li>
<li>a text file with one or more polygons in WKT format,</li>
<li>polygons from any data source readable with OGR (e.g. Shapefile, GeoJSON, PostGIS)</li>
</ul>
<p>Read the <a class="reference internal" href="coverages.html"><span class="doc">coverage documentation</span></a> for more information.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">You will need to install additional dependencies, if you want to use polygons to define your geographical extent of the seeding area, instead of simple bounding boxes. See <a class="reference internal" href="coverages.html"><span class="doc">coverage documentation</span></a>.</p>
</div>
<p>Each coverage has a name that is used in the seed and cleanup task configuration. If you don’t specify a coverage for a task, then the BBOX of the grid will be used.</p>
<div class="section" id="id8">
<h3>Example<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">coverages</span><span class="p">:</span>
<span class="n">germany</span><span class="p">:</span>
<span class="n">datasource</span><span class="p">:</span> <span class="s1">'shps/world_boundaries_m.shp'</span>
<span class="n">where</span><span class="p">:</span> <span class="s1">'CNTRY_NAME = "Germany"'</span>
<span class="n">srs</span><span class="p">:</span> <span class="s1">'EPSG:900913'</span>
<span class="n">switzerland</span><span class="p">:</span>
<span class="n">datasource</span><span class="p">:</span> <span class="s1">'polygons/SZ.txt'</span>
<span class="n">srs</span><span class="p">:</span> <span class="s1">'EPSG:900913'</span>
<span class="n">austria</span><span class="p">:</span>
<span class="n">bbox</span><span class="p">:</span> <span class="p">[</span><span class="mf">9.36</span><span class="p">,</span> <span class="mf">46.33</span><span class="p">,</span> <span class="mf">17.28</span><span class="p">,</span> <span class="mf">49.09</span><span class="p">]</span>
<span class="n">srs</span><span class="p">:</span> <span class="s1">'EPSG:4326'</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="old-configuration">
<span id="seed-old-configuration"></span><h2>Old Configuration<a class="headerlink" href="#old-configuration" title="Permalink to this headline">¶</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The following description is for the old seed configuration.</p>
</div>
<p>The configuration contains two keys: <code class="docutils literal"><span class="pre">views</span></code> and <code class="docutils literal"><span class="pre">seeds</span></code>. <code class="docutils literal"><span class="pre">views</span></code> describes
the geographical extents that should be seeded. <code class="docutils literal"><span class="pre">seeds</span></code> links actual layers with
those <code class="docutils literal"><span class="pre">views</span></code>.</p>
<div class="section" id="id9">
<h3>Seeds<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
<p>Contains a dictionary with layer/view mapping.:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">seeds</span><span class="p">:</span>
<span class="n">cache1</span><span class="p">:</span>
<span class="n">views</span><span class="p">:</span> <span class="p">[</span><span class="s1">'world'</span><span class="p">,</span> <span class="s1">'germany'</span><span class="p">,</span> <span class="s1">'oldb'</span><span class="p">]</span>
<span class="n">cache2</span><span class="p">:</span>
<span class="n">views</span><span class="p">:</span> <span class="p">[</span><span class="s1">'world'</span><span class="p">,</span> <span class="s1">'germany'</span><span class="p">]</span>
<span class="n">remove_before</span><span class="p">:</span>
<span class="n">time</span><span class="p">:</span> <span class="s1">'2009-04-01T14:45:00'</span>
<span class="c1"># or</span>
<span class="n">minutes</span><span class="p">:</span> <span class="mi">15</span>
<span class="n">hours</span><span class="p">:</span> <span class="mi">4</span>
<span class="n">days</span><span class="p">:</span> <span class="mi">9</span>
<span class="n">weeks</span><span class="p">:</span> <span class="mi">8</span>
</pre></div>
</div>
<dl class="docutils">
<dt><cite>remove_before</cite>:</dt>
<dd><p class="first">If present, recreate tiles if they are older than the date or time delta. At the
end of the seeding process all tiles that are older will be removed.</p>
<p class="last">You can either define a fixed time or a time delta. The <cite>time</cite> is a ISO-like date
string (no time-zones, no abbreviations). To define time delta use one or more
<cite>seconds</cite>, <cite>minutes</cite>, <cite>hours</cite>, <cite>days</cite> or <cite>weeks</cite> entries.</p>
</dd>
</dl>
</div>
<div class="section" id="views">
<h3>Views<a class="headerlink" href="#views" title="Permalink to this headline">¶</a></h3>
<p>Contains a dictionary with all views. Each view describes a coverage/geographical extent and the levels that should be seeded.</p>
<div class="section" id="id10">
<h4>Coverages<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h4>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">You will need to install additional dependencies, if you want to use polygons to define your geographical extent of the seeding area, instead of simple bounding boxes. See <a class="reference internal" href="coverages.html"><span class="doc">coverage documentation</span></a>.</p>
</div>
<p>There are three different ways to describe the extent of the seed view.</p>
<blockquote>
<div><ul class="simple">
<li>a simple rectangular bounding box,</li>
<li>a text file with one or more polygons in WKT format,</li>
<li>polygons from any data source readable with OGR (e.g. Shapefile, PostGIS)</li>
</ul>
</div></blockquote>
<p>Read the <a class="reference internal" href="coverages.html"><span class="doc">coverage documentation</span></a> for more information.</p>
</div>
</div>
<div class="section" id="other-options">
<h3>Other options<a class="headerlink" href="#other-options" title="Permalink to this headline">¶</a></h3>
<dl class="docutils">
<dt><code class="docutils literal"><span class="pre">srs</span></code>:</dt>
<dd>A list with SRSs. If the layer contains caches for multiple SRS, only the caches
that match one of the SRS in this list will be seeded.</dd>
<dt><code class="docutils literal"><span class="pre">res</span></code>:</dt>
<dd>Seed until this resolution is cached.</dd>
</dl>
<p>or</p>
<dl class="docutils">
<dt><code class="docutils literal"><span class="pre">level</span></code>:</dt>
<dd>A number until which this layer is cached, or a tuple with a range of
levels that should be cached.</dd>
</dl>
<div class="section" id="example-configuration">
<h4>Example configuration<a class="headerlink" href="#example-configuration" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">views</span><span class="p">:</span>
<span class="n">germany</span><span class="p">:</span>
<span class="n">datasource</span><span class="p">:</span> <span class="s1">'shps/world_boundaries_m.shp'</span>
<span class="n">where</span><span class="p">:</span> <span class="s1">'CNTRY_NAME = "Germany"'</span>
<span class="n">srs</span><span class="p">:</span> <span class="s1">'EPSG:900913'</span>
<span class="n">level</span><span class="p">:</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">14</span><span class="p">]</span>
<span class="n">srs</span><span class="p">:</span> <span class="p">[</span><span class="s1">'EPSG:900913'</span><span class="p">,</span> <span class="s1">'EPSG:4326'</span><span class="p">]</span>
<span class="n">switzerland</span><span class="p">:</span>
<span class="n">datasource</span><span class="p">:</span> <span class="s1">'polygons/SZ.txt'</span>
<span class="n">srs</span><span class="p">:</span> <span class="n">EPSG</span><span class="p">:</span><span class="mi">900913</span>
<span class="n">level</span><span class="p">:</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">14</span><span class="p">]</span>
<span class="n">srs</span><span class="p">:</span> <span class="p">[</span><span class="s1">'EPSG:900913'</span><span class="p">]</span>
<span class="n">austria</span><span class="p">:</span>
<span class="n">bbox</span><span class="p">:</span> <span class="p">[</span><span class="mf">9.36</span><span class="p">,</span> <span class="mf">46.33</span><span class="p">,</span> <span class="mf">17.28</span><span class="p">,</span> <span class="mf">49.09</span><span class="p">]</span>
<span class="n">srs</span><span class="p">:</span> <span class="n">EPSG</span><span class="p">:</span><span class="mi">4326</span>
<span class="n">level</span><span class="p">:</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">14</span><span class="p">]</span>
<span class="n">srs</span><span class="p">:</span> <span class="p">[</span><span class="s1">'EPSG:900913'</span><span class="p">]</span>
<span class="n">seeds</span><span class="p">:</span>
<span class="n">osm</span><span class="p">:</span>
<span class="n">views</span><span class="p">:</span> <span class="p">[</span><span class="s1">'germany'</span><span class="p">,</span> <span class="s1">'switzerland'</span><span class="p">,</span> <span class="s1">'austria'</span><span class="p">]</span>
<span class="n">remove_before</span><span class="p">:</span>
<span class="n">time</span><span class="p">:</span> <span class="s1">'2010-02-20T16:00:00'</span>
<span class="n">osm_roads</span><span class="p">:</span>
<span class="n">views</span><span class="p">:</span> <span class="p">[</span><span class="s1">'germany'</span><span class="p">]</span>
<span class="n">remove_before</span><span class="p">:</span>
<span class="n">days</span><span class="p">:</span> <span class="mi">30</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<p class="pull-right">
<a href="#">Back to top</a>
</p>
<p>
© Copyright Oliver Tonnhofer, Omniscale, <a href="http://mapproxy.org/about">Legal</a>
<br/>
Last updated on 2018-01-07
<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.9.
</p>
</div>
</footer>
</body>
</html>
|