]> git.ipfire.org Git - ipfire.org.git/commitdiff
dbl: Add an FAQ page
authorMichael Tremer <michael.tremer@ipfire.org>
Fri, 27 Feb 2026 15:55:47 +0000 (15:55 +0000)
committerMichael Tremer <michael.tremer@ipfire.org>
Fri, 27 Feb 2026 15:55:47 +0000 (15:55 +0000)
Signed-off-by: Michael Tremer <michael.tremer@ipfire.org>
Makefile.am
src/templates/base.html
src/templates/dbl/faq.html [new file with mode: 0644]
src/web/__init__.py

index ed3f4e2019435603ff599e6763392c2d307bc822..4e27fcc55aa2ba4588a527a6ea85c0f5d5a7b125 100644 (file)
@@ -191,6 +191,7 @@ templates_blog_modules_DATA = \
 templates_blog_modulesdir = $(templates_blogdir)/modules
 
 templates_dbl_DATA = \
+       src/templates/dbl/faq.html \
        src/templates/dbl/how-to-use.html \
        src/templates/dbl/index.html \
        src/templates/dbl/search.html \
index c18c0b9624785d7f59b346d8e04559cea9ee87c5..0468450091cc5f0b6052bca0b463250d0e9da228 100644 (file)
                                                                                {{ _("Report") }}
                                                                        </a>
 
+                                                                       <a class="navbar-item is-tab
+                                                                                       {% if request.path.startswith("/dbl/faq") %}is-active{% end %}"
+                                                                                       href="/dbl/faq">
+                                                                               {{ _("FAQ") }}
+                                                                       </a>
+
                                                                        <div class="navbar-item">
                                                                                <form action="/dbl/search" method="GET">
                                                                                        <div class="field">
