minio/docs/disk-caching
Harshavardhana 228c8f05f4 Improve some wording in disk caching docs (#5730) 2018-03-29 10:12:14 +05:30
..
DESIGN.md Improve some wording in disk caching docs (#5730) 2018-03-29 10:12:14 +05:30
README.md Improve some wording in disk caching docs (#5730) 2018-03-29 10:12:14 +05:30

README.md

Disk Cache Quickstart Guide Slack

Disk caching feature here refers to the use of caching disks to store content closer to the tenants. For instance, if you access an object from a lets say gateway azure setup and download the object that gets cached, each subsequent request on the object gets served directly from the cache drives until it expires. This feature allows Minio users to have

  • Object to be delivered with the best possible performance.
  • Dramatic improvements for time to first byte for any object.

Get started

1. Prerequisites

Install Minio - Minio Quickstart Guide.

2. Run Minio with cache

Disk caching can be enabled by updating the cache config settings for Minio server. Config cache settings takes the drive locations, cache expiry duration (in days) and any wildcard patterns to exclude from being cached.

"cache": {
	"drives": ["/drive1", "/drive2", "/drive3"],
	"expiry": 90,
	"exclude": ["*.pdf","mybucket/*"]
},

The cache settings may also be set through environment variables. When set, environment variables override any cache config settings for Minio server. Following example uses /drive1, /drive2 and /drive3 for caching, with expiry upto 90 days while excluding all objects under bucket mybucket and all objects with '.pdf' as extension while starting a standalone erasure coded setup.

export MINIO_CACHE_DRIVES="/drive1;/drive2;/drive3"
export MINIO_CACHE_EXPIRY=90
export MINIO_CACHE_EXCLUDE="*.pdf;mybucket/*"
minio server /export{1...24}

3. Test your setup

To test this setup, access the Minio server via browser or mc. Youll see the uploaded files are accessible from the all the Minio endpoints.

Explore Further