Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -214,3 +214,37 @@ adguard-cli config show outbound_proxy
Configuring `outbound_proxy` via URL is available starting from AdGuard for Linux v1.1.26 nightly and v1.1 stable release.

:::

## Export and import settings

The export/import functionality allows you to backup your AdGuard CLI configuration and restore it on the same or different system. This includes filters, proxy settings, and other configuration options.

### Export settings

To export current AdGuard CLI settings to a ZIP archive, use:

```sh
adguard-cli export-settings
```

You can specify the output path using the `-o` or `--output` flag. This can be either a specific file path or a directory:

```sh
# Export to a specific file
adguard-cli export-settings -o "/path/to/settings.zip"

# Export to a directory (archive will be created with a standard name)
adguard-cli export-settings -o "/path/to/directory"
```

If no output path is specified, the settings will be exported to the working directory with a standard name. After successful export, the command will display the full path where the archive was created.

### Import settings

To import AdGuard CLI settings from a ZIP archive, use:

```sh
adguard-cli import-settings -i "/path/to/settings.zip"
```

The `-i` or `--input` flag is required and specifies the path to the settings archive to import.
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,6 @@ Go to the Applications section. Find AdGuard there, right-click it and choose **
**Use this instruction only if you know what you are doing or if our support service specifically recommended you the 'advanced uninstall'. Also, do all the steps from the "regular uninstall" first.**

1. After that, delete following AdGuard files:
- /Library/Application Support/AdGuard Software/com.adguard.mac.adguard (folder)
- ~/Library/Preferences/com.adguard.mac.adguard.plist (file)
- ~/Library/Group\ Containers/TC3Q7MAJXF.com.adguard.mac (folder)
- /Library/LaunchDaemons/com.adguard.mac.adguard.adguard-pac.daemon.plist (file)
- /Library/LaunchDaemons/com.adguard.mac.adguard.adguard-tun-helper.daemon.plist (file)
Expand All @@ -89,9 +87,6 @@ Go to the Applications section. Find AdGuard there, right-click it and choose **
To do so, open the Terminal app, then enter and execute the following commands:

