PyFunceble-dev 4.2.26__py3-none-any.whl → 4.2.28__py3-none-any.whl

PyFunceble/data/infrastructure/.PyFunceble_production.yaml

@@ -1,176 +1,399 @@
+# .PyFunceble.yaml
+# This is the default configuration of the PyFunceble project.
+#
+# Behavior while using CLI switch:
+#
+#   When using the CLI Argument of boolean parameters, they act like a light
+#   switch. Meaning that if `no` is defined in the configuration file, using
+#   the CLI argument will switch it to `yes`.
+#
+#   However, if `yes` is defined in the configuration file, using the CLI
+#   argument will switch it to `no`.
+#
+
 debug:
   # Provides everything related to the debug mode.
 
-  # Activates the debug/logging.
+  # Enable/Disable the debug mode.
+  #
+  # NOTE:
+  #   When enabled, the output will be found inside the logs output directory.
+  #   If you prefer to have the output to STDOUT, you should declare the
+  #   following environment variable.
+  #
+  #     PYFUNCEBLE_DEBUG_ON_SCREEN=yes
+
+  # Environment Variable: PYFUNCEBLE_DEBUG
+  # CLI Switch: `--debug`
   active: no
-  # Sets the logging level.
+
+  # Set the logging level.
+  #
+  # Available: info, error, debug, critical
+  #
+  # Environment Variables: PYFUNCEBLE_DEBUG_LVL | PYFUNCEBLE_LOGGING_LVL
+  # CLI Switch: --logging-level
   level: info
 
 cli_decoding:
-  # Provides everything related to the decoding from the CLI.
+  # Provides everything related to the decoding of input files from the CLI.
 
-  # Activates the aggressive decoding.
+  # 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
 
-  # Activates the decoding using the adblock decoder.
+  # 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
 
-  # Activates the decoding using the RPZ decoder.
+  # 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
 
-  # Activated the decoding using the Wildcard decoder.
+  # 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
 
 cli_testing:
-  # Provides everything directly related to the CLI testing.
+  # Provides everything directly related to the testing through the CLI.
 
-  # Sets the Hosts IP to use while generation the hosts file(s)
+  # Set the IP to prefix each hosts file lines with.
+  #
+  # CLI Argument: -ip | --hosts-ip
   hosts_ip: "0.0.0.0"
 
-  # Sets the number of maximal workers to use.
-  # If set to null, the system use: CPU * Cores - 2
+  # Set the amount of maximal workers to use to perform tests.
+  #
+  # NOTE:
+  #     If set to `null`, the value is implicitly CPU * Cores - 2
+  #
+  # CLI Argument: -w | --max-workers
   max_workers: null
 
-  # Activates the automatic continuation after a break or shortage.
+  # Enable/Disable the autocontinue datasets.
+  #
+  # The autocontinue datasets/database is a database that temporarily store the
+  # result of the tested subject in the hope to continue as soon as possible
+  # after a break or shortage.
+  #
+  # CLI Argument: -c | --auto-continue | --continue
   autocontinue: no
 
-  # Activates the storage and creation of a database of all INACTIVA and INVALID
-  # subjects for continuous testing.
+  # Enable/Disable the inactive datasets.
+  #
+  # The inactive datasets/database is used to store the INACTIVE and INVALID
+  # subjects to purposely retest then at a later time.
+  #
+  # This mechanism let you cleanup your source file while being sure that
+  # pyfunceble will retest the old entries of your source file. After retesting,
+  # pyfunceble will throw the newly ACTIVE subject from the database and put
+  # it into your ACTIVE output files so that you can reintroduce them into
+  # your list.
+  #
+  # CLI Argument:  --inactive-db
   inactive_db: yes
 
-  # Activates the storage of some WHOIS information in order to avoid having
-  # to spam the WHOIS servers.
+  # Enable/Disable the whois storage of whois records.
+  #
+  # This mechanism let us avoid spaming the WHOIS servers by storing the
+  # expiration dates from the whois record into a local datasets/database.
+  # Later on, PyFunceble will query the local database first.
+  #
+  # CLI Argument: -wdb | --whois-database
   whois_db: yes
 
