PC-Heini/LanCache-Domains
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixes #110: Change exmaple from origin to steam

Browse Source
This commit is contained in:
Marcus Boon 2019-09-21 13:06:26 +10:00
parent 5ab391af68
commit c422436b4f
1 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md Normal file → Executable file
View 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 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 - cache_domains: Array of cache_domain object
- name: shortname for the cache domain. Should match `^[0-9A-Za-z]$` - 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) - 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 - 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 - domain_files: array of files within the repo assosciated to the cdn. Most cdn's only need one file
- Example domain entry for origin - Example domain entry for steam
```json ```json
{ {
"cache_domains": [ "cache_domains": [
{ {
"name": "origin", "name": "steam",
"description": "CDN for origin", "description": "CDN for steam platform",
"notes": "Should be enabled for HTTP traffic only or with a HTTPS proxy else origin client download fails", "domain_files": ["steam.txt"]
"domain_files": ["origin.txt"] }
} ]
]
} }
``` ```
@ -51,7 +50,7 @@ The wildcard format shall be defined as per the below
- If a wildcard is used, it should be the first character on the line. - If a wildcard is used, it should be the first character on the line.
- Wildcards are not treated as matching null, e.g. `*.example.com` will match `a.example.com` but will not match `example.com` - Wildcards are not treated as matching null, e.g. `*.example.com` will match `a.example.com` but will not match `example.com`
- Only simple domain wildcards will be accepted eg `*.example.com` not `*ww.example.com` - Only simple domain wildcards will be accepted eg `*.example.com` not `*ww.example.com`
##### Notes for Squid users ##### Notes for Squid users
If you are using these files within a squid dst_domain acl you will need to reformat the wildcard entries to be compliant with the squid acl format. The following regex should suffice `s/*\./\./` If you are using these files within a squid dst_domain acl you will need to reformat the wildcard entries to be compliant with the squid acl format. The following regex should suffice `s/*\./\./`