Disk :: tilegroxy Docs

Description

Tilegroxy doesn’t form clusters so a high-availability deployment with this cache pointing to a local filesystem will lead to inconsistent behaviour.

No automatic cleanup process is included inside of tilegroxy itself. It is recommended you use an external job to avoid running out of disk space.

How entries are arranged on disk is controlled by layout. Sub-directories are created as tiles are cached. Layer names are sanitized by replacing potentially dangerous characters with an underscore. This can lead to exotically named layers colliding. Be cognizant of that risk when using this cache.

Cache entries are written to a temporary file (in the same directory) and then renamed, so an interrupted write won’t leave partial files behind. The temp files should get automatically removed, but if you see any old files ending with .tmp, feel free to clean them up.

Example

YAML
JSON

cache:
  name: disk
  path: ./disk_tile_cache

{
  "cache": {
    "name": "disk",
    "path": "./disk_tile_cache"
  }
}

Configuration

Parameter Description Type Required Default

Parameter	Description	Type	Required	Default
`path`	The absolute path to the directory to store cache entries within. Directory (and tree) will be created if it does not already exist	string	Yes	None
`filemode`	The permissions to use for all created files/directories. Either a unix octal string such as `"0644"` or a Go filemode as an integer. In YAML an unquoted number with a leading zero such as `0644` is also read as octal, but JSON has no octal numbers so use the string form there	string or uint32	No	0777
`layout`	How cache entries are arranged within `path`. Either `flat` for one file per entry directly inside the directory, or `coordinate` for a `layer/z/x/y` directory tree	string	No	flat

path

The absolute path to the directory to store cache entries within. Directory (and tree) will be created if it does not already exist

string

Yes

None

filemode

The permissions to use for all created files/directories. Either a unix octal string such as "0644" or a Go filemode as an integer. In YAML an unquoted number with a leading zero such as 0644 is also read as octal, but JSON has no octal numbers so use the string form there

string or uint32

0777

layout

How cache entries are arranged within path. Either flat for one file per entry directly inside the directory, or coordinate for a layer/z/x/y directory tree

string

flat