-  # Activates the generation of complements.
+  # Enable/Disable the testing and generation of complements.
+  #
+  # A complement is `www.example.org` when `example.org` is given and vice-versa.
+  #
+  # CLI Argument: --complements
   complements: no
 
-  # Activates the expansion of CIDR to single addresses.
+  # Enable/Disable the expension and testing of single addresses of a CIDR.
+  #
+  # CLI Argument: --cidr
   cidr_expand: no
 
-  # Sets the cooldown time to apply between each tests.
+  # Set the cooldown time to apply between each tests.
+  #
+  # This is essential to avoid spaming remote resources - especially WHOIS servers.
+  #
+  # WARNING:
+  #     This must be a value >= 0.0
+  #
+  # CLI Argument: --cooldown-time
   cooldown_time: 0.0
 
   # Sets the Database Connector type to use.
   # Available: csv | mariadb | mysql | postgresql
+  #
+  # Set the type of database to use or generate to store long term information-s.
+  #
+  # When set to `mariadb`, `mysql` or `postgesql` the following environment
+  # variables are required.
+  #
+  #     PYFUNCEBLE_DB_HOST - The host or unix socket path of the database server.
+  #     PYFUNCEBLE_DB_PORT - The port to use to reach the database server.
+  #     PYFUNCEBLE_DB_USERNAME - The username to use to connect to the database server - when applicable.
+  #     PYFUNCEBLE_DB_PASSWORD - The password to use to connect to the database server - when applicable.
+  #     PYFUNCEBLE_DB_NAME - The name of the database to work with.
+  #     PYFUNCEBLE_DB_CHARSET - The charset to use - when applicable.
+  #
+  # Available Values: csv | mariadb | mysql | postgresql
+  #
+  # CLI Argument: --database-type
   db_type: csv
 
-  # Sets the filter to apply while reading the given input.
-  # For example, if you give `\.info`, we will only test the subjects who match
-  # `\.info`.
+  # Set the filter to apply while reading inputs.
+  #
+  # In other words, a global filter to apply to select the subject to tests.
+  # Meaning that if you give `\.info$` (for example), we will only test the
+  # subjects that ends with `.info`.
+  #
+  # CLI Argument: --filter
   file_filter: null
 
-  # Activates the mining of data.
+  # Enable/Disable the mining of subjects.
+  #
+  # When enabled, PyFunceble will follow the HTTP redirects and put all redirected
+  # subjects into the testing queue and outputs.
+  #
+  # CLI Argument: --mining
   mining: no
 
-  # Acknowledges that we may test for local network component.
-  # NOTE: Activating this, will remove the syntax checker completely.
+  # Acknowledge/Dismiss that we are testing for subjects that are only on the
+  # local network.
+  #
+  # NOTE:
+  #     When enabled, no syntax checking will be processed when performing
+  #     availability and reputation tests.
+  #
+  # CLI Argument: --local
   local_network: no
 
-  # Activates or disable the preloading of the given input file(s).
-  # When this is activated, we take the time to pre load and decode the content
-  # of your file so that we can optimize some of our process regarding the
-  # auto continue.
+  # Enable/Disable the preloading of the given input file(s).
+  #
+  # When enabled, we take the time to pre-load subjects by decoding inputs files
+  # and storing the informatino in the chosen datasets/database format.
+  # The hope is to optimise some of our process by only focusing on testing.
   #
-  # Note: This has no effect if the auto-continue is deactivated.
+  # WARNING:
+  #     While this is helpful for long running tasks, this might not be a good
+  #     idea if you are testing a URL directly. This process is not optimizied
+  #     for sources that are constantly updated (checksums).
+  #
+  # CLI Argument: --preload
   preload_file: no
 
-  # Activates or disables a chancy tester mode that unleashes the safety
-  # workflow in place.
+  # Enable/Disable a chancy testing mode that unleashes and bypass the safety
+  # workflow-s in place in hope of speed.
   #
-  # WARNING:
-  #   You shouldn't have to use this unless you feel really lucky and trust your
-  #   machine.
+  # DANGER / WARNING:
+  #     You have been warned. This mode is for the chancy and lucky one.
+  #
+  #     You shouldn't use this unless you fele really, really, really lucky and
+  #     trust your machine.
+  #
+  #     Enabling this mode makes thinks look 'fast', but it may produce some
+  #     rather ... unexpected behavior and results - IF N+1 process simultaneously
+  #     write the same output file.
   #
