Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
e909b63
Update installation.md
puglieri Mar 26, 2025
68b567e
Update installation.md
puglieri Mar 26, 2025
b693d6d
Update settings.md
puglieri Mar 26, 2025
cca2136
Update settings.md
puglieri Mar 27, 2025
c122cbe
Update docs/adguard-for-linux/installation.md
puglieri Mar 28, 2025
7589d11
Update docs/adguard-for-linux/installation.md
puglieri Mar 28, 2025
9ce2166
Update docs/adguard-for-linux/installation.md
puglieri Mar 28, 2025
f05d528
Update docs/adguard-for-linux/installation.md
puglieri Mar 28, 2025
5f1d78f
Update docs/adguard-for-linux/installation.md
puglieri Mar 28, 2025
220da75
Update docs/adguard-for-linux/installation.md
puglieri Mar 28, 2025
97f3ad7
Update docs/adguard-for-linux/installation.md
puglieri Mar 28, 2025
39e0ce4
Update docs/adguard-for-linux/installation.md
puglieri Mar 28, 2025
9880321
Update settings.md
puglieri Mar 28, 2025
a001c28
Update installation.md
puglieri Mar 31, 2025
33de84c
Merge branch 'master' into agm-2402-update-adguard-for-linux
puglieri Mar 31, 2025
23a6515
Update installation.md
puglieri Mar 31, 2025
6ddf86d
Update installation.md
puglieri Mar 31, 2025
6060886
Update installation.md
puglieri Mar 31, 2025
98d8570
fix markdown lint (remove trailing spaces)
el-termikael Mar 31, 2025
ccd5598
Update installation.md
puglieri Mar 31, 2025
9c0be84
Update installation.md
puglieri Apr 1, 2025
b51cbdf
Update settings.md
puglieri Apr 1, 2025
8f6ee22
Update installation.md
puglieri Apr 1, 2025
943dbd6
Update settings.md
puglieri Apr 18, 2025
a45d073
Update installation.md
puglieri Apr 21, 2025
3cc8499
Create vpn-cli-interaction.md
puglieri Apr 21, 2025
289b77a
Update settings.md
puglieri Apr 24, 2025
8004546
Update docs/adguard-for-linux/installation.md
puglieri Apr 29, 2025
55bbe5f
Update settings.md and vpn-cli-interaction.md
puglieri Apr 29, 2025
06ff882
Merge branch 'agm-2402-update-adguard-for-linux' of https://github.co…
puglieri Apr 29, 2025
31e833c
Update vpn-cli-interaction.md
puglieri Apr 29, 2025
18721c1
Merge branch 'master' into agm-2402-update-adguard-for-linux
el-termikael Apr 29, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 101 additions & 19 deletions docs/adguard-for-linux/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,27 @@ sidebar_position: 2

## Install AdGuard for Linux

To install AdGuard, enter:
Open the command line on your computer. On Linux, use the keyboard shortcut *Ctrl+Alt+T*. On Mac, type *Terminal* in the search field.

Release
To install AdGuard, choose the version that better suits you (release, beta, or nightly) and enter the respective command.

curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/release/install.sh | sh -s -- -v
**Release**:

Beta
```sh
curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/release/install.sh | sh -s -- -v
```

curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/beta/install.sh | sh -s -- -v
**Beta**:

Nightly
```sh
curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/beta/install.sh | sh -s -- -v
```

**Nightly**:

curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/nightly/install.sh | sh -s -- -v
```sh
curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/nightly/install.sh | sh -s -- -v
```

If required, enter your admin password.

Expand All @@ -29,44 +37,118 @@ You can verify the signature to prove it’s an official version of AdGuard by u

:::

## Activate license
## Initial setup

