Skip to content

CONFIG.md

Latest commit

 

History

History
365 lines (362 loc) · 53.4 KB

CONFIG.md

File metadata and controls

365 lines (362 loc) · 53.4 KB

TileCloud-chain configuration

Properties

Definitions

  • headers (object): The headers that we send to the WMS backend. Can contain additional properties.
    • Additional properties (string): The header value.
  • grid (object): The WMTS grid definition, see https://github.com/camptocamp/tilecloud-chain/blob/master/tilecloud_chain/USAGE.rst#configure-grids. Cannot contain additional properties.
    • resolution_scale (integer): The scale used to build a FreeTileGrid typically '2'.
    • resolutions (array, required): The resolutions in pixel per meter.
      • Items (number)
    • bbox (array, required): The bounding box in meter. Length must be equal to 4.
      • Items (number)
    • srs (string, required): The projection reference. Must match pattern: ^EPSG:[0-9]+$ (Test).
    • proj4_literal (string): The Proj4 definition.
    • unit (string): The projection unit. Default: "m".
    • tile_size (integer): The tile size in pixel. Default: 256.
    • matrix_identifier (string): The identifier to use in the tiles URL, recommend to be resolution (default). Must be one of: "zoom" or "resolution". Default: "zoom".
  • cache_wmtscapabilities_file (string): The generated WMTS capabilities file name. Default: "1.0.0/WMTSCapabilities.xml".
  • cache_http_url (string): The HTTP URL %host will be replaces by one of the hosts.
  • cache_hosts (array): The host used to build the HTTP URLs.
    • Items (string)
  • cache_http_urls (array)
    • Items (string)
  • cache_folder (string): The root folder of the cache. Default: "".
  • cache_filesystem (object): Can contain additional properties.
  • cache_s3 (object): Can contain additional properties.
  • cache_azure (object): Azure Blob Storage. Can contain additional properties.
  • cache_mbtiles (object): Can contain additional properties.
  • cache_bsddb (object): Can contain additional properties.
  • cache: The tiles cache definition, see https://github.com/camptocamp/tilecloud-chain/blob/master/tilecloud_chain/USAGE.rst#configure-caches.
  • layer_title (string): The title, use to generate the capabilities.
  • layer_grid (string): The grid name, deprecated, use grids instead.
  • layer_grids (array): All the used grids name used in the capabilities, by default only the grid is used, if grid is not defined, all the grids are used.
    • Items (string)
  • layer_srs (string): The projection reference, used for the bbox, the geoms, and the --bbox argument. Must match pattern: ^EPSG:[0-9]+$ (Test).
  • layer_proj4_literal (string): The Proj4 definition, used for the bbox, the geoms, and the --bbox argument.
  • layer_bbox (array): The bounding box where we will generate the tiles. Length must be equal to 4.
    • Items (number)
  • layer_min_resolution_seed (number): The minimum resolutions to pre-generate.
  • layer_px_buffer (integer): The buffer in pixel used to calculate geometry intersection. Default: 0.
  • layer_meta (boolean): Use meta-tiles, see https://github.com/camptocamp/tilecloud-chain/blob/master/tilecloud_chain/USAGE.rst#meta-tiles. Default: false.
  • layer_meta_size (integer): The meta-tile size in tiles. Default: 5.
  • layer_meta_buffer (integer): The meta-tiles buffer in pixels. Default: 128.
  • layer_meta_save_options (object): The Pillow options used to save the tile generated from the meta-tiles.
  • layer_layers (string): The WMS layers.
  • layer_wmts_style (string): The WMTS style. Must match pattern: ^[a-zA-Z0-9_\-\+~\.]+$ (Test).
  • layer_mime_type (string): The MIME type of the tiles. Must match pattern: ^[a-zA-Z0-9!#$%^&\*_\-\+{}\|'.~]+/[a-zA-Z0-9!#$%^&*_-+{}|'.~]+$ (Test).
  • layer_extension (string): The layer extension.
  • layer_dimension_name (string): The dimension name. Must match pattern: (?i)^(?!(SERVICE|VERSION|REQUEST|LAYERS|STYLES|SRS|CRS|BBOX|WIDTH|HEIGHT|FORMAT|BGCOLOR|TRANSPARENT|SLD|EXCEPTIONS|SALT))[a-z0-9_\-~\.]+$ (Test).
  • layer_dimensions (array): The WMTS dimensions.
    • Items (object): Cannot contain additional properties.
      • name (required): Refer to #/definitions/layer_dimension_name.
      • generate (array, required): The values that should be generate.
        • Items (string): Must match pattern: ^[a-zA-Z0-9_\-\+~\.]+$ (Test).
      • values (array, required): The values present in the capabilities.
        • Items (string): Must match pattern: ^[a-zA-Z0-9_\-\+~\.]+$ (Test).
      • default (string, required): The default value present in the capabilities. Must match pattern: ^[a-zA-Z0-9_\-\+~\.]+$ (Test).
  • layer_legend (object): Legend configuration for the layer. Cannot contain additional properties. Default: {}.
  • layer_legend_items (array): The provided legend.
    • Items (object): Cannot contain additional properties.
      • mime_type (string, required): The mime type used in the WMS request. Must match pattern: ^[a-zA-Z0-9!#$%^&\*_\-\+{}\|'.~]+/[a-zA-Z0-9!#$%^&*_-+{}|'.~]+$ (Test).
      • href (string, required): The URL of the legend image.
      • width (integer): The width of the legend image.
      • height (integer): The height of the legend image.
      • min_scale (number): The min scale of the legend image.
      • max_scale (number): The max scale of the legend image.
      • min_resolution (number): The min resolution of the legend image.
      • max_resolution (number): The max resolution of the legend image.
  • layer_legend_mime_type (string): The mime type used to store the generated legend. Must match pattern: ^[a-zA-Z0-9!#$%^&\*_\-\+{}\|'.~]+/[a-zA-Z0-9!#$%^&*_-+{}|'.~]+$ (Test). Default: "image/png".
  • layer_legend_extension (string): The extension used to store the generated legend. Must match pattern: ^[a-zA-Z0-9]+$ (Test). Default: "png".
  • layer_pre_hash_post_process (string): Do an image post process before the empty hash check.
  • layer_post_process (string): Do an image post process after the empty hash check.
  • layer_geoms (array): The geometries used to determine where we should create the tiles, see https://github.com/camptocamp/tilecloud-chain/blob/master/tilecloud_chain/USAGE.rst#configure-geomsql.
    • Items (object): Cannot contain additional properties.
      • connection (string, required): The PostgreSQL connection string.
      • sql (string, required): The SQL query that get the geometry in geom e.g. the_geom AS geom FROM my_table.
      • min_resolution (number): The min resolution where the query is valid.
      • max_resolution (number): The max resolution where the query is valid.
  • layer_empty_tile_detection (object): The rules used to detect the empty tiles, use generate-tiles --get-hash to get what we can use, see https://github.com/camptocamp/tilecloud-chain/blob/master/tilecloud_chain/USAGE.rst#configure-hash. Cannot contain additional properties.
    • size (integer, required): The tile size.
    • hash (string, required): The tile hash.
  • layer_empty_metatile_detection (object): The rules used to detect the empty meta-tiles, use generate-tiles --get-hash to get what we can use, see https://github.com/camptocamp/tilecloud-chain/blob/master/tilecloud_chain/USAGE.rst#configure-hash. Cannot contain additional properties.
    • size (integer, required): The meta-tile size.
    • hash (string, required): The meta-tile hash.
  • layer_cost (object): The rules used to calculate the cost. Cannot contain additional properties.
    • tileonly_generation_time (number): The time to generate a tile without meta-tile. Default: 40.
    • tile_generation_time (number): The time to generate a tile from the meta-tile. Default: 30.
    • metatile_generation_time (number): The time to generate a meta-tile. Default: 30.
    • tile_size (number): The tile mean size in bytes. Default: 20.
  • layer_wms (object): Cannot contain additional properties.
  • layer_mapnik (object): Cannot contain additional properties.
  • layer: The layer definition, see https://github.com/camptocamp/tilecloud-chain/blob/master/tilecloud_chain/USAGE.rst#configure-layers.
  • process (array): A command.
    • Items (object): Cannot contain additional properties.
      • cmd (string, required): The shell command, available parameters: %(in)s, %(out)s, %(args)s, %(x)s, %(y)s, %(z)s.
      • need_out (boolean): The command will generate an output in a file. Default: false.
      • arg (object): Used to build the %(args). Cannot contain additional properties.
        • default (string): The arguments used by default.
        • verbose (string): The arguments used on verbose mode.
        • debug (string): The arguments used on debug mode.
        • quiet (string): The arguments used on quiet mode.
  • generation (object): The configuration used for the generation. Cannot contain additional properties.
    • default_cache (string): The default cache name to be used, default do 'default'. Default: "default".
    • default_layers (array): The default layers to be generated.
      • Items (string)
    • authorised_user (string): The authorized user to generate the tiles (used to avoid permission issue on generated tiles) (main configuration).
    • maxconsecutive_errors (integer): The maximum number of consecutive errors (main configuration). Default: 10.
    • error_file (string): File name generated with the tiles in error, see https://github.com/camptocamp/tilecloud-chain/blob/master/tilecloud_chain/USAGE.rst#tiles-error-file (main configuration).
    • number_process (integer): Number of process used to generate the tiles (main configuration). Default: 1.
  • aws_region (string): The region. Must match pattern: ^(eu|us|ap|sa)-(north|south|east|west|central)(east|west)?-[1-3]$ (Test). Default: "eu-west-1".
  • postgresql (object): The PostgreSQL configuration (main configuration), the schema can be configured with the TILECLOUD_CHAIN_POSTGRESQL_SCHEMA environment variable. Cannot contain additional properties.
    • sqlalchemy_url (string): The SQLAlchemy URL (like: postgresql+psycopg2://username:password@host:5432/database) (main configuration), can also be set in the TILECLOUD_CHAIN_SQLALCHEMY_URL environment variable.
    • max_pending_minutes (integer): The max pending minutes (main configuration). Default: 10.
  • redis (object): The Redis configuration (main configuration). Cannot contain additional properties.
    • url (string): The server URL (main configuration), can also be set in the TILECLOUD_CHAIN_REDIS_URL environment variable. Must match pattern: ^rediss?://([^:@/]*:[^:@/]*@)?[^:@/]+(:[0-9]+)?(/.*)?$ (Test).
    • sentinels (array): The sentinels (main configuration), can also be set in the TILECLOUD_CHAIN_REDIS_SENTINELS environment variable.
      • Items (array): A sentinel (main configuration).
        • Items:
          • string: The sentinel host name (main configuration).
          • : The sentinel port (main configuration).
            • Any of
              • string
              • integer
    • connection_kwargs (object): The Redis connection arguments (main configuration).
    • sentinel_kwargs (object): The Redis sentinel arguments (main configuration).
    • service_name (string): The service name (main configuration), can also be set in the TILECLOUD_CHAIN_REDIS_SERVICE_NAME environment variable. Default: "mymaster".
    • socket_timeout (integer): The socket timeout (main configuration), can also be set in the TILECLOUD_CHAIN_REDIS_SOCKET_TIMEOUT environment variable.
    • db (integer): The database number (main configuration), can also be set in the TILECLOUD_CHAIN_REDIS_DB environment variable.
    • queue (string): The queue name (main configuration), can also be set in the TILECLOUD_CHAIN_REDIS_QUEUE environment variable. Default: "tilecloud".
    • timeout (integer): The timeout (main configuration), can also be set in the TILECLOUD_CHAIN_REDIS_TIMEOUT environment variable. Default: 5.
    • pending_timeout (integer): The pending timeout (main configuration). Default: 300.
    • max_retries (integer): The max retries (main configuration). Default: 5.
    • max_errors_age (integer): The max error age (main configuration), default is 1 day. Default: 86400.
    • max_errors_nb (integer): The max error number (main configuration). Default: 100.
    • prefix (string): The prefix (main configuration). Default: "tilecloud_cache".
    • expiration (integer): The meta-tile in queue expiration (main configuration), default is 8 hours. Default: 28800.
    • pending_count (integer): The pending count: the number of pending tiles get in one request (main configuration). Default: 10.
    • pending_max_count (integer): The pending max count: the maximum number of pending tiles get in one pass (if not generating other tiles, every second) (main configuration). Default: 10000.
  • server (object): Configuration used by the tile server, see https://github.com/camptocamp/tilecloud-chain/blob/master/tilecloud_chain/USAGE.rst#distribute-the-tiles. Cannot contain additional properties.
    • cache (string): The used cache name.
    • layers (array): Layers available in the server, default is all layers.
      • Items (string)
    • geoms_redirect (boolean): Take care on the geometries. Default: false.
    • static_allow_extension (array): The allowed extension of static files. Default: ["jpeg", "png", "xml", "js", "html", "css"].
      • Items (string)
    • wmts_path (string): No more used, replaced by TILECLOUD_CHAIN__WMTS_PATH environment variable.
    • expires (integer): The browser cache expiration in hours. Default: 8.
    • predefined_commands (array): The predefined commands used to generate the tiles.
      • Items (object): Cannot contain additional properties.
        • command (string): The command to run.
        • name (string): The name used in the admin interface.
    • allowed_commands (array): The allowed commands (main configuration). Default: ["generate-tiles", "generate-controller", "generate-cost"].
      • Items (string)
    • allowed_arguments (array): The allowed arguments (main configuration). Default: ["--layer", "--get-hash", "--generate-legend-images", "--get-bbox", "--ignore-error", "--bbox", "--zoom", "--grid", "--test", "--near", "--time", "--measure-generation-time", "--no-geom", "--dimensions"].
      • Items (string)
    • admin_footer (string): The footer of the admin interface.
    • admin_footer_classes (string): The CSS classes used on the footer of the admin interface.
  • cost (object): The configuration use to calculate the cast (unmaintained). Cannot contain additional properties.
    • request_per_layers (integer): Tile request per hours. Default: 10000000.
    • s3 (object): The S3 cost (main configuration). Cannot contain additional properties.
      • storage (number): The storage cost in $ / Gio / month (main configuration). Default: 0.125.
      • put (number): The cost of put in $ per 10 000 requests (main configuration). Default: 0.01.
      • get (number): The cost of get in $ per 10 000 requests (main configuration). Default: 0.01.
      • download (number): The cost of download in $ per Gio (main configuration). Default: 0.12.
    • cloudfront (object): The CloudFront cost (main configuration). Cannot contain additional properties.
      • get (number): The cost of get in $ per 10 000 requests (main configuration). Default: 0.009.
      • download (number): The cost of download in $ per Gio (main configuration). Default: 0.12.
    • sqs (object): The SQS cost, see https://github.com/camptocamp/tilecloud-chain/blob/master/tilecloud_chain/USAGE.rst#configure-sqs (main configuration). Cannot contain additional properties.
      • request (number): The cost of request in $ per 1 000 000 requests (main configuration). Default: 0.01.
  • metadata (object): The configuration of the WMTS capabilities metadata. Cannot contain additional properties.
    • title (string, required): The title.
    • abstract (string): The abstract.
    • servicetype (string): The service type. Default: "OGC WMTS".
    • keywords (array): The keywords.
      • Items (string)
    • fees (string): The fees.
    • access_constraints (string): The access constraints.
  • provider (object): The provider. Cannot contain additional properties.
    • name (string)
    • url (string): The public URL.
    • contact (object): The contact. Cannot contain additional properties.
      • name (string)
      • position (string)
      • info (object): The information. Cannot contain additional properties.
        • phone (object): The phone. Cannot contain additional properties.
          • voice (string): The voice number.
          • fax (string): The fax number.
        • address (object): The address. Cannot contain additional properties.
          • delivery (string): The delivery.
          • city (string): The city.
          • area (string): The area.
          • postal_code (integer): The postal code.
          • country (string): The country.
          • email (string): The email.
  • logging (object): The logging configuration to database, see https://github.com/camptocamp/tilecloud-chain/blob/master/tilecloud_chain/USAGE.rst#logging (main configuration). Cannot contain additional properties.
    • database (object, required): The database (main configuration). Cannot contain additional properties.
      • host (string): The host (main configuration).
      • port (integer): The port (main configuration). Default: 5432.
      • dbname (string, required): The database name (main configuration).
      • table (string, required): The table name (main configuration).
      • user (string, required): The user name (main configuration).
      • password (string, required): The password (main configuration).
⚡