-  #   This mode makes things look 'fast', but it may produce some unexpected
-  #   results if :code:`N` process simultaneously write the same output file.
+  #     This mode also makes the CLI terminal output unparsable - either.
   #
-  #   This mode makes the graphical CLI output unparsable - either.
+  #     **MAY THE FORCE BE WITH YOU!**
   #
-  #   **MAY THE FORCE BE WITH YOU!**
+  # CLI Argument: --chancy
   chancy_tester: no
 
   ci:
-    # Provides everything related to the Continuous integration.
-
-    # Activates the continuous integration mode.
-    # WARNING: Do not activate without asking or knowing what you are doing.
+    # Provides everything related to the testing within a Continuous integration
+    # engine.
+
+    # Enable/Disable the CI/CD mode.
+    #
+    # When enabled, PyFunceble will assume that it works with a git repository.
+    # Therefore, you have to declare the following environment variables to
+    # configure git for pushing - which is normally not available withing a
+    # CI engine.
+    #
+    #       GIT_NAME - The `git.name` to setup and use.
+    #       GIT_EMAIL - The `git.email` to setup and use.
+    #       GIT_BRANCH - (optional) - The git branch to use to distribute results betwen sessions.
+    #       GIT_DISTRIBUTION_BRANCH - (optional) - The git branch to use to distribute the final results.
+    #       GITHUB_TOKEN - The token to use to authenticate ourselves against GitHub. Read when under a GitHub Action or Jenkins CI worker.
+    #       GL_TOKEN - The token to use to authenticate ourselves againt GitLab. Read when under a GitLab Runner.
+    #       GH_TOKEN - The token to ue to authenticate ourselves against GitHub. Read when under a Travis CI instance.
+    #
+    # CLI Argument: --ci
     active: no
 
-    # Sets the commit message to apply everytime except for the last one.
+    # Set the commit message to apply to all results commit except the final one.
+    #
+    # CLI Argument: --ci-commit-message
     commit_message: "PyFunceble - AutoSave"
 
-    # Sets the commit message to apply at the very end of the test.
+    # Set the commit message to apply to the very last and final result commit.
+    #
+    # CLI Argument: --ci-end-commit-message
     end_commit_message: "PyFunceble - Results"
 
-    # Sets the number of minutes  to wait before starting to save and stop
-    # a session.
+    # Set the number of minutes to wait before to start saving and stopping a session.
+    #
+    # This parameter can be understood as the running time of PyFunceble under a
+    # CI Engine.
+    #
+    # CLI Argument: --ci-max-minutes
     max_exec_minutes: 15
 
-    # Sets the working branch. This is the branch from where we are testing.
+    # Set the branch to use to distribute results between multiple CI/CD sessions.
+    #
+    # Environment Variable: GIT_BRANCH
+    # CLI Argument: --ci-branch
     branch: master
 
-    # Sets the distribution branch. This is the branch that is going to get
-    # the (final) results.
+    # Set the branch to use to distribute the final results of multiple CI/CD session.
+    #
+    # Environment Variable: GIT_DISTRIBUTION_BRANCH
+    # CLI Argument: --ci-distribution-branch
     distribution_branch: master
 
-    # Sets the command to execute everytime before each commits except the last
-    # one.
+    # Set the command to execute before each (except last) result commit.
+    #
+    # CLI Argument: --ci-command
     command: null
 
-    # Sets the command to execute before the last commit.
+    # Set the command to execute before the very last result commit.
+    #
+    # CLI Argument: --ci-end-command
     end_command: null
 
   display_mode:
