docs: toc & mention compressed version

- remove old announcement
This commit is contained in:
Ming Di Leom 2022-11-01 08:22:53 +00:00
parent 6899d6a569
commit 5a0f632495
No known key found for this signature in database
GPG Key ID: 32D3E28E96A695E8
2 changed files with 36 additions and 3 deletions

View File

@ -1,6 +1,26 @@
# PUP Domains Blocklist
> Announcement (2022/05/21): curben.gitlab.io has been migrated to malware-filter.gitlab.io
- Formats
* [URL-based](#url-based)
* [Domain-based](#domain-based)
* [Hosts-based](#hosts-based)
* [Domain-based (AdGuard Home)](#domain-based-adguard-home)
* [URL-based (AdGuard)](#url-based-adguard)
* [URL-based (Vivaldi)](#url-based-vivaldi)
* [Dnsmasq](#dnsmasq)
* [BIND zone](#bind)
* [RPZ](#response-policy-zone)
* [Unbound](#unbound)
* [dnscrypt-proxy](#dnscrypt-proxy)
* [Tracking Protection List (IE)](#tracking-protection-list-ie)
* [Snort2](#snort2)
* [Snort3](#snort3)
* [Suricata](#suricata)
- [Compressed version](#compressed-version)
- [Reporting issues](#issues)
- [FAQ and Guides](#faq-and-guides)
- [CI Variables](#ci-variables)
- [License](#license)
A blocklist of domains that host potentially unwanted programs (PUP), based on the [malware-discoverer](https://github.com/zhouhanc/malware-discoverer). Blocklist is updated twice a day.
@ -434,6 +454,13 @@ rule-files:
</details>
## Compressed version
All filters are also available as gzip- and brotli-compressed.
Gzip: https://malware-filter.gitlab.io/malware-filter/pup-filter.txt.gz
Brotli: https://malware-filter.gitlab.io/malware-filter/pup-filter.txt.br
## Issues
This blocklist operates by blocking the **whole** website, popular websites are excluded from the filters.
@ -448,6 +475,13 @@ This blocklist **only** accepts new malicious URLs from [malware-discoverer](htt
See [wiki](https://gitlab.com/malware-filter/malware-filter/-/wikis/home)
## CI Variables
Optional variables:
- `CLOUDFLARE_BUILD_HOOK`: Deploy to Cloudflare Pages.
- `NETLIFY_SITE_ID`: Deploy to Netlify.
## License
[src/](src/): [CC0](LICENSE.md)

View File

@ -87,8 +87,7 @@ THIRD_LINE="! Expires: 1 day (update frequency)"
FOURTH_LINE="! Homepage: https://gitlab.com/malware-filter/pup-filter"
FIFTH_LINE="! License: https://gitlab.com/malware-filter/pup-filter#license"
SIXTH_LINE="! Source: https://github.com/zhouhanc/malware-discoverer"
ANNOUNCEMENT_1="\n! Announcement (2022/05/21): curben.gitlab.io has been migrated to malware-filter.gitlab.io"
COMMENT_UBO="$FIRST_LINE\n$SECOND_LINE\n$THIRD_LINE\n$FOURTH_LINE\n$FIFTH_LINE\n$SIXTH_LINE\n$ANNOUNCEMENT_1"
COMMENT_UBO="$FIRST_LINE\n$SECOND_LINE\n$THIRD_LINE\n$FOURTH_LINE\n$FIFTH_LINE\n$SIXTH_LINE"
mkdir -p "../public/"