Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
26 changed files
with
1,885 additions
and
177 deletions.
There are no files selected for viewing
614 changes: 484 additions & 130 deletions
614
PyFunceble/data/infrastructure/.PyFunceble_production.yaml
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| - [](index.md) | ||
| - [`cli_decoding`](cli-decoding.md) | ||
| - [`cli_testing`](cli-testing.md) | ||
| - [`collection`](collection.md) | ||
| - [`debug`](debug.md) | ||
| - [`dns`](dns.md) | ||
| - [`http_codes`](http-codes.md) | ||
| - [`links`](links.md) | ||
| - [`lookup`](lookup.md) | ||
| - [`max_http_retries`](max-http-retries.md) | ||
| - [`proxy`](proxy.md) | ||
| - [`share_logs`](share-logs.md) | ||
| - [`user_agent`](user-agent.md) | ||
| - [`verify_ssl_certificates`](verify-ssl-certificates.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| # `cli_decoding` | ||
|
|
||
| When using the CLI, you can use some of the parameters listed below to control | ||
| the way inputed files are being decoded or interpreted. | ||
|
|
||
| ## Overview | ||
|
|
||
| ```yaml title=".PyFunceble.overwrite.yaml" | ||
| cli_decoding: | ||
| # Provides everything related to the decoding of input files from the CLI. | ||
|
|
||
| # Enable/Disable the aggressive decoding. | ||
| # | ||
| # The aggressive mode is a mode that tries to decode as much as possible without | ||
| # trying to follow any technical conventions. | ||
| # | ||
| # When decoding AdBlock filter lists, it will try to decode almost every | ||
| # domains it finds. | ||
| # | ||
| # When decoding hosts file or plain text files, it will try to convert URLS | ||
| # (e.g https://example.org/hello/world) into domains to test (e.g example.org). | ||
| # | ||
| # CLI Argument: --aggressive | ||
| aggressive: no | ||
|
|
||
| # Enable/Disable the (exclusive) decoding using the adblock decoder. | ||
| # | ||
| # WARNING: | ||
| # Activating this parameter in your configuration file, will make | ||
| # PyFunceble assume that it has to decode adblock files - exclusively. | ||
| # | ||
| # CLI Argument: --adblock | ||
| adblock: no | ||
|
|
||
| # Enable/Disable the (exclusive) decoding using the RPZ decoder. | ||
| # | ||
| # WARNING: | ||
| # Activating this parameter in your configuration file, will make | ||
| # PyFunceble assume that it has to decode RPZ files - exclusively. | ||
| # | ||
| # CLI Argument: --rpz | ||
| rpz: no | ||
|
|
||
| # Enable or disable the reduction of wildcards. | ||
| # | ||
| # Meaning that any caught wildcards (e.g. *.example.org) will be reduced so | ||
| # that we have a "valid" domain to test (e.g. example.org). | ||
| # | ||
| # WARNING: | ||
| # Activating this parameter will reduce wildcards (e.g *.example.org) to | ||
| # match domains (e.g ecample.org) | ||
| # | ||
| # CLI Argument: --wildcard | ||
| wildcard: no | ||
| ``` | ||
|
|
||
| ## `aggressive` | ||
|
|
||
| Enable or disable the aggressive mode. The aggressive mode is a mode that tries | ||
| to decode as much as possible without trying to follow any technical conventions. | ||
|
|
||
| When using this parameter while decoding AdBlock filter lists, it will try to | ||
| decode almost every domains it finds. | ||
|
|
||
| However, when using this parameter while decoding hosts or plain lists, it will | ||
| also convert URLs (e.g `https://example.com/hello/world`) into domains to test | ||
| (e.g `example.com`). | ||
|
|
||
| **Type:** boolean | ||
|
|
||
| **Default Value:** `no` | ||
|
|
||
| **Available Values:** `yes`, `no` | ||
|
|
||
| **CLI Argument:** `--aggressive` | ||
|
|
||
| ## `adblock` | ||
|
|
||
| Enable or disable the (exclusive) decoding of AdBlock filter lists. | ||
|
|
||
| !!! danger "Beware!!!!" | ||
|
|
||
| If you choose to activate this parameter in your configuration file, | ||
| PyFunceble will assume that any inputed files are AdBlock filter lists to | ||
| decode. | ||
|
|
||
| **Type:** boolean | ||
|
|
||
| **Default Value:** `no` | ||
|
|
||
| **Available Values:** `yes`, `no` | ||
|
|
||
| **CLI Argument:** `--adblock` | ||
|
|
||
| ## `rpz` | ||
|
|
||
| Enable or disable the (exclusive) decoding of RPZ files. | ||
|
|
||
| !!! danger "Beware!!!!" | ||
|
|
||
| If you choose to active this parameter in your configuration file, | ||
| PyFunceble will assume that any inputed files are RPZ files to decode. | ||
|
|
||
| **Type:** boolean | ||
|
|
||
| **Default Value:** `no` | ||
|
|
||
| **Available Values:** `yes`, `no` | ||
|
|
||
| **CLI Argument:** `--rpz` | ||
|
|
||
| ## `wildcard` | ||
|
|
||
| Enable or disable the reduction of wildcards. Meaning that any caught wildcards | ||
| (e.g. \*.example.org) will be reduced so that we have a "valid" domain to test | ||
| (e.g. example.org). | ||
|
|
||
| **Type:** boolean | ||
|
|
||
| **Default Value:** `no` | ||
|
|
||
| **Available Values:** `yes`, `no` | ||
|
|
||
| **CLI Argument:** `--wildcard` |
Oops, something went wrong.