-    # Provides everything related to the display mode.
-
-    # Activates the printing of dots.
+    # Provides everything related to the display/OUTPUT of PyFunceble.
+
+    # Enable/Disable the printing of dots.
+    #
+    # Dots !? Why Dots ? WTH ?!
+    #   Yes, you read correctly dots. Those dots are crutial under CI/CD engines
+    #   that assumes that no-output within a few minutes is an error. To avoid
+    #   such situation when the CI/CD engines just kill the job, we print dots,
+    #   when we perform some tasks that may not output anything for a few minutes.
+    #
+    #   An example is when you are on the second session of testing and PyFunceble
+    #   is going through the list of subjects but it sees that the subject has been
+    #   already tested.
+    #
+    # NOTE:
+    #   This argument is automatically switched to `yes` when under a CI/CD engine
+    #   (aka cli_testing.ci set to yes).
+    #
+    # CLI Argument: --dots
     dots: no
 
-    # Activates the printing of the execution time.
+    # Enable/Disable the printing of the execution time at the end of a test session.
+    #
+    # CLI Argument: -ex | --execution
     execution_time: no
 
-    # Activates the output of the percentage information.
+    # Enable/Disable the printing of the percentage stats per status at the end
+    # of a test session.
+    #
+    # CLI Argument: --percentage
     percentage: yes
 
-    # Activates the output of the top registrar information.
+    # Enable/Disable the printing of the registrar stats per subjects at the end
+    # of a test session.
+    #
+    # CLI Argument: --registrar
     registrar: no
 
-    # Activates the quiet mode.
+    # Enable/Disable the printing of any outputs.
+    #
+    # CLI Argument: -q | --quiet
     quiet: no
 
-    # Activates the output of very few information.
+    # Enable/Disable the printing of minimal tabular information when testing.
     less: yes
 
-    # Activates the output of all information.
+    # Enable/Disable the printing of most tabular information when testing.
+    #
+    # CLI Argument: -a | --all
     all: no
 
-    # Activates the output of the status and it's status (only)
+    # Enable/Disable the printing of an extreme simple and minimalistic information
+    # when testing.
+    #
+    # CLI Argument: -s | --simple
     simple: no
 
-    # Activates the coloration of stdout.
+    # Enable/Disable the printing of colored tabular information.
+    #
+    # CLI Argument: --colour | --color
     colour: yes
 
-    # Sets the status do display to STDOUT.
-    # NOTE: This does not have any effect with the generated files.
-    # Available values: ALL | ACTIVE | INACTIVE | INVALID | SANE | MALICIOUS
+    # Set the status to display to STDOUT.
+    #
+    # WARNING:
+    #   When this parameter is not set to `ALL`, only the subjects matching the
+    #   selected status will be printed to STDOUT. Howerver, this doesn't have
+    #   any effect on the generated files.
+    #
+    # CLI Argument: --display-status
     status: all
 
-    # Sets the maximum number of registrar to display.
-    # NOTE: This does not have any effect with the generated files.
+    # Set the maximal number of registrar to display when we have to print the
+    # registrar stats per subject.
+    #
+    # NOTE:
+    #   This doesn't have any effect on the generated files.
+    #
+    # CLI Argument: --max-registrar
     max_registrar: 15
 
   testing_mode:
-    # Provides all available testing modes.
-    # WARNING: Only one can be used at a time.
+    # Provides and select the testing mode.
+    #
+    # NOTE:
+    #   Only one can be active at a time.
 
-    # Activates the availability test.
+    # Enable/Disable the availability test mode.
     availability: yes
 
-    # Activates the syntax test.
+    # Enable/Disable the syntax test mode.
+    #
+    # CLI Argument: --syntax
     syntax: no
 
-    # Activates the reputation test.
+    # Enable/Disable the reputation test mode.
+    #
+    # CLI Argument: --reputation
     reputation: no
 
     # BETA: Activates the platform contribution test.
@@ -182,121 +405,218 @@ cli_testing:
     # NOT IMPLEMENTED (Anticipation for future usage).
     db_clean: 28
 
-    # Provides the number of days to wait before retesting subject which were
-    # stored into the inactive database.
+    # Set the minimal number of days between the retest of subject which were
+    # stored into the inactive datasets/database.
+    #
+    # CLI Argument: -dbr | --days-between-db-retest
     db_retest: 1
 
   sorting_mode:
