Skip to content

Commit

Permalink
Merge branch 'master' into feature/AG-16407
Browse files Browse the repository at this point in the history
  • Loading branch information
slavaleleka committed Aug 8, 2024
2 parents 3fe91f8 + b0f1b4c commit 3bf5037
Show file tree
Hide file tree
Showing 430 changed files with 4,475 additions and 2,056 deletions.
22 changes: 21 additions & 1 deletion docs/adguard-for-android/solving-problems/background-work.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,27 @@ Alternatively, instead of unchecking **Auto-deny apps from auto starting** entir

Xiaomi (and especially MIUI) devices are among the most troublesome ones when it comes to background work. They are known to limit background processes and have non-standard permissions with a lack of proper documentation to top it off. Sometimes apps just don't work right on Xiaomi phones and there's little that can be done about that. Below are some actions you might attempt to perform if you run into any trouble regarding AdGuard's background work on various Xiaomi devices.

### MIUI 12.0.8+
### MIUI 13+ and HyperOS

Depending on the MIUI and HyperOS versions there are two ways to change the battery optimization settings on your phone and block ads more efficiently.

Option 1

1. Go to **Settings****Apps****Permissions****Background autostart** and allow AdGuard to run in the background

1. Return to **Settings****Apps****Manage apps****AdGuard** and uncheck **Pause app activity if unused**

1. Go to **Battery saver** and tap **No restrictions**

Option 2

1. Go to **Settings****Apps****Manage apps****AdGuard** and enable **Autostart**

1. Go to **Battery saver** and tap **No restrictions**

Done! You have successfully set up AdGuard to work in the background.

### MIUI 12.0.8

To let your AdGuard app run successfully in the background, do the following:

Expand Down
6 changes: 6 additions & 0 deletions docs/adguard-for-android/solving-problems/har.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ This article is about AdGuard for Android, a multifunctional ad blocker that pro

:::

:::note

