logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

renderd.conf - Configuration file of rendering daemon for rendering OpenStreetMap tiles.

Author

renderd was written by Jon Burgess, and other OpenStreetMap project members. This manual page was written by OpenStreetMap authors. mod_tile v0.8.0 2024-06-06 RENDERD.CONF(5)

Description

This manual page documents briefly the renderd.conf configuration file. renderd.conf is an INI configuration file for use with renderd(1). The default location is '/etc/renderd.conf' (macro definition 'RENDERD_CONFIG'). All option names are case-insensitive.

Map Section

Options belonging a [map] section. There must be at least one [map] section. [map] section names can neither begin with [renderd] nor be equal to [mapnik]. [map] section names can be anything else, but they must all be unique. aspectx Specify the X aspect to be used by mod_tile. Only used by mod_tile. The default value is '1'. aspecty Specify the Y aspect to be used by mod_tile. Only used by mod_tile. The default value is '1'. attribution Specify the data attribution to be provided by mod_tile as TileJSON (via {URI}/tile-layer.json). Only used by mod_tile. The default value is '&copy;<ahref=\\\"http://www.openstreetmap.org/\\\">OpenStreetMap</a>and<ahref=\\\"http://wiki.openstreetmap.org/wiki/Contributors\\\">contributors</a>,<ahref=\\\"http://opendatacommons.org/licenses/odbl/\\\">(ODbL)</a>' (macro definition 'DEFAULT_ATTRIBUTION'). cors Specify the CORS configuration for mod_tile. Only used by mod_tile. description Specify the description to be provided by mod_tile as TileJSON (via {URI}/tile-layer.json). Only used by mod_tile. htcphost Specify the IP address/hostname of the HTCP Host to be used by renderd for HTCP cache expiry. Only used by renderd. host Specify the IP address/hostname of the Host to be used by renderd for HTCP cache expiry. Only used by renderd. maxzoom Specify the maximum zoom level for this section. The default value is '20' (macro definition 'MAX_ZOOM'). minzoom Specify the minimum zoom level for this section. The default value is '0'. parameterize_style Specify the parameterization style/function to be used for this section. The value of 'language' seems to be the only one supported. server_alias Specify a URL alias of this server to be provided by mod_tile as TileJSON (via {URI}/tile-layer.json). Only used by mod_tile. scale Specify the scale for this section. Only used by renderd. The default value is '1.0'. tiledir Specify the directory path into which tiles will be written by renderd. The default value is '/var/cache/renderd/tiles' (macro definition 'RENDERD_TILE_DIR'). tilesize Specify the tile size for this section. Only used by renderd. The default value is '256'. type Specify the tile configuration (in the format '<extension><mime-type><output-format>') for this section (e.g. 'pngimage/pngpng256'). uri Specify the URI prefix with which tiles can be accessed for this section. xml Specify the file path of the Mapnik configuration XML file for this section. Only used by renderd.

Mapnik

Options belonging to the [mapnik] section. There can be only one [mapnik] section. [mapnik] section name must be equal to [mapnik]. font_dir Specify the directory path where fonts are searched for by libmapnik. The default value is the output of 'mapnik-config--fonts' / 'pkgconf--variable=fonts_dirlibmapnik' (macro definition 'MAPNIK_FONTS_DIR'). font_dir_recurse Specify whether or not to recurse the font_dir when searching for fonts by libmapnik. The default value is 'false' / '0' (macro definition 'MAPNIK_FONTS_DIR_RECURSE'). plugins_dir Specify the directory path where input plugins are searched for by libmapnik. The default value is the output of 'mapnik-config--input-plugins' / 'pkgconf--variable=plugins_dirlibmapnik' (macro definition 'MAPNIK_PLUGINS_DIR').

Name

renderd.conf - Configuration file of rendering daemon for rendering OpenStreetMap tiles.

Renderd

Options belonging to a [renderd] section. There must be at least one [renderd] section (e.g. [renderd] or [renderd0]). By default, there can be up to 5 (macro definition 'MAX_SLAVES') [renderd] sections (e.g. [renderd0] - [renderd4]). [renderd] section names must begin with [renderd]. iphostname Specify the IP address/hostname to be used for communication with renderd. This must be specified in combination with ipport. This option and socketname are mutually exclusive. ipport Specify the port number to be used for communication with renderd. This must be specified in combination with iphostname. This option and socketname are mutually exclusive. num_threads Specify the number of threads to be used for renderd. A value of '-1' will configure num_threads to the number of cores on the system. The default value is '4' (macro definition 'NUM_THREADS'). pid_file Specify the file path into which the PID will be written by renderd. It is only written to when renderd is not running in foreground mode (e.g. without '--foreground' / '-f'). The default value is '/run/renderd/renderd.pid' (macro definition 'RENDERD_PIDFILE'). socketname Specify the file path to be used as a unix domain socket for communication with renderd. This option and iphostname / ipport are mutually exclusive. The default value is '/run/renderd/renderd.sock' (macro definition 'RENDERD_SOCKET'). stats_file Specify the file path into which statistics will be written by renderd. By default, a stats file will not be created. tile_dir Specify the directory path into which tiles will be written by renderd. The default value is '/var/cache/renderd/tiles' (macro definition 'RENDERD_TILE_DIR').

See Also

renderd(1)

Synopsis

renderd.conf

See Also