-    # Provides all our sorting mode.
-    # WARNING: The sorting mode is only applied to the files. NOT STDOUT.
-
-    # Activates the hierarchical sorting.
+    # Provides everything related to the output sorting.
+    #
+    # NOTE:
+    #   Only one can be active at a time.
+    #
+    # WARNING:
+    #   The parameters below only applies to the generated files. NOT STDOUT.
+
+    # Enable/Disable the hierarchical sorting.
+    #
+    # CLI Argument: --hierarchical
     hierarchical: no
 
-    # Activates the standard sorting.
+    # Enable/Disable the standard sorting.
     standard: yes
 
   file_generation:
-    # Provides everything related to the generation of file.
+    # Provides everything related to the generation of files.
 
-    # Deactivates the generation of any status file.
+    # Enable/Disable the generation of files.
+    #
+    # CLI Argument: --no-files
     no_file: no
 
-    # Activates the generation of the hosts file(s).
+    # Enable/Disable the generation of hosts formatted files.
+    #
+    # CLI Argument: -h | --hosts
     hosts: no
 
-    # Activates the generation of the plain (or raw) file(s).
+    # Enable/Disable the generation of plain/raw formatted files.
+    #
+    # CLI Argument: --plain
     plain: yes
 
-    # Activates the generation of the analytic file(s).
+    # Enable/Disable the generation of analytic files.
+    #
+    # Analytic ?! WTH !?
+    #   Yes, analytic! While PyFunceble is really good for a lot of things, sometime
+    #   it takes some decision without being really sure about it or without
+    #   wanting to be biased. Therefore, it generates files inside the analytic folder.
+    #   The files inside the analytic folder are there for human to analyse or
+    #   to invite the community to influence PyFunceble.
+    #
+    #   If you are sure that the behavior of PyFunceble should be adopted for sure,
+    #   fill an issue and let's evolve it together :-)
+    #
     analytic: yes
 
-    # Activate the generation of an unified file for the copy of what is
-    # outputted to STDOUT.
+    # Enable/Disable the generation of unified results files.
+    #
+    # WARNING:
+    #   This parameter simply generate a unified copy of the STDOUT instead of 1
+    #   file per status.
+    #
+    # CLI Argument: --unified-results
     unified_results: no
 
-    # Activates or disables the merging of the results of all inputted files into
-    # one single output subdirectory.
+    # Enable/Disable the merging of the results of all inputted files into one
+    # single output directory.
+    #
+    # Normally, PyFunceble generated a dedicated output folder for each inputted
+    # files. However, if you want the results to be merged inside a single
+    # folder, just switch this parameter.
+    #
+    # CLI Argument: --merge-output
     merge_output_dirs: no
 
 lookup:
-  # Provides everything related to the lookup.
+  # Provides everything related to the lookups.
 
-  # Activates the usage of the DNS lookup.
+  # Enable/Disable the usage of DNS records to lookup the status.
+  #
+  # CLI Argument: --dns-lookup
+  # Exclusive CLI Argument: --dns-lookup-only
   dns: yes
 
-  # Activates the usage of the HTTP status code lookup.
+  # Enable/Disable the usage of HTTP status codes to lookup the status.
+  #
+  # CLI Argument: --http | --http-status-code-lookup
+  # Exclusive CLI Argument: --http-only | --http-status-code-lookup
   http_status_code: yes
 
-  # Activates the usage of the network information socket.
+  # Enable/Disable the usage of network (information) socket to lookup the status.
+  #
+  # CLI Argument: --netinfo-lookup
+  # Exclusive CLI Argument: --netinfo-lookup-only
   netinfo: yes
 
-  # Activates the usage of our special rules.
+  # Enable/Disable the usage of special rules to lookup or switch the status.
+  #
+  # CLI Argument: --special-lookup
+  # Exclusive CLI Argument: --special-lookup-only
   special: yes
 
-  # Activates the usage of the WHOIS record.
+  # Enable/Disable the usage of WHOIS records to lookup the status.
+  #
+  # CLI Argument: --whois-lookup
+  # Exclusive CLI Argument: --whois-lookup-only
   whois: yes
 
