Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add articles about AdGuard for Linux #612

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
6 changes: 6 additions & 0 deletions docs/adguard-for-linux/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"position": 10,
"label": "AdGuard for Linux",
"collapsible": true,
"collapsed": true
}
18 changes: 18 additions & 0 deletions docs/adguard-for-linux/adguard-for-linux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: AdGuard for Linux
sidebar_position: 1
---

AdGuard for Linux, also known as AdGuard CLI, is a command-line ad blocker. You can use it on Linux or macOS devices.

Below are commands you may need to log in, enable protection, and manage the AdGuard settings.

- [Installation, setup, and removal](/adguard-for-linux/installation)
- [Settings and protection management](/adguard-for-linux/settings)
- [Sending feedback](/adguard-for-linux/feedback)

On Linux, press `Ctrl+Alt+T`. On your Mac, type `Terminal` in the search field.

To view all available commands, enter:

adguard-cli --help-all
37 changes: 37 additions & 0 deletions docs/adguard-for-linux/feedback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Sending feedback
sidebar_position: 4
---

## Report a problem or suggest a feature

If you’ve found a bug in AdGuard for Linux or would like to suggest a new feature, here’s how to do it:

- Fill out the [feedback form](https://surveys.adguard.com/en/adguard_linux/form.html).
- Create a [GitHub issue](https://github.com/AdguardTeam/AdGuardCLI/issues/new/choose). But before you do, check the [repository](https://github.com/AdguardTeam/AdGuardCLI/issues?q=is%3Aissue) for similar issues.

:::note
el-termikael marked this conversation as resolved.
Show resolved Hide resolved

If you want to support the implementation of a new feature or bugfix, you can vote for it on GitHub. To vote, just react with some emoji.

:::

## Collect and send logs

1. Enable debug logging:

`adguard-cli config set log_level debug`

1. Reproduce the problem and try to remember the exact time it occurred.

1. Wait a while, then export the logs:

`adguard-cli export-logs`

The archived log file will be downloaded to the application folder by default, and the path to the logs will be written to the console.

1. Send the log file to <[email protected]>. Specify the time of the error and attach a link to your GitHub issue or its number (it appears as #number next to the title). Alternatively, you can upload the log file to Google Drive and share it with <[email protected]>. Attach the file link to your GitHub issue.

1. Switch the logging mode back to `info`:

`adguard-cli config set log_level info`
72 changes: 72 additions & 0 deletions docs/adguard-for-linux/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: Installation, setup, and removal
sidebar_position: 2
---

## Install AdGuard for Linux

To install AdGuard, enter:

Release

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

Beta

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

If required, enter your admin password.

Press `y` to create a link in `/usr/local/bin` to the executable and wait until the installation is complete.

:::note
el-termikael marked this conversation as resolved.
Show resolved Hide resolved

You can verify the signature to prove it’s an official version of AdGuard by using the `gpg` tool. [Read more on GitHub](https://github.com/AdguardTeam/AdGuardCLI?tab=readme-ov-file#verify-releases)

:::

## Activate license

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.

To log in or create an account, enter:

adguard-cli activate

To reset your license, enter:

adguard-cli reset-license

To view the license info, enter:

adguard-cli license

## Initial setup

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.

To run the configuration wizard, enter:

adguard-cli configure

## Uninstall AdGuard for Linux

To uninstall AdGuard, enter:

Release

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

Nightly

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

If required, enter your admin password.
57 changes: 57 additions & 0 deletions docs/adguard-for-linux/settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: Settings and protection management
sidebar_position: 3
---

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

adguard-cli --help-all

## Enable and disable protection

To enable protection, enter:

adguard-cli start

To disable protection, enter:

adguard-cli stop

To view the protection status, enter:

adguard-cli status

## Check for updates

To check for updates, enter:

adguard-cli check-update

To update AdGuard for Linux, enter:

adguard-cli update

To view the update script output, enter:

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`
- `set`: Configure an option in `proxy.yaml`
- `listen_ports.http_proxy`: HTTP listening port
- `proxy_mode`: Proxy mode (`manual` or `auto`)
- `get`: Get the current status of the above options

## Manage filters

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

- `list`: List installed filters
- `--all`: View all filters
- `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
- `disable`: Disable a filter. Enter the name or ID of the filter
- `update`: Update filters
4 changes: 2 additions & 2 deletions docs/guides/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"position": 11,
"position": 12,
"label": "Guides",
"collapsible": true,
"collapsed": true
}
}
4 changes: 2 additions & 2 deletions docs/miscellaneous/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"position": 10,
"position": 11,
"label": "Miscellaneous",
"collapsible": true,
"collapsed": true
}
}
Loading