HAR files are processed in accordance with [the AdGuard Privacy Policy](https://adguard.com/en/privacy.html).

:::

## What are HAR files?

The HAR (HTTP ARchive) format is a JSON-formatted archive file for logging of a web browser's interaction with a site. The specifications of HAR format defines an archival data for HTTP transactions that used by a browser to export detailed information about web pages it loads. More detailed description of HAR file format and its specification you can find at [softwareishard.com](http://www.softwareishard.com/blog/har-12-spec/) website.
Expand Down
6 changes: 6 additions & 0 deletions docs/adguard-for-android/solving-problems/log.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ This article is about AdGuard for Android, a multifunctional ad blocker that pro

:::

:::note

Data and/or files provided in logs are processed in accordance with [the AdGuard Privacy Policy](https://adguard.com/en/privacy.html).

:::

In this article, we'll guide you through the process of collecting debug logs, an essential troubleshooting step for solving complex issues that may potentially arise. Debug logs provide detailed insight into the inner workings of AdGuard for Android. If the AdGuard support team asks you to provide debug logs, simply follow these instructions.

:::note
Expand Down
6 changes: 6 additions & 0 deletions docs/adguard-for-android/solving-problems/logcat.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ This article is about AdGuard for Android, a multifunctional ad blocker that pro

:::

:::note

Data and/or files provided in logs are processed in accordance with [the AdGuard Privacy Policy](https://adguard.com/en/privacy.html).

:::

Sometimes a regular log may not be sufficient to identify the origin of the problem. In such cases a system log is needed. Below are instructions on how to collect and get it: via Developer options and Logcat.

:::note
Expand Down
16 changes: 12 additions & 4 deletions docs/adguard-for-android/solving-problems/outbound-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,17 +89,25 @@ In this article we give examples of how to set up some of the most popular proxi

### How to use AdGuard with NordVPN

1. Open AdGuard and go to **Settings****Filtering****Network****Proxy****Proxy server**.
1. Log in to your NordVPN account.

1. Tap the **Add proxy server** button and enter the following data:
1. Go to **Services****NordVPN****Manual setup** and set up your service credentials manually.

1. You will receive a verification code on the email address you use for NordVPN. Use it on your NordVPN account as requested, then tap *Apply* and *OK* to save the changes.

![Manual setup](https://cdn.adtidy.org/content/kb/ad_blocker/android/solving_problems/outbound-proxy/nordvpn-manual-setup.png)

1. Open the AdGuard app, go to **Settings****Filtering****Network****Proxy****Proxy server****Add proxy server**.

1. Enter the following data:

Field | Value
------- | ---------
Proxy type | *SOCKS5*
Proxy host | *any server from [this list](https://support.nordvpn.com/hc/en-us/articles/20195967385745-NordVPN-proxy-setup-for-qBittorrent)*
Proxy host | Any server from [this list](https://support.nordvpn.com/hc/en-us/articles/20195967385745-NordVPN-proxy-setup-for-qBittorrent)
Proxy port | *1080*

1. For **Username** and **Password** fields, enter your NordVPN Username and Password.
1. Enter your NordVPN credentials in the **Username** and **Password** fields.

1. Tap **Save and select**.

Expand Down
6 changes: 6 additions & 0 deletions docs/adguard-for-windows/solving-problems/adguard-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote

:::

:::note

Data and/or files provided in logs are processed in accordance with [the AdGuard Privacy Policy](https://adguard.com/en/privacy.html).

:::

To analyze and diagnose different problems that may potentially arise, the AdGuard support service might need AdGuard log files. These files contain records about errors and other events that occurr with the software. Below is the brief instruction describing the way to get the log files and send them to the support service if necessary.

:::note
Expand Down
6 changes: 6 additions & 0 deletions docs/adguard-for-windows/solving-problems/dump-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote

:::

:::note

Data and/or files provided in dump files are processed in accordance with [the AdGuard Privacy Policy](https://adguard.com/en/privacy.html).

:::

To diagnose the reasons for potential problems that users might encounter while using AdGuard, the support team might need the process dump file. The dump file helps developers to see the processes that were executed in the application over a given period of time. Below you can check on the instructions of how to collect the dump file on your PC.

1. Press **Ctrl + Shift + Esc** and click **Task Manager**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote

:::

:::note

Data and/or files provided in system logs are processed in accordance with [the AdGuard Privacy Policy](https://adguard.com/en/privacy.html).

:::

If any problems occur during the installation of AdGuard, the support team might ask you to collect and send them AdGuard installation logs. In this case you need to:

1. Select *Run* command in Start menu or press *Win + R* on the keyboard.
Expand Down
6 changes: 6 additions & 0 deletions docs/adguard-for-windows/solving-problems/system-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ This article covers AdGuard for Windows, a multifunctional ad blocker that prote

:::

:::note

Data and/or files provided in system logs are processed in accordance with [the AdGuard Privacy Policy](https://adguard.com/en/privacy.html).

:::

To analyze and diagnose different problems that may potentially arise, the AdGuard support service might need Windows system log files. Windows event logs contain records about all errors that occurr with the installed software, including AdGuard. Below is the brief instruction describing the way to get the log files and to send them to our support service if necessary.

1. Press *Win + R*
Expand Down
41 changes: 25 additions & 16 deletions docs/general/ad-filtering/create-own-filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,8 @@ or to the combination of these three:
:::caution Restrictions

- The rule's matching pattern cannot target any specific domains, e.g. it cannot start with `||`.
- Domains in the modifier value cannot be negated, e.g. `$denyallow=~x.com`, or have a wildcard TLD, e.g. `$denyallow=x.*`.
- Domains in the modifier value cannot be negated, e.g. `$denyallow=~x.com`, or have a wildcard TLD, e.g. `$denyallow=x.*`, or be a regular expression, e.g. `$denyallow=/\.(com\|org)/`.
- `$denyallow` cannot be used together with [`$to`](#to-modifier). It can be expressed with inverted `$to`: `$denyallow=a.com|b.com` is equivalent to `$to=~a.com|~b.com`.

The rules which violate these restrictions are considered invalid.

Expand Down Expand Up @@ -457,7 +458,7 @@ Safari does not support the simultaneous use of allowed and disallowed domains,

:::info Compatibility

Rules with regular expressions in the `$domain` modifier are supported by AdGuard for Windows, Mac, and Android with [CoreLibs] v1.11 or later.
Rules with regular expressions in the `$domain` modifier are supported by AdGuard for Windows, AdGuard for Mac, and AdGuard for Android with [CoreLibs] v1.11 or later, and AdGuard Browser Extension with [TSUrlFilter] v3.0.0 or later.

In AdGuard for Windows, Mac and Android with [CoreLibs] v1.12 or later the `$domain` modifier can be alternatively spelled as `$from`.

Expand Down Expand Up @@ -620,8 +621,7 @@ You may use a shorter name (alias) instead of using the full modifier name: `$3p

:::caution Restrictions

[`$denyallow`](#denyallow-modifier) can not be used together with `$to`. It can be expressed with inverted `$to`:
`$denyallow=a.com|b.com` is equivalent to `$to=~a.com|~b.com`.
[`$denyallow`](#denyallow-modifier) cannot be used together with `$to`. It can be expressed with inverted `$to`: `$denyallow=a.com|b.com` is equivalent to `$to=~a.com|~b.com`.

:::

Expand Down Expand Up @@ -945,7 +945,7 @@ Disables the Stealth Mode module for all corresponding pages and requests.
$stealth [= opt1 [| opt2 [| opt3 [...]]]]
```

`opt(i)` stand for certain Stealth Mode options disabled by the modifier. The modifier can contain any number of options (see below) or none. In the latter case the modifier disables all the Stealth Mode features.
`opt(i)` stand for certain Stealth Mode options disabled by the modifier. The modifier can contain any number of specific options (see below) or none. In the latter case the modifier disables all the Stealth Mode features.

The list of the available modifier options:

Expand Down Expand Up @@ -982,13 +982,14 @@ Blocking cookies and removing tracking parameters is achieved by using rules wit

- Modifier options must be lowercase, i.e. `$stealth=DPI` will be rejected.
- Modifier options cannot be negated, i.e. `$stealth=~3p-cookie` will be rejected.
- AdGuard Browser Extension supports only `searchqueries`, `donottrack`, `referrer`, `xclientdata`, `1p-cookie` and `3p-cookie` options.

:::

:::info Compatibility

- Stealth Mode is available in AdGuard for Windows, Mac, and Android, and AdGuard Browser Extension. All other products will ignore the rules with `$stealth` modifier.
- Rules with `$stealth` modifier with specific options are supported by AdGuard for Windows, Mac, and Android with [CoreLibs] v1.10 or later.
- Stealth Mode is available in AdGuard for Windows, AdGuard for Mac, AdGuard for Android, and AdGuard Browser Extension. All other products will ignore the rules with `$stealth` modifier.
- Rules with `$stealth` modifier with specific options are supported by AdGuard for Windows, AdGuard for Mac, and AdGuard for Android with [CoreLibs] v1.10 or later, and AdGuard Browser Extension with [TSUrlFilter] v3.0.0 or later.

:::

Expand Down Expand Up @@ -1108,7 +1109,7 @@ These modifiers are able to completely change the behavior of basic rules.
| [$jsonprune](#jsonprune-modifier) |||||||
| [$xmlprune](#xmlprune-modifier) |||||||
| [$network](#network-modifier) |||||||
| [$permissions](#permissions-modifier) || | ||||
| [$permissions](#permissions-modifier) |[*](#permissions-modifier-limitations) | 🧩 | 🧩 [*](#permissions-modifier-limitations) ||||
| [$redirect](#redirect-modifier) |||||||
| [$redirect-rule](#redirect-rule-modifier) |||||||
| [$referrerpolicy](#referrerpolicy-modifier) |||||||
Expand All @@ -1124,8 +1125,8 @@ These modifiers are able to completely change the behavior of basic rules.

- ✅ — fully supported
- ✅ * — supported, but reliability may vary or limitations may occur; check the modifier description for more details
<!-- - 🧩 — may already be implemented in nightly or beta versions but is not yet supported in release versions -->
- ⏳ — feature that has been implemented or is planned to be implemented but is not yet available in any product
- 🧩 — may already be implemented in nightly or beta versions but is not yet supported in release versions
<!-- - ⏳ — feature that has been implemented or is planned to be implemented but is not yet available in any product -->
- ❌ — not supported
- 👎 — deprecated; still supported but will be removed in the future

Expand Down Expand Up @@ -1953,8 +1954,12 @@ For the requests matching a `$permissions` rule, AdGuard strengthens response's

**Syntax**

`$permissions` value syntax is similar to the `Permissions-Policy` header [syntax](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permissions-Policy) with one exception: comma that separates several features **MUST** be escaped — see examples below.
The list of the available directives is available [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permissions-Policy#directives).
`$permissions` value syntax is identical to that of the `Permissions-Policy` header [syntax](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permissions-Policy) with the following exceptions:

1. A comma that separates multiple features **MUST** be escaped — see examples below.
2. A pipe character (`|`) can be used to separate features instead of a comma.

The list of available directives is available [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permissions-Policy#directives).

`$permissions` value can be empty in the case of exception rules — see examples below.

Expand All @@ -1964,7 +1969,7 @@ The list of the available directives is available [here](https://developer.mozil
- `@@||example.org/page/*$permissions=autoplay=()` disables all rules with the `$permissions` modifier exactly matching `autoplay=()` on all the pages matching the rule pattern. For instance, the rule above. It is important to note that the exception rule only takes effect in the case of an **exact value match**. For example, if you want to disable the rule `$permissions=a=()\,b=()`, you need exception rule `@@$permissions=a=()\,b=()`, and **not** `@@$permissions=b=()\,a=()`, **nor** `@@$permissions=b=()` because `b=()\,a=()` or `b=()` does not match with `a=()\,b=()`.
- `@@||example.org/page/*$permissions` disables all the `$permissions` rules on all the pages matching the rule pattern.
- `$domain=example.org|example.com,permissions=storage-access=()\, camera=()` disallows using the Storage Access API to request access to unpartitioned cookies and using video input devices across `example.org` and `example.com`.
- For better compatibility, we also support pipe-separated values for `$permissions` modifier: `$permissions=storage-access=()|camera=()`.
- `$domain=example.org|example.com,permissions=storage-access=()|camera=()` does the same — a `|` can be used to separate the features instead of an escaped comma.
- `@@||example.org^$document` or `@@||example.org^$urlblock` disables all the `$permission` rules on all the pages matching the rule pattern.

:::note
Expand All @@ -1979,6 +1984,8 @@ If there are multiple `$permissions` rules that match the same request, multiple

:::

##### `$permissions` modifier limitations {#permissions-modifier-limitations}

:::caution Limitations

Firefox ignores the `Permissions-Policy` header. For more information, see [this issue](https://bugzilla.mozilla.org/show_bug.cgi?id=1694922).
Expand All @@ -1987,14 +1994,16 @@ Firefox ignores the `Permissions-Policy` header. For more information, see [this

:::caution Restrictions

1. Characters forbidden in the `$permissions` value: `$`
1. `$permissions` is compatible with three types of modifiers: `$domain`, `$important`, and `$subdocument`
1. Characters forbidden in the `$permissions` value: `$`.
2. `$permissions` is compatible with a limited set of modifiers: `$domain`, `$important`, `$subdocument`, and [content-type modifiers](#content-type-modifiers).
3. `$permissions` rules that do not have any [content-type modifiers](#content-type-modifiers) will match only requests where content type is `document`.

:::

:::info Compatibility

Rules with the `$permissions` modifier are supported by AdGuard for Windows, Mac, and Android with [CoreLibs] v1.11 or later.
- Rules with the `$permissions` modifier are supported by AdGuard for Windows, Mac, and Android with [CoreLibs] v1.11 or later, and AdGuard Browser Extension with [TSUrlFilter] v3.0.0 or later.
- Pipe separator `|` instead of escaped comma is supported by AdGuard for Windows, Mac, and Android with [CoreLibs] v1.14 or later, and AdGuard Browser Extension with [TSUrlFilter] v3.0.0 or later.

:::

Expand Down
6 changes: 3 additions & 3 deletions docs/general/userscripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,13 @@ As userscripts are mainly created by enthusiasts, you should be cautious when in

Here we will describe some of the most popular userscript catalogs.

### Stylish (userstyles.org)
### Userscript.Zone

[Userstyles.org](https://userstyles.org/) is a catalog of user styles, but it allows you to load them as userscripts. Thus, any user style can be installed via AdGuard. Be careful if you decide to install an unpopular script — there's a risk it might be harmful.
[Userscript.Zone](https://www.userscript.zone) is a website that allows searching for userscripts by entering a matching URL or domain. The website is easy to use and has a high credibility, since only scripts from moderated pages are displayed.

### Greasy Fork

[Greasy Fork](https://greasyfork.org/) is a userscript catalog by Stylish creators. Unlike the above-mentioned userstyles.org, the scripts in this catalog undergo moderation, so their credibility is much higher.
[Greasy Fork](https://greasyfork.org/) is a userscript catalog by Stylish creators. The scripts in this catalog undergo moderation, so their credibility is much higher.

### OpenUserJS.org

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,11 @@ sidebar_position: 1

## Sending logs

> AdGuard is committed to protecting your privacy. We strictly follow our [Privacy Policy](https://adguard.com/en/privacy/browser-extension.html) and do not collect any private information about users. Before sending your logs to the support team, please review the file as it may contain additional information that you don’t want to share. If it contains such personal information, we recommend that you delete it first.
:::note

AdGuard is committed to protecting your privacy. We strictly follow our [Privacy Policy](https://adguard.com/privacy/browser-extension.html) and do not collect any private information about users. Before sending your logs to the support team, please review the file as it may contain additional information that you don’t want to share. If it contains such personal information, we recommend that you delete it first.

:::

Now that you have collected the logs, please follow these steps to submit them to our development team:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ This article is about AdGuard for Android, a multifunctional ad blocker that pro

:::

:::note

HAR files are processed in accordance with [the AdGuard Privacy Policy](https://adguard.com/en/privacy.html).

:::

## What are HAR files?

The HAR (HTTP ARchive) format is a JSON-formatted archive file for logging of a web browser's interaction with a site. The specifications of HAR format defines an archival data for HTTP transactions that used by a browser to export detailed information about web pages it loads. More detailed description of HAR file format and its specification you can find at [softwareishard.com](http://www.softwareishard.com/blog/har-12-spec/) website.
Expand Down
Loading

0 comments on commit 3bf5037

Please sign in to comment.