Skip to content

Commit 27badc9

Browse files
authored
Merge branch 'master' into agm-2737-per-app-config-cli
2 parents abd19f6 + 86bb94f commit 27badc9

File tree

54 files changed

+2468
-66
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+2468
-66
lines changed

docs/adguard-for-android/solving-problems/outbound-proxy.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,28 @@ You should remove Shadowsocks app from filtering before setting up the process (
155155
Proxy host | *127.0.0.1*
156156
Proxy port | *7891*
157157

158+
### How to use AdGuard with WG Tunnel
159+
160+
*The proxy mode was added in version 4.0. We presume that you already have WG Tunnel installed on your device and have added the WireGuard configuration.*
161+
162+
1. Open WG Tunnel and go to **Settings** (the cog wheel at the bottom) → **App Mode****Proxy (experimental)**. This will set WG Tunnel to proxy mode.
163+
164+
1. Open AdGuard and go to **App management**. Choose **WG Tunnel** and disable **Route traffic through AdGuard**. This will eliminate traffic looping.
165+
166+
1. Then go to **Settings****Filtering****Network****Proxy****Proxy server**.
167+
168+
1. Tap **Add proxy server** and fill in the fields:
169+
170+
Field | Value
171+
------- | ---------
172+
Proxy type | *SOCKS5*
173+
Proxy host | *127.0.0.1*
174+
Proxy port | *25344*
175+
176+
1. Tap **Save and select**.
177+
178+
1. Enable the main proxy switch and AdGuard protection to route your device’s traffic through the proxy.
179+
158180
## Limitations
159181

160182
However, at least one factor may prevent certain traffic from being routed through the outbound proxy, even after configuring the AdGuard proxy settings. That would be if the app itself isn't configured to send its traffic through AdGuard. To do it, you need to proceed to **App management**, choose the app, and turn on **Route traffic through AdGuard**.
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: How to set app exclusions and custom filters
3+
sidebar_position: 5
4+
---
5+
6+
In AdGuard CLI, it’s not possible to import app exclusions from other versions of the program. You can, however, manually create the required exclusions and filters by editing several configuration files in the app’s working directory.
7+
8+
## How to add exclusions
9+
10+
AdGuard CLI working directory:
11+
12+
- Linux: `~/.local/share/adguard-cli/`
13+
- macOS: `~/Library/Application Support/adguard-cli/`
14+
15+
Several key files are located in this folder:
16+
17+
1. `browsers.yaml` — a list of browsers (Safari, Chrome, Firefox, etc.). Here you can enable or disable HTTPS filtering for individual browsers, or completely exclude them from filtering.
18+
19+
**Example browsers.yaml (for Linux)**:
20+
21+
```sh
22+
- name: firefox
23+
action: default
24+
- name: chrome
25+
action: default
26+
- name: chromium
27+
action: default
28+
- name: brave
29+
action: default
30+
```
31+
32+
**Example `browsers.yaml` (for macOS)**:
33+
34+
```sh
35+
- name: com.apple.Safari
36+
action: default
37+
- name: com.google.Chrome
38+
action: default
39+
- name: org.mozilla.firefox
40+
action: default
41+
- name: com.brave.Browser
42+
action: default
43+
```
44+
45+
To disable HTTPS filtering, replace `default` with `bypass_https`. To completely exclude the app from filtering, replace `default` with `bypass`.
46+
47+
1. `proxy.yaml` — the main configuration file. It has an apps section where exclusions for any other apps are set.
48+
49+
**Example `proxy.yaml`**:
50+
51+
```sh
52+
- include-list: browsers.yaml
53+
- name: '*vpn*'
54+
action: 'bypass'
55+
skip_outbound_proxy: true
56+
- name: '*'
57+
action: 'bypass_https'
58+
```
59+
60+
:::note
61+
62+
On **Linux**, specify the executable name (`chrome`, `firefox`, etc.). On **macOS**, specify the bundle ID, e.g., `com.google.Chrome`, `org.mozilla.firefox`.
63+
64+
:::
65+
66+
## How to add custom filters
67+
68+
The working directory contains the `user.txt` file, where you can add your own blocking or allowing rules for websites. If you have your own list of rules in `.txt` format, connect it via `proxy.yaml`:
69+
70+
```sh
71+
filters:
72+
- 'flm://'
73+
- 'user.txt'
74+
- 'my_filter.txt' # connecting your own file
75+
```

docs/general/ad-filtering/create-own-filters.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1418,6 +1418,7 @@ These modifiers are able to completely change the behavior of basic rules.
14181418
| [$removeparam](#removeparam-modifier) |||[*[6]](#removeparam-modifier-limitations) |||||
14191419
| [$replace](#replace-modifier) ||||||||
14201420
| [$urltransform](#urltransform-modifier) ||||||||
1421+
| [$reason](#reason-modifier) ||||||||
14211422
| [noop](#noop-modifier) ||||||||
14221423
| [$empty 👎](#empty-modifier "deprecated") ||||||||
14231424
| [$mp4 👎](#mp4-modifier "deprecated") ||||||||
@@ -3012,6 +3013,42 @@ Rules with the `$urltransform` modifier are supported by AdGuard for Windows, Ad
30123013
30133014
:::
30143015
3016+
#### **`$reason`** {#reason-modifier}
3017+
3018+
The `$reason` modifier allows you to add a custom explanation message that will be displayed on the blocking page when a request is blocked by this rule.
3019+
This modifier only works with the `$document` content-type modifier.
3020+
3021+
**Character limitations and escaping requirements:**
3022+
3023+
- There is no maximum length limit for the reason text
3024+
- All characters are allowed in the reason text
3025+
- Special characters (such as quotes, commas, and backslashes) must be properly escaped using the backslash (`\`)
3026+
3027+
**Predefined localizable tokens:**
3028+
3029+
Instead of custom text, you can use predefined tokens that will be automatically localized:
3030+
3031+
- `malicious`for malicious content
3032+
- `tracker`for tracking content
3033+
- `disreputable`for disreputable content
3034+
3035+
**Examples**
3036+
3037+
```adblock
3038+
||example.com^$document,reason="Tracker"
3039+
||example.com^$document,reason="Malicious site blocked by security filter"
3040+
||ads.example.com^$document,reason="This site contains tracking scripts"
3041+
||malware.example.com^$document,reason="Site blocked: \"Known malware distributor\""
3042+
||tracking.example.com^$document,reason=disreputable
3043+
||analytics.example.com^$document,reason=tracker
3044+
```
3045+
3046+
:::info Compatibility
3047+
3048+
AdGuard for Windows, AdGuard for Mac, AdGuard for Android, and AdGuard for Linux with CoreLibs v1.20 or later support rules with the `$reason` modifier. AdGuard Content Blocker does not support these rules.
3049+
3050+
:::
3051+
30153052
#### **`noop`** {#noop-modifier}
30163053
30173054
`noop` modifier does nothing and can be used solely to increase rules' readability. It consists of a sequence of underscore characters (`_`) of arbitrary length and can appear in a rule as often as needed.

docs/general/extensions.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,24 @@ This script removes Google's tracking feature from the links in Google search re
5555

5656
Its source code is [available on GitHub](https://github.com/Rob--W/dont-track-me-google). This userscript can be downloaded from [GreasyFork](https://greasyfork.org/en/scripts/428243-don-t-track-me-google) and installed in any AdGuard CoreLibs-based app.
5757

58+
#### SponsorBlock
59+
60+
SponsorBlock skips sponsored segments in YouTube videos. It saves time by jumping straight to the main content and removes interruptions from ads and self-promotions.
61+
62+
:::info
63+
64+
This userscript runs exclusively on our desktop applications, AdGuard for Windows and AdGuard for Mac.
65+
66+
:::
67+
68+
To try it out:
69+
70+
1. Go to [https://mchangrh.github.io/sb.js/](https://mchangrh.github.io/sb.js/).
71+
1. Click **Generate link**.
72+
1. Copy the link that appears.
73+
1. Open AdGuard and go to **Extensions → Add extension → Import from file or URL**.
74+
1. Paste the copied link and confirm.
75+
5876
#### tinyShield
5977

6078
A userscript for people visiting Korean websites and some international websites. The tinyShield userscript blocks Ad-Shield ads and anti-adblocks. This userscript can be installed in AdGuard CoreLibs-based apps, Violentmonkey, Tampermonkey, and [quoid/userscripts](https://github.com/quoid/userscripts). Learn more about tinyShield and how to install it on [GitHub](https://github.com/List-KR/tinyShield).
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: How to set app exclusions and custom filters
3+
sidebar_position: 5
4+
---
5+
6+
In AdGuard CLI, it’s not possible to import app exclusions from other versions of the program. You can, however, manually create the required exclusions and filters by editing several configuration files in the app’s working directory.
7+
8+
## How to add exclusions
9+
10+
AdGuard CLI working directory:
11+
12+
- Linux: `~/.local/share/adguard-cli/`
13+
- macOS: `~/Library/Application Support/adguard-cli/`
14+
15+
Several key files are located in this folder:
16+
17+
1. `browsers.yaml` — a list of browsers (Safari, Chrome, Firefox, etc.). Here you can enable or disable HTTPS filtering for individual browsers, or completely exclude them from filtering.
18+
19+
**Example browsers.yaml (for Linux)**:
20+
21+
```sh
22+
- name: firefox
23+
action: default
24+
- name: chrome
25+
action: default
26+
- name: chromium
27+
action: default
28+
- name: brave
29+
action: default
30+
```
31+
32+
**Example `browsers.yaml` (for macOS)**:
33+
34+
```sh
35+
- name: com.apple.Safari
36+
action: default
37+
- name: com.google.Chrome
38+
action: default
39+
- name: org.mozilla.firefox
40+
action: default
41+
- name: com.brave.Browser
42+
action: default
43+
```
44+
45+
To disable HTTPS filtering, replace `default` with `bypass_https`. To completely exclude the app from filtering, replace `default` with `bypass`.
46+
47+
1. `proxy.yaml` — the main configuration file. It has an apps section where exclusions for any other apps are set.
48+
49+
**Example `proxy.yaml`**:
50+
51+
```sh
52+
- include-list: browsers.yaml
53+
- name: '*vpn*'
54+
action: 'bypass'
55+
skip_outbound_proxy: true
56+
- name: '*'
57+
action: 'bypass_https'
58+
```
59+
60+
:::note
61+
62+
On **Linux**, specify the executable name (`chrome`, `firefox`, etc.). On **macOS**, specify the bundle ID, e.g., `com.google.Chrome`, `org.mozilla.firefox`.
63+
64+
:::
65+
66+
## How to add custom filters
67+
68+
The working directory contains the `user.txt` file, where you can add your own blocking or allowing rules for websites. If you have your own list of rules in `.txt` format, connect it via `proxy.yaml`:
69+
70+
```sh
71+
filters:
72+
- 'flm://'
73+
- 'user.txt'
74+
- 'my_filter.txt' # connecting your own file
75+
```

i18n/bn/docusaurus-plugin-content-docs/current/adguard-browser-extension/compatibility.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ If you have the desktop version of AdGuard installed on your PC, it is better to
1717

1818
## AdGuard Browser Assistant
1919

20-
![AdGuard Browser Assistant \*mobile\_border](https://cdn.adtidy.org/content/kb/ad_blocker/browser_extension/ad_blocker_browser_extension_assistant.png)
20+
![AdGuard Browser Assistant \*mobile_border](https://cdn.adtidy.org/content/kb/ad_blocker/browser_extension/ad_blocker_browser_extension_assistant.png)
2121

2222
AdGuard Browser Assistant is a browser extension that works and feels just like AdGuard Browser Extension, but it's much lighter and doesn't interfere with the desktop apps. You can [read more about Browser Assistant for Windows](/adguard-for-windows/browser-assistant) or [Mac](/adguard-for-mac/features/browser-assistant), or [download it from our website](https://adguard.com/adguard-assistant/overview.html).
2323

i18n/bn/docusaurus-plugin-content-docs/current/adguard-browser-extension/features/main-menu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This article is about the AdGuard Browser Extension, which safeguards only your
1111

1212
The extension's main page can be accessed by clicking the extension's icon on the toolbar of your browser.
1313

14-
![Main menu \*mobile\_border](https://cdn.adtidy.org/content/Kb/ad_blocker/browser_extension/ad_blocker_browser_extension_main.png)
14+
![Main menu \*mobile_border](https://cdn.adtidy.org/content/Kb/ad_blocker/browser_extension/ad_blocker_browser_extension_main.png)
1515

1616
On the main page, you can hide any element on any page manually (a corresponding rule will be added to the _User rules_), open the _Filtering log_ to view the complete information about your browser's traffic and block requests on the go, or look at a website’s security report. Besides, you can submit a complaint about any website (for example, if there are missed ads on the page, our filter engineers will review the report and fix the problem) and see the statistics on applied blocking rules.
1717

i18n/bn/docusaurus-plugin-content-docs/current/adguard-for-android/features/protection/ad-blocking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ Basic protection effectively blocks ads on most websites. For more customized ad
2121

2222
- Create user rules — AdGuard will apply them on specified websites. [Learn how to create your own user rules](/general/ad-filtering/create-own-filters)
2323

24-
![Ad blocking \*mobile\_border](https://cdn.adtidy.org/blog/new/o44x5ad_blocking.png)
24+
![Ad blocking \*mobile_border](https://cdn.adtidy.org/blog/new/o44x5ad_blocking.png)

i18n/bn/docusaurus-plugin-content-docs/current/adguard-for-android/features/protection/browsing-security.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ The Browsing security module can be accessed by tapping the _Protection_ tab (se
1313

1414
Browsing security protects you from visiting phishing and malicious websites. It also warns you about potential malware.
1515

16-
![Browsing security \*mobile\_border](https://cdn.adtidy.org/blog/new/1y6a8browsing_security.png)
16+
![Browsing security \*mobile_border](https://cdn.adtidy.org/blog/new/1y6a8browsing_security.png)
1717

1818
If you're about to visit a dangerous website, Browsing security will show you the following warning:
1919

20-
![Browsing security warning \*mobile\_border](https://cdn.adtidy.org/blog/new/o8s3Screenshot_2023-06-29-15-49-01-514-edit_com.android.chrome.jpg)
20+
![Browsing security warning \*mobile_border](https://cdn.adtidy.org/blog/new/o8s3Screenshot_2023-06-29-15-49-01-514-edit_com.android.chrome.jpg)
2121

2222
:::warning
2323

i18n/bn/docusaurus-plugin-content-docs/current/adguard-for-android/features/protection/dns-protection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ _DNS protection_ allows you to filter DNS requests with the help of a selected D
2525

2626
- You can also block and unblock domains by creating user rules. You might need to consult our article about [DNS filtering rule syntax](https://adguard-dns.io/kb/general/dns-filtering-syntax/)
2727

28-
![DNS protection \*mobile\_border](https://cdn.adtidy.org/blog/new/u8qtxdns_protection.png)
28+
![DNS protection \*mobile_border](https://cdn.adtidy.org/blog/new/u8qtxdns_protection.png)
2929

3030
#### DNS server
3131

0 commit comments

Comments
 (0)