From f5ad4b3cf5b239e19661086c576033b03f1dba5c Mon Sep 17 00:00:00 2001 From: ss-orlova <95080242+sonya-orlova@users.noreply.github.com> Date: Fri, 22 Nov 2024 19:18:34 +0300 Subject: [PATCH 1/9] Add articles about AdGuard for Linux To be merged after the official release --- docs/adguard-for-linux/_category_.json | 6 ++ docs/adguard-for-linux/adguard-for-linux.md | 18 ++++++ docs/adguard-for-linux/feedback.md | 35 +++++++++++ docs/adguard-for-linux/installation.md | 70 +++++++++++++++++++++ docs/adguard-for-linux/settings.md | 57 +++++++++++++++++ docs/guides/_category_.json | 4 +- docs/miscellaneous/_category_.json | 4 +- 7 files changed, 190 insertions(+), 4 deletions(-) create mode 100644 docs/adguard-for-linux/_category_.json create mode 100644 docs/adguard-for-linux/adguard-for-linux.md create mode 100644 docs/adguard-for-linux/feedback.md create mode 100644 docs/adguard-for-linux/installation.md create mode 100644 docs/adguard-for-linux/settings.md diff --git a/docs/adguard-for-linux/_category_.json b/docs/adguard-for-linux/_category_.json new file mode 100644 index 00000000000..8b25f567969 --- /dev/null +++ b/docs/adguard-for-linux/_category_.json @@ -0,0 +1,6 @@ +{ + "position": 10, + "label": "AdGuard for Linux", + "collapsible": true, + "collapsed": true +} diff --git a/docs/adguard-for-linux/adguard-for-linux.md b/docs/adguard-for-linux/adguard-for-linux.md new file mode 100644 index 00000000000..cd8a466a194 --- /dev/null +++ b/docs/adguard-for-linux/adguard-for-linux.md @@ -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 diff --git a/docs/adguard-for-linux/feedback.md b/docs/adguard-for-linux/feedback.md new file mode 100644 index 00000000000..eba6da0e6c6 --- /dev/null +++ b/docs/adguard-for-linux/feedback.md @@ -0,0 +1,35 @@ +--- +title: Sending feedback +sidebar_position: 4 +--- + +## Report a problem or suggest a feature + +If you’ve found a bug in AdGuard for Linux or want 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 +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 standaloneServer.logLevel 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 . 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 . Attach the file link to your GitHub issue. + +1. Switch the logging mode back to `info`: + + `adguard-cli config set standaloneServer.logLevel info` diff --git a/docs/adguard-for-linux/installation.md b/docs/adguard-for-linux/installation.md new file mode 100644 index 00000000000..7a28059f8f7 --- /dev/null +++ b/docs/adguard-for-linux/installation.md @@ -0,0 +1,70 @@ +--- +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 +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-fay 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. diff --git a/docs/adguard-for-linux/settings.md b/docs/adguard-for-linux/settings.md new file mode 100644 index 00000000000..1f66e3e26b8 --- /dev/null +++ b/docs/adguard-for-linux/settings.md @@ -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 filter name or ID +- `disable`: Disable a filter. Enter the filter name or ID +- `update`: Update filters diff --git a/docs/guides/_category_.json b/docs/guides/_category_.json index abd7aa629cb..338c5466d99 100644 --- a/docs/guides/_category_.json +++ b/docs/guides/_category_.json @@ -1,6 +1,6 @@ { - "position": 11, + "position": 12, "label": "Guides", "collapsible": true, "collapsed": true -} \ No newline at end of file +} diff --git a/docs/miscellaneous/_category_.json b/docs/miscellaneous/_category_.json index b95d1f6c0ee..e71860bef9e 100644 --- a/docs/miscellaneous/_category_.json +++ b/docs/miscellaneous/_category_.json @@ -1,6 +1,6 @@ { - "position": 10, + "position": 11, "label": "Miscellaneous", "collapsible": true, "collapsed": true -} \ No newline at end of file +} From 2eacca0b35dc9b71e9e972b19720f6579764fa4e Mon Sep 17 00:00:00 2001 From: ss-orlova <95080242+sonya-orlova@users.noreply.github.com> Date: Fri, 22 Nov 2024 22:46:37 +0300 Subject: [PATCH 2/9] FIx formatting --- docs/adguard-for-linux/installation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/adguard-for-linux/installation.md b/docs/adguard-for-linux/installation.md index 7a28059f8f7..2e0e4fa1787 100644 --- a/docs/adguard-for-linux/installation.md +++ b/docs/adguard-for-linux/installation.md @@ -61,10 +61,10 @@ Release Beta - curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/beta/install.sh | sh -s -- -v -u + 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 + curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardCLI/nightly/install.sh | sh -s -- -v -u If required, enter your admin password. From 1de890e5bb4dd1b4e2a5f4010dc550305153f535 Mon Sep 17 00:00:00 2001 From: ss-orlova <95080242+sonya-orlova@users.noreply.github.com> Date: Fri, 22 Nov 2024 22:48:05 +0300 Subject: [PATCH 3/9] Fix typo --- docs/adguard-for-linux/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adguard-for-linux/installation.md b/docs/adguard-for-linux/installation.md index 2e0e4fa1787..dacb54d2732 100644 --- a/docs/adguard-for-linux/installation.md +++ b/docs/adguard-for-linux/installation.md @@ -29,7 +29,7 @@ You can verify the signature to prove it’s an official version of AdGuard by u ## 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-fay 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 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: From 23cd49f58e766629006f166fbdd24ccd46b49bd0 Mon Sep 17 00:00:00 2001 From: ss-orlova <95080242+sonya-orlova@users.noreply.github.com> Date: Mon, 25 Nov 2024 11:41:17 +0300 Subject: [PATCH 4/9] Add missing dot --- docs/adguard-for-linux/feedback.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adguard-for-linux/feedback.md b/docs/adguard-for-linux/feedback.md index eba6da0e6c6..106a8e5e792 100644 --- a/docs/adguard-for-linux/feedback.md +++ b/docs/adguard-for-linux/feedback.md @@ -7,7 +7,7 @@ sidebar_position: 4 If you’ve found a bug in AdGuard for Linux or want 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) +- 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 From 0d41c0b77286dee214b978d57fccbd1bc03bdb6c Mon Sep 17 00:00:00 2001 From: Sofia Orlova <95080242+sonya-orlova@users.noreply.github.com> Date: Mon, 25 Nov 2024 17:26:39 +0200 Subject: [PATCH 5/9] Update docs/adguard-for-linux/settings.md Co-authored-by: Helen <58733007+el-termikael@users.noreply.github.com> --- docs/adguard-for-linux/settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adguard-for-linux/settings.md b/docs/adguard-for-linux/settings.md index 1f66e3e26b8..f1e6aa485c1 100644 --- a/docs/adguard-for-linux/settings.md +++ b/docs/adguard-for-linux/settings.md @@ -52,6 +52,6 @@ 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 filter name or ID +- `enable`: Enable a filter. Enter the name or ID of the filter - `disable`: Disable a filter. Enter the filter name or ID - `update`: Update filters From 7d3b4e107d35597faffb257b6e31896e555add26 Mon Sep 17 00:00:00 2001 From: Sofia Orlova <95080242+sonya-orlova@users.noreply.github.com> Date: Mon, 25 Nov 2024 17:26:46 +0200 Subject: [PATCH 6/9] Update docs/adguard-for-linux/feedback.md Co-authored-by: Helen <58733007+el-termikael@users.noreply.github.com> --- docs/adguard-for-linux/feedback.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adguard-for-linux/feedback.md b/docs/adguard-for-linux/feedback.md index 106a8e5e792..8af9f7c16c6 100644 --- a/docs/adguard-for-linux/feedback.md +++ b/docs/adguard-for-linux/feedback.md @@ -5,7 +5,7 @@ sidebar_position: 4 ## Report a problem or suggest a feature -If you’ve found a bug in AdGuard for Linux or want to suggest a new feature, here’s how to do it: +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. From 02a3325b55c2f2caf860006a62c0d7ecb03a3113 Mon Sep 17 00:00:00 2001 From: ss-orlova <95080242+sonya-orlova@users.noreply.github.com> Date: Mon, 25 Nov 2024 18:29:27 +0300 Subject: [PATCH 7/9] Small fixes --- docs/adguard-for-linux/feedback.md | 4 +++- docs/adguard-for-linux/installation.md | 2 ++ docs/adguard-for-linux/settings.md | 2 +- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/adguard-for-linux/feedback.md b/docs/adguard-for-linux/feedback.md index 8af9f7c16c6..9778b671425 100644 --- a/docs/adguard-for-linux/feedback.md +++ b/docs/adguard-for-linux/feedback.md @@ -8,10 +8,12 @@ sidebar_position: 4 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. +- 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 + 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 diff --git a/docs/adguard-for-linux/installation.md b/docs/adguard-for-linux/installation.md index dacb54d2732..b97db56233c 100644 --- a/docs/adguard-for-linux/installation.md +++ b/docs/adguard-for-linux/installation.md @@ -24,7 +24,9 @@ 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 + 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 diff --git a/docs/adguard-for-linux/settings.md b/docs/adguard-for-linux/settings.md index f1e6aa485c1..9c691945623 100644 --- a/docs/adguard-for-linux/settings.md +++ b/docs/adguard-for-linux/settings.md @@ -53,5 +53,5 @@ Use the `filters` command to configure AdGuard for Linux. Subcommands: - `--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 filter name or ID +- `disable`: Disable a filter. Enter the name or ID of the filter - `update`: Update filters From 6763b17d96199a50a2f9b0f4af0b360e1236f065 Mon Sep 17 00:00:00 2001 From: ss-orlova <95080242+sonya-orlova@users.noreply.github.com> Date: Tue, 26 Nov 2024 14:40:01 +0300 Subject: [PATCH 8/9] Update command for resetting license --- docs/adguard-for-linux/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adguard-for-linux/installation.md b/docs/adguard-for-linux/installation.md index b97db56233c..bee9385b2b0 100644 --- a/docs/adguard-for-linux/installation.md +++ b/docs/adguard-for-linux/installation.md @@ -39,7 +39,7 @@ To log in or create an account, enter: To reset your license, enter: - adguard-cli reset-license + adguard-cli reset-activation To view the license info, enter: From 2410cf950c5e4e41c3464c3c900c403dc15de630 Mon Sep 17 00:00:00 2001 From: ss-orlova <95080242+sonya-orlova@users.noreply.github.com> Date: Wed, 4 Dec 2024 18:45:56 +0300 Subject: [PATCH 9/9] Update some commands --- docs/adguard-for-linux/feedback.md | 4 ++-- docs/adguard-for-linux/installation.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/adguard-for-linux/feedback.md b/docs/adguard-for-linux/feedback.md index 9778b671425..9f35eb3733e 100644 --- a/docs/adguard-for-linux/feedback.md +++ b/docs/adguard-for-linux/feedback.md @@ -20,7 +20,7 @@ If you want to support the implementation of a new feature or bugfix, you can vo 1. Enable debug logging: - `adguard-cli config set standaloneServer.logLevel debug` + `adguard-cli config set log_level debug` 1. Reproduce the problem and try to remember the exact time it occurred. @@ -34,4 +34,4 @@ If you want to support the implementation of a new feature or bugfix, you can vo 1. Switch the logging mode back to `info`: - `adguard-cli config set standaloneServer.logLevel info` + `adguard-cli config set log_level info` diff --git a/docs/adguard-for-linux/installation.md b/docs/adguard-for-linux/installation.md index bee9385b2b0..b97db56233c 100644 --- a/docs/adguard-for-linux/installation.md +++ b/docs/adguard-for-linux/installation.md @@ -39,7 +39,7 @@ To log in or create an account, enter: To reset your license, enter: - adguard-cli reset-activation + adguard-cli reset-license To view the license info, enter: