mirror of
				https://github.com/coredns/coredns.git
				synced 2025-10-30 17:53:21 -04:00 
			
		
		
		
	Add docs
Provide TTL examples for cache middleware. Fixes: #364 Add interaction docs to make non invalidation for cache middleware clear. Cache might serve stale records. Fixes: #403
This commit is contained in:
		
							
								
								
									
										10
									
								
								middleware/cache/README.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										10
									
								
								middleware/cache/README.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,6 +1,6 @@ | |||||||
| # cache | # cache | ||||||
|  |  | ||||||
| *cache* enables a frontend cache. | *cache* enables a frontend cache. It will cache all records except zone transfers and metadata records. | ||||||
|  |  | ||||||
| ## Syntax | ## Syntax | ||||||
|  |  | ||||||
| @@ -8,13 +8,15 @@ | |||||||
| cache [TTL] [ZONES...] | cache [TTL] [ZONES...] | ||||||
| ~~~ | ~~~ | ||||||
|  |  | ||||||
| * **TTL** max TTL in seconds. If not specified, the maximum TTL will be used which is 1 hour for | * **TTL** max TTL in seconds. If not specified, the maximum TTL will be used which is 3600 for | ||||||
|     noerror responses and half an hour for denial of existence ones. |     noerror responses and 1800 for denial of existence ones. | ||||||
|  |     A set TTL of 300 *cache 300* would cache the record up to 300 seconds. | ||||||
|  |     Smaller record provided TTLs will take precedence. | ||||||
| * **ZONES** zones it should cache for. If empty, the zones from the configuration block are used. | * **ZONES** zones it should cache for. If empty, the zones from the configuration block are used. | ||||||
|  |  | ||||||
| Each element in the cache is cached according to its TTL (with **TTL** as the max). | Each element in the cache is cached according to its TTL (with **TTL** as the max). | ||||||
| For the negative cache, the SOA's MinTTL value is used. A cache can contain up to 10,000 items by | For the negative cache, the SOA's MinTTL value is used. A cache can contain up to 10,000 items by | ||||||
| default. A TTL of zero is not allowed. | default. A TTL of zero is not allowed. No cache invalidation triggered by other middlewares is available. Therefore even reloaded items might still be cached for the duration of the TTL. | ||||||
|  |  | ||||||
| If you want more control: | If you want more control: | ||||||
|  |  | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user