This is a modernized and stripped-down version of https://github.com/cyclestreets/tilecache that also adds a seperate cron script. All files that are based on the original code are marked (
tile.php,cron.php).
This is a tile caching software written in PHP to quickly setup your own intermediary cache for OpenStreetMap tiles. In our production use case, we cache the tiles for a long time. Caching for shorter times (e.g. a couple of days instead of >1 month) my lead to worse performance.
Only the tile retrieval is handled by PHP, subsequent requests are served directly by the HTTP server.
- PHP 8.2+ with cURL library
- Apache HTTP Server, although using nginx should be working fine if you adapt the config file.
- Enough storage for the tiles (depending on the cache duration in the order of multiple GB)
- Adjust config parameters in
config.php(rename fromconfig.sample.php). Add all layers you want to cache and specifiy all needed information about your site (e.g. User agent and Referrer that will be sent to the upstream tile provider. Note: Those settings are mandatory as many upstreams require contact information for mass downloading of tiles.) - Adjust access policy. This can be created from a mixture of two components
- Adjust allowed refererrers in
.htaccess(rename from.htaccess.sample). Some browsers do not send the Referer header, so an empty value should pass all checks. But any embedding web page can specify not to send the referer header, thus this check is not 100% reliable and can be circumvented rather easily. - Fetch metadata checks are supported by many modern browsers and cannot be spoofed by pages trying to embed tiles from the tile cache.
- Both methods can be enabled at the same time.
- Adjust allowed refererrers in
- Put an image file into
img/bg.pgthat will be shown in the background on the public landing page. - Upload all files
- Add a cron job to
cron.php(via with PHP-CLI. HTTP Crons will not work well because the runtime might get rather long)
Cleanup happens automatically via cron.