-  # Activates the usage of the reputation data reputation.
+  # Enable/Disable the usage of the reputation data to lookup the status.
+  #
+  # NOTE:
+  #     The reputation lookup is actualy a lookup against the AlienVault IPv4
+  #     reputation file.s
+  #
+  # CLI Argument: --reputation-lookup
+  # Exclusive CLI Argument: --reputation-lookup
   reputation: no
 
   # Activate the usage of the platform to lookup status.
   platform: no
 
-  # Sets the timeout to apply to each of our lookup tools who support a timeout
-  # option.
+  # Set the timeout to apply to each of our lookup methods - when possible.
+  #
+  # WARNING:
+  #     This should be a value >= 0.
+  #
+  # CLI Argument: -t | --timeout
   timeout: 5
 
 dns:
-  # Provides everything related to the DNS lookup.
+  # Provides everything related to the DNS resolver & lookup.
 
-  # Activates the follow-up of the given order.
+  # Enable/Disable the follow-up of the order of DNS server.
+  #
+  # NOTE:
+  #     When disabled, the order of the DNS servers is randomized.
+  #
+  # CLI Argument: --follow-server-order
   follow_server_order: yes
 
-  # Activates the trust mode. Meaning that if one of the DNS give us a negative
-  # response (without error), we take it as it is.
-  # When this mode is deactivated (no), when one of the DNS give us a negative
-  # response (without error), we still ask all other servers.
+  # Enable/Disable the trust mode.
+  #
+  # When this parameter is enabled, we will trust the result of the first DNS
+  # server and only switch to the next server in the list ONLY when it is
+  # unreachable.
+  #
+  # However, when this parameter is disabled, we will ask the other server when
+  # the previous DNS give us a negative response - until a positive on is given.
+  #
+  # CLI Argument: --trust-dns-server
   trust_server: no
 
-  # Sets the list of server to communicate with.
-  # It must be a list.
+  # Set the list of DNS server to communicate with.
   #
   # WARNING:
   #   IPv6 should be given in this format if a port is explicitly given:
+  #
   #     [ip]:port
+  #
   #   If you omit the braket, the port will be set to the default one (53).
   #
-  # As example:
+  # Example:
   #   - first.dns
   #   - second.dns
   #
+  # CLI Argument: --dns
   server: null
 
-  # Sets the protocol to use.
-  # Available: UDP | TCP | HTTPS | TLS
+  # Set the protocol to use.
+  #
+  # Available Values: UDP | TCP | HTTPS | TLS
+  #
+  # CLI Argument: --dns-protocol
   protocol: UDP
 
-  # Sets the delay (seconds) to apply between each queries.
-  # When a value > 0.00000 is given, we will wait for the given amount of
-  # seconds between each queries.
+  # Set the delay (in second) to apply between each queries.
+  #
+  # WARNING:
+  #     This should be a value >= 0.0.
+  #
+  # CLI Argument: --dns-delay
   delay: 0.0
 
 # Not Implemented yet. Reserved for future usage and implementation.
 share_logs: no
 
 user_agent:
-  # Provides everything related to the user agent choice.
+  # Provides everything related to choice of user agent.
 
+  # Set the browser to pickup.
+  #
+  # WARNING:
+  #     This parameter will be deprecated (soon?).
+  #
+  # Available Values: chrome, edge, firefox, ie, opera, safari
   browser: chrome
+
+  # Set the platform to pickup.
+  #
+  # Available Values: linux, macosx, win10
   platform: linux
 
-  # Sets the user agent to use.
-  # WARNING: If given, this will be used systematically.
+  # Set the User-Agent to use.
+  #
+  # WARNING:
+  #     If you choose to set this argument, the browser or platform arguments
+  #     won't be taken into consideration.
+  #
+  # CLI Argument: -ua | --user-agent
   custom: null
 
 proxy:
-  # Provides everything related to the proxy.
+  # Provides everything related to the proxy usage and configuration.
   #
   # The idea:
   #   We have two main keys, "global" and "rules".
@@ -331,14 +651,20 @@ proxy:
 
   global:
     # Global HTTP proxy to use when no rule is given or matched.
+    #
+    # CLI Argument: --http-proxy
     http: null
+
     # Global HTTPS proxy to use when no rule is given or matched.
+    #
+    # CLI Argument: --https-proxy
     https: null
 