```bash
sudo rm -R "/Library/Application Support/AdGuard Software/com.adguard.mac.adguard"
rm -R "$HOME/Library/Application Support/com.adguard.mac.adguard"
rm $HOME/Library/Preferences/com.adguard.mac.adguard.plist
rm -R "$HOME/Library/Group Containers/TC3Q7MAJXF.com.adguard.mac"
find "$HOME/Library/Application Support" -name "com.adguard.browser_extension_host.nm.json" -delete
sudo rm /Library/LaunchDaemons/com.adguard.mac.adguard.adguard-pac.daemon.plist
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ When this option is enabled, AdGuard automatically notices when your browser req

AdGuard comes with four pre-installed userscripts:

- AdGuard Assistent (Beta)
- AdGuard Extra
- AdGuard Popup blocker
- Web of Trust
- AdGuard Assistant (Beta)
- AdGuard Extra (Beta)
- AdGuard Popup blocker (Beta)
- Web of Trust (Beta)

### AdGuard Assistant (Beta)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This article describes AdGuard for Windows v8.0, a comprehensive ad blocker that

![Protection tab](https://cdn.adtidy.org/content/kb/ad_blocker/windows/version_8/protection/protection_section.png)

The _Protection_ tab contains all key security and filtering settings. Here you can control _Ad blocking_, _Tracking protection_, _Annoyance blocking_, _DNS filtering_, _Browsing security_, _Parental control_, and _Extensions_. You can also manage AdGuard Assistant here — a tool that lets you control its functionality without opening the app. Each of these features is described in a separate article.
The _Protection_ tab contains all key security and filtering settings. Here you can control _Ad blocking_, _Tracking protection_, _Annoyance blocking_, _DNS protection_, _Browsing security_, _Parental control_, and _Extensions_. You can also manage AdGuard Assistant here — a tool that lets you control its functionality without opening the app. Each of these features is described in a separate article.

[Ad blocking](/adguard-for-windows-8/protection/ad-blocking)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ If you need to uninstall or reinstall AdGuard, do the following:

### Advanced method {#advanced}

In case regular uninstall doesn't work for any reason, you can try to use an advanced method. First of all, you need to [download the uninstaller tool](https://static.adtidy.org/windows/uninstaller/uninstal_utility.zip) created by our developers. Extract the archive to any folder on your PC and run the **Adguard.UninstallUtility.exe** file, and allow the app to make changes to your device. Then follow the instruction below:
In case regular uninstall doesn't work for any reason, you can try to use an advanced method. First of all, you need to [download the uninstaller tool](https://static.adtidy.org/windows/uninstaller/uninstall_utility.zip) created by our developers. Extract the archive to any folder on your PC and run the **Adguard.UninstallUtility.exe** file, and allow the app to make changes to your device. Then follow the instruction below:

- Select *AdGuard Ad Blocker* and *Standard* uninstall type, then click *Uninstall*.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,16 @@ AdGuard Mini for Mac is a free app present in the Mac App Store. To install it o

2. Press _Get_ → _Install_ → _Open_.

3. In the opened AdGuard Mini window, accept EULA and Privacy policy and click _Continue_.
3. In the opened AdGuard Mini window, accept EULA and Privacy policy. Here you can also choose to help us improve the extension by sending anonymized usage data. Then click _Continue_.

![Onboarding](https://cdn.adtidy.org/content/kb/ad_blocker/mini_mac/first-open.png)

:::note

If you choose to share app usage data with AdGuard, the extension will collect anonymized information such as UI interactions and session identifiers. This consent is optional and can be withdrawn at any time. All collected data is fully anonymized, used only internally, and never shared with third parties.

:::

4. Click _Open settings_.

![Open settings](https://cdn.adtidy.org/content/kb/ad_blocker/mini_mac/open-settings.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ The following modifiers are the most simple and frequently used. Basically, they
| [$app](#app-modifier) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| [$denyallow](#denyallow-modifier) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
| [$domain](#domain-modifier) | ✅ | ✅ | ✅ [*[1]](#domain-modifier-limitations) | ✅ | ✅ [*[1]](#domain-modifier-limitations) | ✅ [*[1]](#domain-modifier-limitations) | ✅ |
| [$header](#header-modifier) | ✅ | ✅ [*[2]](#header-modifier-limitations) | | ✅ [*[2]](#header-modifier-limitations) | ❌ | ❌ | ❌ |
| [$header](#header-modifier) | ✅ | ✅ [*[2]](#header-modifier-limitations) | ✅ [*[2]](#header-modifier-limitations) | ✅ [*[2]](#header-modifier-limitations) | ❌ | ❌ | ❌ |
| [$important](#important-modifier) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
| [$match-case](#match-case-modifier) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [$method](#method-modifier) | ✅ | ✅ | ✅ | ✅ | ✅ [*[2]](#method-modifier-limitations) | ✅ [*[2]](#method-modifier-limitations) | ❌ |
Expand Down Expand Up @@ -630,11 +630,13 @@ The modifier part, `":" h_value`, may be omitted. In that case, the modifier mat

1. In AdGuard Browser Extension, the `$header` modifier is only compatible with [`$csp`](#csp-modifier), [`$removeheader`](#removeheader-modifier) (response headers only), [`$important`](#important-modifier), [`$badfilter`](#badfilter-modifier), [`$domain`](#domain-modifier), [`$third-party`](#third-party-modifier), [`$match-case`](#match-case-modifier), and [content-type modifiers](#content-type-modifiers) such as [`$script`](#script-modifier) and [`$stylesheet`](#stylesheet-modifier). The rules with other modifiers are considered invalid and will be discarded.

1. In AdGuard Browser Extension MV3, regular expressions in the `$header` modifier values are not supported.

:::

:::info Compatibility

Rules with the `$header` modifier are supported by AdGuard for Windows, AdGuard for Mac, AdGuard for Android, and AdGuard for Linux with [CoreLibs][] v1.11 or later, and AdGuard Browser Extension with [TSUrlFilter][] v3.0.0 or later.
Rules with the `$header` modifier are supported by AdGuard for Windows, AdGuard for Mac, AdGuard for Android, and AdGuard for Linux with [CoreLibs][] v1.11 or later, AdGuard Browser Extension with [TSUrlFilter][] v3.0.0 or later, and AdGuard Browser Extension MV3 v5.3 or later.

:::

Expand Down Expand Up @@ -2840,18 +2842,31 @@ If multiple `$urltransform` rules match a single request, we will apply each of

**Syntax**

`$urltransform` syntax is similar to replacement with regular expressions [in Perl](http://perldoc.perl.org/perlrequick.html#Search-and-replace).
`$urltransform` value is a series of one or more transformations separated by `|`. The first transformation is applied to the input URL. Each of the following transformations is applied to the output of the previous one. The output of a failed transformation (for example, if Base64 decoding failed or if substitution found no matches) is its input, unchanged. Formally:

```text
urltransform = "/" regexp "/" replacement "/" modifiers
urltransform = transforms
transforms = transform | transform "|" transforms
transform = substitute | decode
substitute = "/" regexp "/" replacement "/" modifiers
decode = "b64" | "pct"
```

- **`regexp`** — a regular expression.
- **`replacement`** — a string that will be used to replace the string corresponding to `regexp`.
- **`modifiers`** — a regular expression flags. For example, `i` — insensitive search, or `s` — single-line mode.
- **`substitute`** is similar to replacement with regular expressions [in Perl](https://perldoc.perl.org/perlrequick.html#Search-and-replace).
- **`regexp`** — a regular expression.
- **`replacement`** — a string that replaces whatever is matched by `regexp`. `$1`, `$2`, etc. in the replacement string are replaced with the contents of the corresponding capture group.
- **`modifiers`** — regular expression flags, e.g., `i` for case-insensitive search.
- **`b64`** — decodes a [Base64-encoded](https://datatracker.ietf.org/doc/html/rfc4648) string, both the default and the URL-safe alphabets are supported.
- **`pct`** — decodes a [percent-encoded](https://datatracker.ietf.org/doc/html/rfc3986#section-2.1) string.

In the `$urltransform` value, two characters must be escaped: the comma `,` and the dollar sign `$`. Use the backslash character `\` for this. For example, an escaped comma looks like this: `\,`.

:::info Compatibility

AdGuard products that use a [CoreLibs][] version older than 1.20 only support a single `substitute` transformation for the value of the `$urltransform` modifier.

:::

**Changing the origin**

:::info Compatibility
Expand Down Expand Up @@ -2929,12 +2944,16 @@ Tracking links will now be automatically cleaned up, allowing direct navigation

Rules with the `$urltransform` modifier can only be used [**in trusted filters**](#trusted-filters).

`$urltransform` rules without [content-type modifiers](#content-type-modifiers) will only match requests where the content type is `document`.

:::

:::info Compatibility

Rules with the `$urltransform` modifier are supported by AdGuard for Windows, AdGuard for Mac, AdGuard for Android, and AdGuard for Linux with [CoreLibs][] v1.15 or later.

`$urltransform` rules with [content-type modifiers](#content-type-modifiers) are supported starting from [CoreLibs][] v1.19 or later. In earlier versions, content-type modifiers were not allowed with `$urltransform`.

:::

#### **`$reason`** {#reason-modifier}
Expand Down Expand Up @@ -4655,6 +4674,33 @@ If `pattern` is not set for `$path`, rule will apply only on the main page of we
- `[$domain=example.com,path=/page.html]##.textad` hides a `div` with the class `textad` at `page.html` of `example.com` and all subdomains but not at `another_page.html`
- `[$path=/\\/(sub1|sub2)\\/page\\.html/]##.textad` hides a `div` with the class `textad` at both `/sub1/page.html` and `/sub2/page.html` of any domain (please note the [escaped special characters](#non-basic-rules-modifiers-syntax))

#### Path-in-domain syntax {#path-in-domain-syntax}

For cosmetic rules, you can use a simplified path-in-domain syntax by specifying the path directly in the domain part of the rule instead of using the `$path` modifier.

**Syntax**

```text
rule = [targets] "##" selector
targets = [target0, target1[, ...[, targetN]]]
target = domain [path]
```

**Examples:**

- `example.org/checkout##.promo-banner` — hides `.promo-banner` elements only on checkout pages
- `news.site.com/article##.sidebar-ad` — hides sidebar ads only on article pages
- `domain1.com,example.org/path##.banner` — applies to all pages on `domain1.com` and only `/path` pages on `example.org`
- `/example\.org\/article\d+/##.ad` — hides ads on article pages with numeric IDs

Path-in-domain syntax works with all types of cosmetic rules (`##`, `#@#`, `#$#`, `$$`, `$@$`, `#%#`, `#@%#`)

:::info Compatibility

Path-in-domain syntax has been introduced in [CoreLibs][] v1.20.

:::

#### `$path` modifier limitations {#non-basic-path-modifier-limitations}

:::caution Limitations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -214,3 +214,37 @@ adguard-cli config show outbound_proxy
Configuring `outbound_proxy` via URL is available starting from AdGuard for Linux v1.1.26 nightly and v1.1 stable release.

:::

## Export and import settings

The export/import functionality allows you to backup your AdGuard CLI configuration and restore it on the same or different system. This includes filters, proxy settings, and other configuration options.

### Export settings

To export current AdGuard CLI settings to a ZIP archive, use:

```sh
adguard-cli export-settings
```

You can specify the output path using the `-o` or `--output` flag. This can be either a specific file path or a directory:

```sh
# Export to a specific file
adguard-cli export-settings -o "/path/to/settings.zip"

# Export to a directory (archive will be created with a standard name)
adguard-cli export-settings -o "/path/to/directory"
```

If no output path is specified, the settings will be exported to the working directory with a standard name. After successful export, the command will display the full path where the archive was created.

### Import settings

To import AdGuard CLI settings from a ZIP archive, use:

```sh
adguard-cli import-settings -i "/path/to/settings.zip"
```

The `-i` or `--input` flag is required and specifies the path to the settings archive to import.
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,6 @@ Go to the Applications section. Find AdGuard there, right-click it and choose **
**Use this instruction only if you know what you are doing or if our support service specifically recommended you the 'advanced uninstall'. Also, do all the steps from the "regular uninstall" first.**

1. After that, delete following AdGuard files:
- /Library/Application Support/AdGuard Software/com.adguard.mac.adguard (folder)
- ~/Library/Preferences/com.adguard.mac.adguard.plist (file)
- ~/Library/Group\ Containers/TC3Q7MAJXF.com.adguard.mac (folder)
- /Library/LaunchDaemons/com.adguard.mac.adguard.adguard-pac.daemon.plist (file)
- /Library/LaunchDaemons/com.adguard.mac.adguard.adguard-tun-helper.daemon.plist (file)
Expand All @@ -89,9 +87,6 @@ Go to the Applications section. Find AdGuard there, right-click it and choose **
To do so, open the Terminal app, then enter and execute the following commands:

```bash
sudo rm -R "/Library/Application Support/AdGuard Software/com.adguard.mac.adguard"
rm -R "$HOME/Library/Application Support/com.adguard.mac.adguard"
rm $HOME/Library/Preferences/com.adguard.mac.adguard.plist
rm -R "$HOME/Library/Group Containers/TC3Q7MAJXF.com.adguard.mac"
find "$HOME/Library/Application Support" -name "com.adguard.browser_extension_host.nm.json" -delete
sudo rm /Library/LaunchDaemons/com.adguard.mac.adguard.adguard-pac.daemon.plist
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ When this option is enabled, AdGuard automatically notices when your browser req

AdGuard comes with four pre-installed userscripts:

- AdGuard Assistent (Beta)
- AdGuard Extra
- AdGuard Popup blocker
- Web of Trust
- AdGuard Assistant (Beta)
- AdGuard Extra (Beta)
- AdGuard Popup blocker (Beta)
- Web of Trust (Beta)

### AdGuard Assistant (Beta)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This article describes AdGuard for Windows v8.0, a comprehensive ad blocker that

![Protection tab](https://cdn.adtidy.org/content/kb/ad_blocker/windows/version_8/protection/protection_section.png)

The _Protection_ tab contains all key security and filtering settings. Here you can control _Ad blocking_, _Tracking protection_, _Annoyance blocking_, _DNS filtering_, _Browsing security_, _Parental control_, and _Extensions_. You can also manage AdGuard Assistant here — a tool that lets you control its functionality without opening the app. Each of these features is described in a separate article.
The _Protection_ tab contains all key security and filtering settings. Here you can control _Ad blocking_, _Tracking protection_, _Annoyance blocking_, _DNS protection_, _Browsing security_, _Parental control_, and _Extensions_. You can also manage AdGuard Assistant here — a tool that lets you control its functionality without opening the app. Each of these features is described in a separate article.

[Ad blocking](/adguard-for-windows-8/protection/ad-blocking)

Expand Down
Loading