diff --git a/src/templates/dbl/faq.html b/src/templates/dbl/faq.html
new file mode 100644 (file)
index 0000000..2189031
--- /dev/null
@@ -0,0 +1,435 @@
+{% extends "../base.html" %}
+
+{% block head %}
+       {% module OpenGraph(
+               title=_("IPFire DBL - FAQ"),
+       ) %}
+{% end block %}
+
+{% block title %}{{ _("IPFire DBL - FAQ") }}{% end block %}
+
+{% block container %}
+       <section class="hero">
+               <div class="hero-body">
+                       <div class="container">
+                               <h1 class="title is-1">
+                                       Frequently Asked Questions
+                               </h1>
+                       </div>
+               </div>
+       </section>
+
+       <section class="section">
+               <div class="container">
+                       <h3 class="title is-3">
+                               What is IPFire DBL?
+                       </h3>
+
+                       <div class="content">
+                               <h5>
+                                        What is IPFire DBL and how does it work?
+                               </h5>
+
+                               <p>
+                                       IPFire DBL (Domain Blocklist) is a free, community-maintained domain
+                                       blocklist that protects your network by blocking malicious, unwanted,
+                                       or inappropriate domains before they reach your devices.
+                               </p>
+
+                               <p>
+                                       Rather than forcing one massive list on everyone, DBL organises domains
+                                       into specific categories — such as Malware, Phishing, Advertising, or
+                                       Gambling — so you can choose exactly what to block based on your own
+                                       needs.
+                               </p>
+
+                               <p>
+                                       It integrates with DNS resolvers, firewalls, IPS systems, and browser
+                                       extensions using open industry standards.
+                               </p>
+                       </div>
+
+                       <div class="content">
+                               <h5>
+                                       Is IPFire DBL only for IPFire users?
+                               </h5>
+
+                               <p>
+                                       No. While IPFire DBL is built and maintained by the IPFire team and
+                                       is natively integrated into IPFire's URL Filter and Suricata IPS,
+                                       it is a completely standalone project designed to work with virtually
+                                       any compatible tool.
+                               </p>
+
+                               <p>
+                                       If your setup supports RPZ, domain lists, hosts files, Suricata
+                                       rulesets, or Adblock Plus syntax, you can use IPFire DBL regardless
+                                       of what firewall or platform you run.
+                               </p>
+                       </div>
+
+                       <div class="content">
+                               <h5>
+                                       Why was IPFire DBL created?
+                               </h5>
+
+                               <p>
+                                       The IPFire team had been dissatisfied with the available blocklist
+                                       options for years. The problem became more pressing when some prominent
+                                       lists were discontinued.
+                               </p>
+
+                               <p>
+                                       This left a significant gap for users who needed reliable, categorised
+                                       domain filtering.
+                               </p>
+
+                               <p>
+                                       IPFire DBL was built from the ground up to fill that gap with something
+                                       more accurate, legally sound, and community-powered.
+                               </p>
+                       </div>
+
+                       <div class="content">
+                               <h5>
+                                       What license is IPFire DBL released under?
+                               </h5>
+
+                               <p>
+                                       The code powering IPFire DBL is licensed under GPLv3+.
+                               </p>
+
+                               <p>
+                                       The lists themselves are released under the Creative Commons
+                                       Attribution-ShareAlike 4.0 (CC BY-SA 4.0) licence —
+                                       meaning they are free to use and share, but any derivative works must
+                                       be released under the same licence and must give appropriate credit.
+                               </p>
+                       </div>
+               </div>
+       </section>
+
+       <section class="section">
+               <div class="container">
+                       <h3 class="title is-3">
+                               The Lists & Categories
+                       </h3>
+
+                       <div class="content">
+                               <h5>
+                                       What categories are available?
+                               </h5>
+
+                               <p>
+                                       IPFire DBL offers various categories covering a wide range of threat
+                                       and content types, from security-focused lists like Malware and
+                                       Phishing through to content categories such as Gambling, Pornography,
+                                       and Social Networks.
+                               </p>
+
+                               <p>
+                                       You can browse all available categories
+                                       <a href="/dbl/lists">here</a>.
+                               </p>
+                       </div>
+
+                       <div class="content">
+                               <h5>
+                                        How often are the lists updated?
+                               </h5>
+
+                               <p>
+                                       The lists are updated continuously as new threats are identified and
+                                       community reports are reviewed.
+                               </p>
+
+                               <p>
+                                       If you are using RPZ via AXFR/IXFR, your resolver will automatically
+                                       pick up incremental changes as they are published — you only ever
+                                       download what has changed, not the full list every time.
+                               </p>
+
+                               <p>
+                                       If you are using the plaintext download formats, you should schedule
+                                       periodic fetches to keep your local copy current.
+                               </p>
+                       </div>
+
+                       <div class="content">
+                               <h5>
+                                       Do I need to use all the categories?
+                               </h5>
+
+                               <p>
+                                       Not at all — that is the point.
+                               </p>
+
+                               <p>
+                                       Each category is entirely independent and you can subscribe to as
+                                       many or as few as you need. A home user might only want Malware
+                                       and Phishing. A school might add Pornography, Violence, and
+                                       Social Networks. A corporate network might add Advertising and
+                                       Gambling on top of the security-focused categories.
+                               </p>
+
+                               <p>
+                                       You are in full control of which lists your resolver or firewall enforces.
+                               </p>
+                       </div>
+
+                       <div class="content">
+                               <h5>
+                                       Can I use multiple categories at the same time?
+                               </h5>
+
+                               <p>
+                                       Yes. Each category is an independent list and can be combined freely.
+                               </p>
+
+                               <p>
+                                       Most DNS resolvers that support RPZ allow you to load multiple zones
+                                       simultaneously, each enforcing a different category.
+                                       Simply add an additional RPZ configuration block for each category you
+                                       want to enforce.
+                               </p>
+                       </div>
+               </div>
+       </section>
+
+       <section class="section">
+               <div class="container">
+                       <h3 class="title is-3">
+                               Reporting & Community
+                       </h3>
+
+                       <div class="content">
+                               <h5>
+                                       How do I report a domain that should be blocked?
+                               </h5>
+
+                               <p>
+                                       If you come across a domain you believe should be listed — such as a
+                                       phishing site, malware distribution point, or content that fits one
+                                       of our categories — you can submit it via the
+                                       <a href="/dbl/report">Report</a> page.
+                               </p>
+                       </div>
+
+                       <div class="content">
+                               <h5>
+                                       How do I report a false positive?
+                               </h5>
+
+                               <p>
+                                       If a legitimate domain has been incorrectly listed, please let us know
+                                       via the <a href="/dbl/report">Report</a> page.
+                               </p>
+
+                               <p>
+                                       False positive reports are taken seriously — accuracy is a core goal
+                                       of IPFire DBL and we aim to act on confirmed false positives promptly.
+                               </p>
+                       </div>
+
+                       <div class="content">
+                               <h5>
+                                       How quickly are reports reviewed?
+                               </h5>
+
+                               <p>
+                                       Reports are reviewed by the IPFire DBL maintainers as part of the
+                                       regular update cycle. While we cannot guarantee a specific turnaround
+                                       time, security-related reports such as active phishing or malware
+                                       domains are prioritised.
+                               </p>
+                       </div>
+
+
+                       <div class="content">
+                               <h5>
+                                       What happens to domains that are reported but not listed?
+                               </h5>
+
+                               <p>
+                                       Every report is reviewed, but not every reported domain will be added
+                                       to a list.
+                               </p>
+
+                               <p>
+                                       A domain may be rejected if it does not clearly fit a category, if the
+                                       evidence is insufficient, or if it is already delisted following a
+                                       false positive review.
+                               </p>
+
+                               <p>
+                                       Reporters will receive feedback via the report system.
+                               </p>
+                       </div>
+
+                       <div class="content">
+                               <h5>
+                                       How can I get more involved?
+                               </h5>
+
+                               <p>
+                                       If you want to go beyond submitting reports — for example contributing
+                                       code, proposing new domain sources, or discussing the direction of the
+                                       project — the right place is the
+                                       <a href="https://lists.ipfire.org/dbl">IPFire DBL mailing list</a>.
+                               </p>
+
+                               <p>
+                                       You can subscribe by sending an email to
+                                       <a href="mailto:dbl+subscribe@lists.ipfire.org">dbl+subscribe@lists.ipfire.org</a>.
+                               </p>
+
+                               <p>
+                                       This is where the development conversation happens and where new
+                                       contributors are most welcome.
+                               </p>
+                       </div>
+               </div>
+       </section>
+
+       <section class="section">
+               <div class="container">
+                       <h3 class="title is-3">
+                               API & Programmatic Access
+                       </h3>
+
+                       <div class="content">
+                               <h5>
+                                       Is there an API for querying the lists programmatically?
+                               </h5>
+
+                               <p>
+                                       Yes. IPFire DBL provides a REST API available at
+                                       <a href="https://api.dbl.ipfire.org/">api.dbl.ipfire.org</a>.
+                               </p>
+
+                               <p>
+                                       It allows you to query individual domains, browse lists and their
+                                       contents, retrieve list history and sources and search across the DBL.
+                               </p>
+
+                               <p>
+                                       It is the best option if you want to integrate IPFire DBL data into
+                                       your own tooling.
+                               </p>
+                       </div>
+
+                       <div class="content">
+                               <h5>
+                                       Are there rate limits on downloads or zone transfers?
+                               </h5>
+
+                               <p>
+                                       We ask that you be considerate with download frequency. If you
+                                       are using RPZ via AXFR/IXFR, your resolver will handle this
+                                       efficiently by only fetching incremental updates.
+                               </p>
+
+                               <p>
+                                       If you are periodically downloading plaintext files, please avoid
+                                       fetching them more often than necessary — once per hour should be
+                                       more than sufficient for most use cases.
+                               </p>
+                       </div>
+               </div>
+       </section>
+
+       <section class="section">
+               <div class="container">
+                       <h3 class="title is-3">
+                               Contributing
+                       </h3>
+
+                       <div class="content">
+                               <h5>
+                                       How can I contribute a new domain source or feed?
+                               </h5>
+
+                               <p>
+                                       If you know of a reliable source of domain data that would improve
+                                       one of our categories, we'd love to hear about it. The best place
+                                       to propose new sources is the IPFire DBL mailing list where the
+                                       maintainers and community can evaluate it together.
+                               </p>
+
+                               <p>
+                                       If you are periodically downloading plaintext files, please avoid
+                                       fetching them more often than necessary — once per hour should be
+                                       more than sufficient for most use cases.
+                               </p>
+                       </div>
+
+                       <div class="content">
+                               <h5>
+                                       How can I contribute to the code?
+                               </h5>
+
+                               <p>
+                                       Code contributions and discussion happen on the IPFire DBL mailing
+                                       list. If you want to get involved, subscribing is the first step —
+                                       it is where patches are reviewed, ideas are discussed, and development
+                                       is coordinated.
+                               </p>
+                       </div>
+
+                       <div class="content">
+                               <h5>
+                                       Can I suggest a new category?
+                               </h5>
+
+                               <p>
+                                       Yes. Category suggestions are welcome on the IPFire DBL mailing list.
+                                       Bear in mind that new categories require reliable sources, clear
+                                       inclusion criteria, and ongoing maintenance, so bringing a concrete
+                                       proposal to the list will give your suggestion the best chance of
+                                       being taken forward.
+                               </p>
+                       </div>
+               </div>
+       </section>
+
+       <section class="section">
+               <div class="container">
+                       <h3 class="title is-3">
+                               Legal & Trust
+                       </h3>
+
+                       <div class="content">
+                               <h5>
+                                       Who maintains the IPFire DBL?
+                               </h5>
+
+                               <p>
+                                       IPFire DBL is maintained by the IPFire team and community. The project
+                                       is built by the same people behind the IPFire firewall distribution,
+                                       who bring years of experience in network security and edge protection.
+                               </p>
+                       </div>
+
+                       <div class="content">
+                               <h5>
+                                       Do you aggregate data from third-party lists?
+                               </h5>
+
+                               <p>
+                                       Yes, in part. IPFire DBL draws on a combination of community-curated
+                                       data, automated threat feeds, and selected third-party sources.
+                               </p>
+
+                               <p>
+                                       A key principle of the project is that we only include sources where
+                                       we have the legal right to do so — unlike many aggregated blocklists
+                                       that redistribute data without clear licensing.
+                               </p>
+
+                               <p>
+                                       You can inspect the sources for any individual list via the lists page.
+                               </p>
+                       </div>
+               </div>
+       </section>
+{% end block %}
index 2bb5ff55877d87faf70af7fe49cdd0be8075412f..e1d39f7fc9d934bf55aff82f88b2397276574996 100644 (file)
@@ -220,6 +220,7 @@ class Application(tornado.web.Application):
 
                        # DBL
                        (r"/dbl/?", dbl.IndexHandler),
+                       (r"/dbl/faq",  StaticHandler, { "template" : "dbl/faq.html" }),
                        (r"/dbl/how\-to\-use", dbl.HowToUseHandler),
                        (r"/dbl/lists", dbl.ListsHandler),
                        (r"/dbl/lists/([\w\-]+)", dbl.ListHandler),