AdGuard for Linux requires an [AdGuard license](https://adguard.com/license.html). If you don't have a license yet, you can log in or create an account to get a free 14-day trial. If you already have a license, log in to activate it.
AdGuard for Linux requires an [AdGuard license](https://adguard.com/license.html). If you dont have a license yet, you can log in or create an account to get a free 14-day trial. If you already have a license, log in to activate it. To do it, follow this step-by-step guide:

To log in or create an account, enter:
1. After installation, enter:

```sh
adguard-cli activate
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

думаю, команды для терминала стоит выделять ``

```

1. Then select the desired option:

![adguard-cli activate *border](https://cdn.adtidy.org/content/Kb/ad_blocker/linux/activation1.png)

1. Once you have a license, follow the provided link to proceed with the activation:

To reset your license, enter:
![Activate license *border](https://cdn.adtidy.org/content/Kb/ad_blocker/linux/activation2.png)

1. After activation, you can continue to work with the program:

![Successful activation *border](https://cdn.adtidy.org/content/Kb/ad_blocker/linux/activation3.png)

1. You can also reset your license by entering:

```sh
adguard-cli reset-license
```

To view the license info, enter:
or view the license info by entering

```sh
adguard-cli license
```

## Initial setup
1. Now you need to set up AdGuard CLI. To run the configuration wizard, enter:

To get AdGuard up and running, complete the initial setup. This includes installing the AdGuard CA certificate, enabling the necessary filters, and selecting the proxy mode.
```sh
adguard-cli configure
```

To run the configuration wizard, enter:
![Setup *border](https://cdn.adtidy.org/content/Kb/ad_blocker/linux/activation4.png)

adguard-cli configure
The wizard will ask basic questions required for the initial setup.

1. After that, you can start the AdGuard protection by entering
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. After that, you can start the AdGuard protection by entering
1. After that, you can start the AdGuard protection by entering:


```sh
adguard-cli start
```

![Start protecton *border](https://cdn.adtidy.org/content/Kb/ad_blocker/linux/activation5.png)

1. You can check the protection status using:

```sh
adguard-cli status
```

and stop it with:

```sh
adguard-cli stop
```

![Stop protecton *border](https://cdn.adtidy.org/content/Kb/ad_blocker/linux/activation6.png)

1. To check the current configuration, enter:

```sh
adguard-cli config show
```

![Current setup *border](https://cdn.adtidy.org/content/Kb/ad_blocker/linux/activation7.png)

The path to the configuration file will also be displayed, which you can and should edit directly. It contains descriptions of all additional options.

As an alternative, you can use the commands:

```sh
adguard-cli config get
```

or:

```sh
adguard-cli config set
```

They are primarily intended for scripting, though.

For further information on the available commands, check out the section [Settings and protection management](https://adguard.com/kb/adguard-for-linux/settings/).

## Uninstall AdGuard for Linux

To uninstall AdGuard, enter:

Release

curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/release/install.sh | sh -s -- -v -u
```sh
curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/release/install.sh | sh -s -- -v -u
```

Beta

curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/beta/install.sh | sh -s -- -v -u
```sh
curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/beta/install.sh | sh -s -- -v -u
```

Nightly

curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/nightly/install.sh | sh -s -- -v -u
```sh
curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/nightly/install.sh | sh -s -- -v -u
```

If required, enter your admin password.
76 changes: 68 additions & 8 deletions docs/adguard-for-linux/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,43 +3,82 @@ title: Settings and protection management
sidebar_position: 3
---

## Available commands

To get a list of all available AdGuard commands, enter:

adguard-cli --help-all
```sh
adguard-cli --help-all
```

## Enable and disable protection

### Enable protection

To enable protection, enter:

adguard-cli start
```sh
adguard-cli start
```

This command attempts to configure a redirection to the proxy.

![Start protection *border](https://cdn.adtidy.org/content/Kb/ad_blocker/linux/start-protection.gif)

### Disable protection

To disable protection, enter:

adguard-cli stop
```sh
adguard-cli stop
```

This command not only stops the proxy but also stops the trafic from redirecting to it.

### Check protection status

To view the protection status, enter:

adguard-cli status
```sh
adguard-cli status
```

![Status/Stop protection *border](https://cdn.adtidy.org/content/Kb/ad_blocker/linux/activation6.png)

## Updates

## Check for updates
### Check for updates

To check for updates, enter:

adguard-cli check-update
```sh
adguard-cli check-update
```

### Update AdGuard for Linux

To update AdGuard for Linux, enter:

adguard-cli update
```sh
adguard-cli update
```

### Update script output

To view the update script output, enter:

adguard-cli update -v
```sh
adguard-cli update -v
```

## Configure AdGuard for Linux

Use the `config` command to configure AdGuard for Linux. Subcommands:

- `show`: Show the current configuration in `proxy.yaml`

![Current setup *border](https://cdn.adtidy.org/content/Kb/ad_blocker/linux/activation7.png)

- `set`: Configure an option in `proxy.yaml`
- `listen_ports.http_proxy`: HTTP listening port
- `proxy_mode`: Proxy mode (`manual` or `auto`)
Expand All @@ -51,7 +90,28 @@ Use the `filters` command to configure AdGuard for Linux. Subcommands:

- `list`: List installed filters
- `--all`: View all filters

![Filter list *border](https://cdn.adtidy.org/content/Kb/ad_blocker/linux/filter-list.png)

- `install`: Install a filter. Enter the URL of the filter you want to install
- `enable`: Enable a filter. Enter the name or ID of the filter

![Enable filters *border](https://cdn.adtidy.org/content/Kb/ad_blocker/linux/built-in-filters.png)

- `disable`: Disable a filter. Enter the name or ID of the filter
- `update`: Update filters

## Changing the proxy server listen address in manual proxy mode

By default, the proxy server listens on `127.0.0.1` — the address of the loopback network interface.
There are two ways to make the proxy server listen on a different interface:

1. Run `adguard-cli config set listen_address <address>` where `<address>` is the address to listen on.
2. Edit the config file directly:
- To determine the location of the config file, run `adguard-cli config show | grep "Config location"`.
- Look for the `listen_address` key and set its value accordingly. To listen on all available network interfaces, set the listen address to `0.0.0.0` or `::`.

If the listen address is set to anything other than `127.0.0.1`, then proxy client authentication is required. AdGuard CLI will not start unless proxy authentication is configured:

- When running `adguard-cli config set listen_address <address>` where `<address>` is not `127.0.0.1`, AdGuard CLI will prompt for a username and password if proxy authentication is not already configured.
- When editing the config file directly, look for the `listen_auth`key. Set the `enabled` sub-key to `true`, and `username` and `password` to non-empty values.
16 changes: 16 additions & 0 deletions docs/adguard-for-linux/vpn-cli-interaction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: AdGuard VPN CLI interaction
sidebar_position: 5
---

## AdGuard VPN CLI interaction

Using AdGuard CLI in **automatic proxy mode** together with AdGuard VPN CLI in **tunnel mode** is impossible due to a routing loop: AdGuard VPN CLI's traffic currently can not be excluded from being transparently proxied by AdGuard CLI, and AdGuard CLI's traffic must go through the AdGuard VPN CLI's tunnel.

These are the two possible solutions:

- Switch AdGuard CLI to **manual proxy mode**.
- In this case, AdGuard VPN CLI can be used in **tunnel mode**, but apps for which ad blocking is desired must be manually configured to use the AdGuard CLI's proxy.
- Switch AdGuard VPN CLI to **SOCKS5 mode**, and configure AdGuard CLI with an outbound proxy pointing to the SOCKS5 interface of AdGuard VPN CLI. In this case, it's important to keep in mind that:
- For an app's traffic to go through the VPN tunnel it must either have its traffic transparently proxied by AdGuard CLI (which is the case for all apps by default), or manually configured to use AdGuard VPN CLI's SOCKS5 interface.
- In order to avoid a routing loop, the `skip_outbound_proxy` option must be enabled for AdGuard VPN CLI in AdGuard CLI's apps configuration section. By default, `skip_outbound_proxy` is enabled for all apps with `vpn` in their name, including AdGuard VPN CLI.