From 5c4a42c71aed509a47d1212727eb1f96c09037c6 Mon Sep 17 00:00:00 2001 From: vyanovsky <51786050+vyanovsky@users.noreply.github.com> Date: Fri, 29 Nov 2024 18:23:35 +0900 Subject: [PATCH 01/14] Create exclusions.md in VPN for Linux section --- docs/adguard-vpn-for-linux/exclusions.md | 56 ++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 docs/adguard-vpn-for-linux/exclusions.md diff --git a/docs/adguard-vpn-for-linux/exclusions.md b/docs/adguard-vpn-for-linux/exclusions.md new file mode 100644 index 000000000..978d90af4 --- /dev/null +++ b/docs/adguard-vpn-for-linux/exclusions.md @@ -0,0 +1,56 @@ +--- +title: Exclusions +sidebar_position: 7 +--- + +*Exclusions* feature lets you decide which domains’ traffic should be excluded from VPN routing. This is handy when you don’t need VPN to work for some websites, because it saves you the hassle of constantly turning VPN on and off. + +Just like in AdGuard VPN for other platforms, in AdGuard VPN for Linux you can use Exclusions in two modes: General (VPN is enabled for all domains except for those in the exclusion list) and Selective (VPN is enabled only for the domains in the exclusion list). + +:::note + +Each mode has its own exclusion list. + +::: + +![Exclusions](https://cdn.adtidy.org/blog/new/m6pkdVPN-CLI-exclusions.png) + +### How to use + +To view all exclusion-related commands, type: + +`adguardvpn-cli site-exclusions -h` + +To add a domain to the exclusion list of the current mode, type: + +`adguardvpn-cli site-exclusions add %domain_name%` + +> Supported input formats: `domain.com`, `sub.domain.com`, `www.domain.com`. Use double quotes for wildcards: `"*.domain.com"` +> +> Command example: `adguardvpn-cli site-exclusions add https://www.google.com/` + +To remove a domain from the list of exclusions, type: + +`adguardvpn-cli site-exclusions remove %domain_name%` + +To view the current exclusion list, type: + +`adguardvpn-cli site-exclusions show` + +To remove all exclusions, type: + +`adguardvpn-cli site-exclusions clear` + +To change the exclusion mode, type: + +`adguardvpn-cli site-exclusions mode %mode_name%` (or you can just check the current mode using `adguardvpn-cli site-exclusions mode`) + +where %mode_name% is `general` or `selective`. + +:::note + +The commands listed above (`add`, `remove`, `show`, `clear`) are applied to the exclusion list of the current mode. To perform a command for a specific mode, add `--for-mode %mode_name% type`, for example: + +`adguardvpn-cli site-exclusions add %domain_name% --for-mode %mode_name%` + +::: From cfdb0da61b6f9c25b12386309c95589e11ea6ec0 Mon Sep 17 00:00:00 2001 From: vyanovsky <51786050+vyanovsky@users.noreply.github.com> Date: Fri, 29 Nov 2024 19:24:36 +0900 Subject: [PATCH 02/14] Update login.md - add info about subscription command --- docs/adguard-vpn-for-linux/login.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/adguard-vpn-for-linux/login.md b/docs/adguard-vpn-for-linux/login.md index e8b275b50..8c1db7421 100644 --- a/docs/adguard-vpn-for-linux/login.md +++ b/docs/adguard-vpn-for-linux/login.md @@ -44,3 +44,11 @@ If required, enter your admin password. To check for updates, type: adguardvpn-cli check-update + +## Check your subscription info + +To check your current subscription information and status, type: + +`adguardvpn-cli license` + +You will see your email and subscription type. Paid users will also see the expiration date of their subscription. From bb8e7bbebd4166e42ac9e9c6f0bf0e935650ba5b Mon Sep 17 00:00:00 2001 From: vyanovsky <51786050+vyanovsky@users.noreply.github.com> Date: Fri, 29 Nov 2024 20:49:56 +0900 Subject: [PATCH 03/14] Create autocomplete.md - adds info about autocomplete feature --- docs/autocomplete.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 docs/autocomplete.md diff --git a/docs/autocomplete.md b/docs/autocomplete.md new file mode 100644 index 000000000..4cf1594ff --- /dev/null +++ b/docs/autocomplete.md @@ -0,0 +1,14 @@ +--- +title: Command-line completion +sidebar_position: 5 +--- + +To make navigating through different and, sometimes, pretty long commands easier, you can use the command-line completion feature. + +To enable it, see the bash-completion hint that is shown after installing or updating AdGuard VPN for Linux: + +![bash-completion hint](https://cdn.adtidy.org/blog/new/6x3djbash-completion-hint.png) + +To use the feature, just start typing the command you want and hit the Tab ↹ key — the command will automatically complete with a necessary word or will show a choice of completion options. + +![bash-completion locations command](https://cdn.adtidy.org/blog/new/1g4nhVPN-CLI-autocomplete.png) From c061b631fad640eefb26a305aac5e12b164bda68 Mon Sep 17 00:00:00 2001 From: vyanovsky <51786050+vyanovsky@users.noreply.github.com> Date: Fri, 29 Nov 2024 20:59:56 +0900 Subject: [PATCH 04/14] Update exclusions.md fix trailing space --- docs/adguard-vpn-for-linux/exclusions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adguard-vpn-for-linux/exclusions.md b/docs/adguard-vpn-for-linux/exclusions.md index 978d90af4..14277cfec 100644 --- a/docs/adguard-vpn-for-linux/exclusions.md +++ b/docs/adguard-vpn-for-linux/exclusions.md @@ -5,7 +5,7 @@ sidebar_position: 7 *Exclusions* feature lets you decide which domains’ traffic should be excluded from VPN routing. This is handy when you don’t need VPN to work for some websites, because it saves you the hassle of constantly turning VPN on and off. -Just like in AdGuard VPN for other platforms, in AdGuard VPN for Linux you can use Exclusions in two modes: General (VPN is enabled for all domains except for those in the exclusion list) and Selective (VPN is enabled only for the domains in the exclusion list). +Just like in AdGuard VPN for other platforms, in AdGuard VPN for Linux you can use Exclusions in two modes: General (VPN is enabled for all domains except for those in the exclusion list) and Selective (VPN is enabled only for the domains in the exclusion list). :::note From fbea059e0d25088ca79d04780fa84fdc798978d2 Mon Sep 17 00:00:00 2001 From: vyanovsky <51786050+vyanovsky@users.noreply.github.com> Date: Fri, 29 Nov 2024 21:01:35 +0900 Subject: [PATCH 05/14] Update autocomplete.md fix trailing spaces --- docs/autocomplete.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/autocomplete.md b/docs/autocomplete.md index 4cf1594ff..374457be8 100644 --- a/docs/autocomplete.md +++ b/docs/autocomplete.md @@ -3,9 +3,9 @@ title: Command-line completion sidebar_position: 5 --- -To make navigating through different and, sometimes, pretty long commands easier, you can use the command-line completion feature. +To make navigating through different and, sometimes, pretty long commands easier, you can use the command-line completion feature. -To enable it, see the bash-completion hint that is shown after installing or updating AdGuard VPN for Linux: +To enable it, see the bash-completion hint that is shown after installing or updating AdGuard VPN for Linux: ![bash-completion hint](https://cdn.adtidy.org/blog/new/6x3djbash-completion-hint.png) From f1d21367566481e7546a31607319ceff2d420ddd Mon Sep 17 00:00:00 2001 From: vyanovsky <51786050+vyanovsky@users.noreply.github.com> Date: Fri, 29 Nov 2024 21:12:34 +0900 Subject: [PATCH 06/14] Update exclusions.md - add one sentence about commas --- docs/adguard-vpn-for-linux/exclusions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adguard-vpn-for-linux/exclusions.md b/docs/adguard-vpn-for-linux/exclusions.md index 14277cfec..a56515584 100644 --- a/docs/adguard-vpn-for-linux/exclusions.md +++ b/docs/adguard-vpn-for-linux/exclusions.md @@ -25,7 +25,7 @@ To add a domain to the exclusion list of the current mode, type: `adguardvpn-cli site-exclusions add %domain_name%` -> Supported input formats: `domain.com`, `sub.domain.com`, `www.domain.com`. Use double quotes for wildcards: `"*.domain.com"` +> Supported input formats: `domain.com`, `sub.domain.com`, `www.domain.com`. To add two or more exclusions at once, list them comma-separated. Use double quotes for wildcards: `"*.domain.com"` > > Command example: `adguardvpn-cli site-exclusions add https://www.google.com/` From 5628b0bb46ce540a5c1660a9f2d4554d27451b13 Mon Sep 17 00:00:00 2001 From: vyanovsky <51786050+vyanovsky@users.noreply.github.com> Date: Fri, 29 Nov 2024 21:15:25 +0900 Subject: [PATCH 07/14] Delete docs/autocomplete.md --- docs/autocomplete.md | 14 -------------- 1 file changed, 14 deletions(-) delete mode 100644 docs/autocomplete.md diff --git a/docs/autocomplete.md b/docs/autocomplete.md deleted file mode 100644 index 374457be8..000000000 --- a/docs/autocomplete.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Command-line completion -sidebar_position: 5 ---- - -To make navigating through different and, sometimes, pretty long commands easier, you can use the command-line completion feature. - -To enable it, see the bash-completion hint that is shown after installing or updating AdGuard VPN for Linux: - -![bash-completion hint](https://cdn.adtidy.org/blog/new/6x3djbash-completion-hint.png) - -To use the feature, just start typing the command you want and hit the Tab ↹ key — the command will automatically complete with a necessary word or will show a choice of completion options. - -![bash-completion locations command](https://cdn.adtidy.org/blog/new/1g4nhVPN-CLI-autocomplete.png) From 4d86eef6d7e105baee7d2394a091c4781a7f235d Mon Sep 17 00:00:00 2001 From: vyanovsky <51786050+vyanovsky@users.noreply.github.com> Date: Fri, 29 Nov 2024 21:16:19 +0900 Subject: [PATCH 08/14] Create autocomplete.md in proper destination --- docs/adguard-vpn-for-linux/autocomplete.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 docs/adguard-vpn-for-linux/autocomplete.md diff --git a/docs/adguard-vpn-for-linux/autocomplete.md b/docs/adguard-vpn-for-linux/autocomplete.md new file mode 100644 index 000000000..374457be8 --- /dev/null +++ b/docs/adguard-vpn-for-linux/autocomplete.md @@ -0,0 +1,14 @@ +--- +title: Command-line completion +sidebar_position: 5 +--- + +To make navigating through different and, sometimes, pretty long commands easier, you can use the command-line completion feature. + +To enable it, see the bash-completion hint that is shown after installing or updating AdGuard VPN for Linux: + +![bash-completion hint](https://cdn.adtidy.org/blog/new/6x3djbash-completion-hint.png) + +To use the feature, just start typing the command you want and hit the Tab ↹ key — the command will automatically complete with a necessary word or will show a choice of completion options. + +![bash-completion locations command](https://cdn.adtidy.org/blog/new/1g4nhVPN-CLI-autocomplete.png) From 81bf56649a1c251674e4204be519855bb52d1d74 Mon Sep 17 00:00:00 2001 From: vyanovsky <51786050+vyanovsky@users.noreply.github.com> Date: Fri, 29 Nov 2024 21:27:18 +0900 Subject: [PATCH 09/14] Update login.md - make subscription command copyable --- docs/adguard-vpn-for-linux/login.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adguard-vpn-for-linux/login.md b/docs/adguard-vpn-for-linux/login.md index 8c1db7421..6c13b2e4d 100644 --- a/docs/adguard-vpn-for-linux/login.md +++ b/docs/adguard-vpn-for-linux/login.md @@ -49,6 +49,6 @@ To check for updates, type: To check your current subscription information and status, type: -`adguardvpn-cli license` + adguardvpn-cli license You will see your email and subscription type. Paid users will also see the expiration date of their subscription. From 327e2f592a156e52348d48351d6becbad477204a Mon Sep 17 00:00:00 2001 From: vyanovsky <51786050+vyanovsky@users.noreply.github.com> Date: Fri, 29 Nov 2024 21:30:34 +0900 Subject: [PATCH 10/14] Update exclusions.md - made all commands copyable --- docs/adguard-vpn-for-linux/exclusions.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/adguard-vpn-for-linux/exclusions.md b/docs/adguard-vpn-for-linux/exclusions.md index a56515584..1e0e83d50 100644 --- a/docs/adguard-vpn-for-linux/exclusions.md +++ b/docs/adguard-vpn-for-linux/exclusions.md @@ -19,11 +19,11 @@ Each mode has its own exclusion list. To view all exclusion-related commands, type: -`adguardvpn-cli site-exclusions -h` + adguardvpn-cli site-exclusions -h To add a domain to the exclusion list of the current mode, type: -`adguardvpn-cli site-exclusions add %domain_name%` + adguardvpn-cli site-exclusions add %domain_name% > Supported input formats: `domain.com`, `sub.domain.com`, `www.domain.com`. To add two or more exclusions at once, list them comma-separated. Use double quotes for wildcards: `"*.domain.com"` > @@ -31,19 +31,21 @@ To add a domain to the exclusion list of the current mode, type: To remove a domain from the list of exclusions, type: -`adguardvpn-cli site-exclusions remove %domain_name%` + adguardvpn-cli site-exclusions remove %domain_name% To view the current exclusion list, type: -`adguardvpn-cli site-exclusions show` + adguardvpn-cli site-exclusions show To remove all exclusions, type: -`adguardvpn-cli site-exclusions clear` + adguardvpn-cli site-exclusions clear To change the exclusion mode, type: -`adguardvpn-cli site-exclusions mode %mode_name%` (or you can just check the current mode using `adguardvpn-cli site-exclusions mode`) + adguardvpn-cli site-exclusions mode %mode_name% + +(or you can just check the current mode using `adguardvpn-cli site-exclusions mode`) where %mode_name% is `general` or `selective`. @@ -51,6 +53,6 @@ where %mode_name% is `general` or `selective`. The commands listed above (`add`, `remove`, `show`, `clear`) are applied to the exclusion list of the current mode. To perform a command for a specific mode, add `--for-mode %mode_name% type`, for example: -`adguardvpn-cli site-exclusions add %domain_name% --for-mode %mode_name%` + adguardvpn-cli site-exclusions add %domain_name% --for-mode %mode_name% ::: From 457243a832a4b9f91960db3f905eae61a5e6256f Mon Sep 17 00:00:00 2001 From: vyanovsky <51786050+vyanovsky@users.noreply.github.com> Date: Fri, 29 Nov 2024 21:36:38 +0900 Subject: [PATCH 11/14] Update exclusions.md - fix trailing spaces --- docs/adguard-vpn-for-linux/exclusions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/adguard-vpn-for-linux/exclusions.md b/docs/adguard-vpn-for-linux/exclusions.md index 1e0e83d50..bd7e35cee 100644 --- a/docs/adguard-vpn-for-linux/exclusions.md +++ b/docs/adguard-vpn-for-linux/exclusions.md @@ -44,7 +44,7 @@ To remove all exclusions, type: To change the exclusion mode, type: adguardvpn-cli site-exclusions mode %mode_name% - + (or you can just check the current mode using `adguardvpn-cli site-exclusions mode`) where %mode_name% is `general` or `selective`. @@ -53,6 +53,6 @@ where %mode_name% is `general` or `selective`. The commands listed above (`add`, `remove`, `show`, `clear`) are applied to the exclusion list of the current mode. To perform a command for a specific mode, add `--for-mode %mode_name% type`, for example: - adguardvpn-cli site-exclusions add %domain_name% --for-mode %mode_name% + adguardvpn-cli site-exclusions add %domain_name% --for-mode %mode_name%` ::: From 74e89209d61f48cc1e0344c16c336463a2aceccc Mon Sep 17 00:00:00 2001 From: vyanovsky <51786050+vyanovsky@users.noreply.github.com> Date: Fri, 29 Nov 2024 22:15:16 +0900 Subject: [PATCH 12/14] Update exclusions.md - delete one symbol --- docs/adguard-vpn-for-linux/exclusions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adguard-vpn-for-linux/exclusions.md b/docs/adguard-vpn-for-linux/exclusions.md index bd7e35cee..0d4830068 100644 --- a/docs/adguard-vpn-for-linux/exclusions.md +++ b/docs/adguard-vpn-for-linux/exclusions.md @@ -53,6 +53,6 @@ where %mode_name% is `general` or `selective`. The commands listed above (`add`, `remove`, `show`, `clear`) are applied to the exclusion list of the current mode. To perform a command for a specific mode, add `--for-mode %mode_name% type`, for example: - adguardvpn-cli site-exclusions add %domain_name% --for-mode %mode_name%` + adguardvpn-cli site-exclusions add %domain_name% --for-mode %mode_name% ::: From 1a05d7bcb9bcd27a03e2834f38aee95d097aebb3 Mon Sep 17 00:00:00 2001 From: vyanovsky <51786050+vyanovsky@users.noreply.github.com> Date: Sat, 30 Nov 2024 00:54:19 +0900 Subject: [PATCH 13/14] Apply suggestions from code review Co-authored-by: Helen <58733007+el-termikael@users.noreply.github.com> --- docs/adguard-vpn-for-linux/exclusions.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/adguard-vpn-for-linux/exclusions.md b/docs/adguard-vpn-for-linux/exclusions.md index 0d4830068..f29ce9061 100644 --- a/docs/adguard-vpn-for-linux/exclusions.md +++ b/docs/adguard-vpn-for-linux/exclusions.md @@ -3,13 +3,13 @@ title: Exclusions sidebar_position: 7 --- -*Exclusions* feature lets you decide which domains’ traffic should be excluded from VPN routing. This is handy when you don’t need VPN to work for some websites, because it saves you the hassle of constantly turning VPN on and off. +The *Exclusions* feature lets you decide which domains’ traffic should be excluded from VPN routing. This is handy when you don’t need VPN to work for some websites, because it saves you the hassle of constantly turning VPN on and off. -Just like in AdGuard VPN for other platforms, in AdGuard VPN for Linux you can use Exclusions in two modes: General (VPN is enabled for all domains except for those in the exclusion list) and Selective (VPN is enabled only for the domains in the exclusion list). +Just like in AdGuard VPN for other platforms, in AdGuard VPN for Linux you can use Exclusions in two modes: General (VPN is enabled for all domains except for those in the list of exclusions) and Selective (VPN is enabled only for the domains in the list of exclusions). :::note -Each mode has its own exclusion list. +Each mode has its own list of exclusions. ::: From be9ae7a6706e24eacdfc06bc57f64209ffdf352b Mon Sep 17 00:00:00 2001 From: vyanovsky <51786050+vyanovsky@users.noreply.github.com> Date: Sat, 30 Nov 2024 00:58:55 +0900 Subject: [PATCH 14/14] Update exclusions.md based on review comments --- docs/adguard-vpn-for-linux/exclusions.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/adguard-vpn-for-linux/exclusions.md b/docs/adguard-vpn-for-linux/exclusions.md index f29ce9061..35f34eceb 100644 --- a/docs/adguard-vpn-for-linux/exclusions.md +++ b/docs/adguard-vpn-for-linux/exclusions.md @@ -25,9 +25,13 @@ To add a domain to the exclusion list of the current mode, type: adguardvpn-cli site-exclusions add %domain_name% -> Supported input formats: `domain.com`, `sub.domain.com`, `www.domain.com`. To add two or more exclusions at once, list them comma-separated. Use double quotes for wildcards: `"*.domain.com"` -> -> Command example: `adguardvpn-cli site-exclusions add https://www.google.com/` +:::tip + +Supported input formats: `domain.com`, `sub.domain.com`, `www.domain.com`. To add two or more exclusions at once, list them comma-separated. Use double quotes for wildcards: `"*.domain.com"` + +Command example: `adguardvpn-cli site-exclusions add https://www.google.com/` + +::: To remove a domain from the list of exclusions, type: @@ -41,11 +45,11 @@ To remove all exclusions, type: adguardvpn-cli site-exclusions clear -To change the exclusion mode, type: +To change the Exclusions mode, type: adguardvpn-cli site-exclusions mode %mode_name% -(or you can just check the current mode using `adguardvpn-cli site-exclusions mode`) +(Or you can just check the current mode using `adguardvpn-cli site-exclusions mode`) where %mode_name% is `general` or `selective`.