mirror of
				https://github.com/uklans/cache-domains
				synced 2025-11-04 02:08:53 +01:00 
			
		
		
		
	Merge pull request #111 from marcusboon/master
Fixes 110: Change example from origin to steam
This commit is contained in:
		
						commit
						698914d22c
					
				
							
								
								
									
										25
									
								
								README.md
									
									
									
									
									
										
										
										Normal file → Executable file
									
								
							
							
						
						
									
										25
									
								
								README.md
									
									
									
									
									
										
										
										Normal file → Executable file
									
								
							@ -14,21 +14,20 @@ You can use this list one of two ways:
 | 
			
		||||
There is a cache_domains.json file to define CDNs and additional meta deta with the following structure
 | 
			
		||||
 | 
			
		||||
- cache_domains: Array of cache_domain object
 | 
			
		||||
	- name: shortname for the cache domain. Should match `^[0-9A-Za-z]$`
 | 
			
		||||
	- description: a longer description to aid others in identifying what this domain does (not all users of this repo will want to enable all caches)
 | 
			
		||||
	- notes: implementation specific notes which may be useful for other users
 | 
			
		||||
	- domain_files: array of files within the repo assosciated to the cdn. Most cdn's only need one file
 | 
			
		||||
	- Example domain entry for origin
 | 
			
		||||
    - name: shortname for the cache domain. Should match `^[0-9A-Za-z]$`
 | 
			
		||||
    - description: a longer description to aid others in identifying what this domain does (not all users of this repo will want to enable all caches)
 | 
			
		||||
    - notes: implementation specific notes which may be useful for other users
 | 
			
		||||
    - domain_files: array of files within the repo assosciated to the cdn. Most cdn's only need one file
 | 
			
		||||
    - Example domain entry for steam
 | 
			
		||||
```json
 | 
			
		||||
{
 | 
			
		||||
	"cache_domains": [
 | 
			
		||||
		{
 | 
			
		||||
			"name": "origin",
 | 
			
		||||
			"description": "CDN for origin",
 | 
			
		||||
			"notes": "Should be enabled for HTTP traffic only or with a HTTPS proxy else origin client download fails",
 | 
			
		||||
			"domain_files": ["origin.txt"]
 | 
			
		||||
		}
 | 
			
		||||
	]
 | 
			
		||||
    "cache_domains": [
 | 
			
		||||
        {
 | 
			
		||||
            "name": "steam",
 | 
			
		||||
            "description": "CDN for steam platform",
 | 
			
		||||
            "domain_files": ["steam.txt"]
 | 
			
		||||
        }
 | 
			
		||||
    ]
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
		Loading…
	
		Reference in New Issue
	
	Block a user