docs: add note about limitation of host-based-only blocker

ref: 5beecca906
This commit is contained in:
curben 2019-05-11 19:35:19 +09:30
parent 5beecca906
commit 678b440865
1 changed files with 5 additions and 13 deletions

View File

@ -16,16 +16,6 @@ Mirrors:
- https://glcdn.githack.com/curben/urlhaus-filter/raw/master/urlhaus-filter.txt
- https://cdn.staticaly.com/gl/curben/urlhaus-filter/raw/master/urlhaus-filter.txt
## Description
Following URL categories are removed from the database dump:
- Offline URLs
- Well-known domains from the [Umbrella Popularity List](https://s3-us-west-1.amazonaws.com/umbrella-static/index.html).
- False positives ([exclude.txt](src/exclude.txt))
Database dump is saved as [URLhaus.csv](src/URLhaus.csv), get processed by [script.sh](utils/script.sh) and output as [urlhaus-filter.txt](urlhaus-filter.txt).
## Compatibility
This filter is only tested with uBO. [FilterLists](https://filterlists.com/) shows it is compatible with the following software:
@ -40,11 +30,13 @@ This filter is only tested with uBO. [FilterLists](https://filterlists.com/) sho
- [Samsung Knox](https://www.samsungknox.com/)
- [uMatrix](https://github.com/gorhill/uMatrix)
Note that some of the software above are host-based only, meaning it cannot block malware URLs hosted by well-known domains (e.g. amazonaws.com, docs.google.com, dropbox.com). For best compatibility, use uBO or its fork NanoAdblocker.
## Issues
Report any false positive by creating an [issue](https://gitlab.com/curben/urlhaus-filter/issues).
Report any false positive by creating an [issue](https://gitlab.com/curben/urlhaus-filter/issues) or [merge request](https://gitlab.com/curben/urlhaus-filter/merge_requests)
This filter **only** accepts malware URLs from the [URLhaus](https://urlhaus.abuse.ch/).
This filter **only** accepts malware URLs from [URLhaus](https://urlhaus.abuse.ch/).
Please report new malware URL to the upstream maintainer through https://urlhaus.abuse.ch/api/#submit.
@ -54,7 +46,7 @@ This repo is not endorsed by Abuse.sh.
Since the filter is updated frequently, cloning the repo would become slower over time as the revision grows.
Use shallow clone to get the recent revisions only. Getting the last five revisions is sufficient for a valid MR.
Use shallow clone to get the recent revisions only. Getting the last five revisions should be sufficient for a valid MR.
`git clone --depth 5 https://gitlab.com/curben/urlhaus-filter.git`