Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit f9729eea authored by Mohammed Althaf T's avatar Mohammed Althaf T 😊
Browse files

Merge branch '2508-master-filter_generate' into 'master'

docs: add browser ad filter doc

See merge request e/documentation/user!1187
parents d458b10c 97d4280e
Loading
Loading
Loading
Loading
+34 −0
Original line number Diff line number Diff line

# Ad block filters

Since the release of `/e/OS v0.15` it is possible to use custom ad block filters.

Change the default filters URL from `Settings` > `Legacy AdBlock settings`, and specify a valid URL for the filters file.

The default URL is: [https://images.ecloud.global/apps/browser/filters.dat ](https://images.ecloud.global/apps/browser/filters.dat)

# How to create a custom filters file

See [Chromium documentation](https://github.com/chromium/chromium/blob/main/components/subresource_filter/FILTER_LIST_GENERATION.md).

You will need to use the `ruleset_converter` command-line tool as in:
```
ruleset_converter --input_format=filter-list \
		--output_format=unindexed-ruleset \
                --input_files=easyprivacy.txt,easylist.txt \
		--output_file=filters.dat
```

A pre-built `ruleset_converter` binary for Linux/amd64 is available here [Browser Filters](https://gitlab.e.foundation/e/os/browser_filters/-/blob/master/ruleset_converter).

# Requirements

The webserver serving the file must provide a consistent `Last-Modified` header.

# Automatic filters updates

The filters URL will be automatically checked 5 seconds after the browser is started and then once per week.

# Limitations

You will need to close and re-open Browser in order for the new URL to be in effect.
+1 −1
Original line number Diff line number Diff line
@@ -27,7 +27,7 @@

      <div class="footer-col footer-col-3">
        <p>{% translate site_global.description %}</p>
        <p>{% include licence.html %}</p>
        <p>{% if page.custom_licence %} {{ page.custom_licence | replace: "PAGE_TITLE", page.title }} {% else %} {% include licence.html %} {% endif %}</p>
      </div>
    </div>

+9 −0
Original line number Diff line number Diff line
---
layout: page
title: Browser Custom Ad Block filters
namespace: browser-custom-filters
permalink: /browser-custom-filters
custom_licence: '"PAGE_TITLE" is a modified version of the original project bromite.github.io (<a href="https://github.com/bromite/bromite.github.io/blob/master/custom-filters.md">original source code</a>), licensed under <a href="https://github.com/bromite/bromite.github.io/blob/master/LICENSE">GPLv3</a> license.'
---

{% tf pages/browser-custom-filters.md %}