table of contents
mapproxy-seed(1) | mapproxy-seed(1) |
NAME¶
mapproxy-seed - pre-generate tiles for MapProxy
SYNOPSIS¶
mapproxy-seed
[OPTIONS]
DESCRIPTION¶
mapproxy-seed pre-generates tiles for MapProxy to improve the performance for commonly requested views, because MapProxy creates all tiles on demand otherwise.
The tool can seed one or more polygon or BBOX areas for each cached layer.
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 with the caches of your operating system and geospatial database, and not against.
OPTIONS¶
- -s seed.yaml, --seed-conf seed.yaml
- The seed configuration. You can also pass the configuration as the last argument to mapproxy-seed.
- -f mapproxy.yaml, --proxy-conf mapproxy.yaml
- The MapProxy configuration to use. This file should describe all caches and grids that the seed configuration references.
- -c N, --concurrency N
- 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 wms_source_concurrent_requests_label.
- -n, --dry-run
- This will simulate the seed/cleanup process without requesting, creating or removing any tiles.
- --summary
- Print a summary of all seeding and cleanup tasks and exit.
- -i, --interactive
- Print a summary of each seeding and cleanup task and ask if mapproxy-seed should seed/cleanup that task. It will query for each task before it starts.
- --seed task1,task2,..
- Only seed the named seeding tasks. You can select multiple tasks with a list of comma separated names, or you can use the --seed option multiple times. You can use ALL to select all tasks. This disables all cleanup tasks unless you also use the --cleanup option.
- --cleanup task1,task2,..
- Only cleanup the named tasks. You can select multiple tasks with a list of comma separated names, or you can use the --cleanup option multiple times. You can use ALL to select all tasks. This disables all seeding tasks unless you also use the --seed option.
- --continue
- Continue an interrupted seed progress. MapProxy will start the seeding progress at the beginning if the progress file (--progress-file) was not found. MapProxy can only continue if the previous seed was started with the --progress-file or --continue option.
- --progress-file
- Filename where MapProxy stores the seeding progress for the --continue option. Defaults to .mapproxy_seed_progress in the current working directory. MapProxy will remove that file after a successful seed.
- --duration
- Stop seeding process after this duration. This option accepts duration in the following format: 120s, 15m, 4h, 0.5d Use this option in combination with --continue to be able to resume the seeding.
- --reseed-file
- File created by mapproxy-seed at the start of a new seeding.
- --reseed-interval
- Only start seeding if --reseed-file is older then this duration. This option accepts duration in the following format: 120s, 15m, 4h, 0.5d Use this option in combination with --continue to be able to resume the seeding.
- --use-cache-lock
- Lock each cache to prevent multiple parallel mapproxy-seed calls to work on the same cache. It does not lock normal operation of MapProxy.
- --log-config
- The logging configuration file to use.
EXAMPLE¶
Seed with concurrency of 4:
mapproxy-seed -f mapproxy.yaml -c 4 seed.yaml
Print summary of all seed tasks and exit:
mapproxy-seed -f mapproxy.yaml -s seed.yaml --summary --seed ALL
Interactively select which tasks should be seeded:
mapproxy-seed -f mapproxy.yaml -s seed.yaml -i
Seed task1 and task2 and cleanup task3 with concurrency of 2:
mapproxy-seed -f mapproxy.yaml -s seed.yaml -c 2 --seed task1,task2 \
--cleanup task3
29 August 2024 |