+  # The rules to apply.
+  # See example.
   rules: []
 
-
-# Activates the verification of the certificate.
+# Enable/Disable the verification of the certificate when making HTTPS requests.
 verify_ssl_certificate: no
 
 # Set the maximum number of retries to perform.
@@ -346,14 +672,19 @@ verify_ssl_certificate: no
 max_http_retries: 3
 
 http_codes:
-  # Provides everything related to the HTTP code lookup interpretation.
+  # Provides everything related to the HTTP code lookup interpolation.
 
-  # Informs PyFunceble that the end-user (not PyFunceble) is managing this list.
-  # This means that you won't get any update in this section.
+  # Stops PyFunceble self management of the list.
+  #
+  # NOTE:
+  #     This parameter is deprecated.
   self_managed: no
 
   list:
+    # Dictionary with the status codes and their interpolation.
+
     up:
+      # A list of status codes to consider as ACTIVE.
       - 100
       - 101
       - 102
@@ -369,6 +700,7 @@ http_codes:
       - 226
       - 429
     potentially_down:
+      # A list of status codes to consider as potentially INACTIVE.
       - 400
       - 402
       - 404
@@ -380,6 +712,7 @@ http_codes:
       - 416
       - 451
     potentially_up:
+      # A list of status codes to consider as potentially ACTIVE.
       - 000
       - 300
       - 301
@@ -418,32 +751,41 @@ http_codes:
       - 511
 
 links:
-  # Provides some of our API links.
-  # NOTE: Not implemented yet as the underlaying infrastructure will be
-  # rewritten.
+  # Provides some of the non hard-coded URLs.
+
+  # WARNING:
+  #     The parameters listed bellow are not implemented yet as the
+  #     underlaying infrastructure will be rewritten.
   api_date_format: "https://pyfunceble.funilrys.com/api/date-format"
   api_no_referrer: "https://pyfunceble.funilrys.com/api/no-referrer"
 
 platform:
   # Provides everything related to the platform.
+  # PyFunceble alone is a great tool. What if we could just test the subject that
+  # were not already tested by others ?
 
-  # Activates the push of dataset into the platform.
-  # WARNING: This is useless, if you don't have an API Token set as the
-  # PYFUNCEBLE_PLATFORM_API_TOKEN environment variable.
+  # Enable or disable the push of datasets (cf: test results) into the collection
+  # (API).
+  #
+  # NOTE:
+  #     This parameter is useless, unless you have a valid API Token defined
+  #     into the PYFUNCEBLE_PLATFORM_API_TOKEN environment variable.
+  #
+  # CLI Argument: --push-collection
   push: no
 
-  # Sets the preferred pull origin.
-  #
-  # When choosing `recommended`, the system will pull the recommended status
-  # that is provided and calculated by the platform.
+  # Set the preferred pull "method".
   #
-  # When choosing, `frequent`, the system will pull the most frequent status
-  # that is provided and calculated by the platform.
+  # The platform (API) does not only provides datasets but it also offer an
+  # aggregation endpoint that let PyFunceble pull datasets.
+  # When pulling information about a subject that is already known by the platform,
+  # it returns 3 group of results:
   #
-  # When choosing, `latest`, the system will pull the latest status that is
-  # provided and available into the platform.
+  #   - `frequent`, which provides the status that was mostly been pushed.
+  #   - `latest`, which provides the status based on the latest submitted datasets.
+  #   - `recommended`, which provides the recommended status.
   #
-  # Available: frequent | latest | recommended
+  # CLI Argument: --platform-preferred-origin
   preferred_status_origin: recommended
 
   # Defines the checker type to prioritize when trying to fullfil platform
@@ -465,7 +807,9 @@ platform:
   #   - syntax
   #   - reputation
   #
-  # Available: none | availability | reputation | syntax
+  # Available Values: none | availability | reputation | syntax
+  #
+  # CLI Argument: none
   checker_priority:
     - none
 
@@ -484,6 +828,8 @@ platform:
   #
   #   - reputation
   #
-  # Available: none | availability | reputation | syntax
+  # Available Values: none | availability | reputation | syntax
+  #
+  # CLI Argument: none
   checker_exclude:
-    - none
+    - none