From ed8d868ed96a07b12818c90e459305761f156b67 Mon Sep 17 00:00:00 2001 From: an-martynova Date: Sun, 24 Nov 2024 23:23:33 +0300 Subject: [PATCH 01/12] Add info how to use exclusions in VPN CLI Add a more detailed explanation of how to use exclusions in VPN CLI #230 --- docs/adguard-vpn-for-linux/settings.md | 35 ++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/docs/adguard-vpn-for-linux/settings.md b/docs/adguard-vpn-for-linux/settings.md index 654e1e0ec..3dcf0e037 100644 --- a/docs/adguard-vpn-for-linux/settings.md +++ b/docs/adguard-vpn-for-linux/settings.md @@ -117,3 +117,38 @@ The setting is responsible for the appearance of system notifications when AdGua - A user is waiting for the VPN connection to be recovered — the *Waiting for connection* notification appears. adguardvpn-cli config set-show-notifications on + +## Exclusions + +There are two modes: +**general** - exclusions are not routed through VPN +**selective** - ONLY exclusions are routed through VPN + + +To read about what you can do with exclusions, write this in the command-line interface: +*`adguardvpn-cli site-exclusions -h`* + + +Here are the options: + **add** Add specified exclusions + **remove** Remove specified exclusions + **show** Show all exclusions + **clear** Clear all exclusions + **mode** Set VPN exclusion mode (general/selective) or show current mode if no options are passed + +To add an exclusion, you need to enter this command: *`adguardvpn-cli site-exclusions add %DOMAIN_NAME%`*, where %DOMAIN_NAME% is the website that you want to add to exclusions + +:::note + +To add many exclusions, you need to list them comma-separated + +::: + +**remove** removes one or more exclusions (if separated by commas) +Example: *adguardvpn-cli site-exclusions remove %DOMAIN_NAME%* +**show** shows the current list of exclusions +Example: *adguardvpn-cli site-exclusions show* +**clear** clears the list in the current mode +Example: *adguardvpn-cli site-exclusions clear* +**mode** allows to switch between modes +Example: *adguardvpn-cli site-exclusions mode selective* (with this selective mode is chosen) \ No newline at end of file From 49433c83ebdf54e3d20d6a4e82b795eeb0195596 Mon Sep 17 00:00:00 2001 From: Elena Ter-Mikaelyan Date: Mon, 25 Nov 2024 12:13:11 +0300 Subject: [PATCH 02/12] fix formatting and text --- docs/adguard-vpn-for-linux/settings.md | 43 +++++++++++++------------- 1 file changed, 21 insertions(+), 22 deletions(-) diff --git a/docs/adguard-vpn-for-linux/settings.md b/docs/adguard-vpn-for-linux/settings.md index 3dcf0e037..8d909491a 100644 --- a/docs/adguard-vpn-for-linux/settings.md +++ b/docs/adguard-vpn-for-linux/settings.md @@ -120,35 +120,34 @@ The setting is responsible for the appearance of system notifications when AdGua ## Exclusions -There are two modes: -**general** - exclusions are not routed through VPN -**selective** - ONLY exclusions are routed through VPN +There are two modes. In *General* mode, websites from the list of exclusions are not routed through VPN. In *Selective* mode, only websites from the list of exclusions are routed through VPN. There is a separate list of exclusions for each mode. +To read about what you can do with exclusions, write this in the command-line interface: `adguardvpn-cli site-exclusions -h`. -To read about what you can do with exclusions, write this in the command-line interface: -*`adguardvpn-cli site-exclusions -h`* +To add an exclusion, enter this command: `adguardvpn-cli site-exclusions add %DOMAIN_NAME%`, where `%DOMAIN_NAME%` is the website that you want to add to exclusions. +:::note + +To add many exclusions, you need to list them comma-separated. + +::: Here are the options: - **add** Add specified exclusions - **remove** Remove specified exclusions - **show** Show all exclusions - **clear** Clear all exclusions - **mode** Set VPN exclusion mode (general/selective) or show current mode if no options are passed -To add an exclusion, you need to enter this command: *`adguardvpn-cli site-exclusions add %DOMAIN_NAME%`*, where %DOMAIN_NAME% is the website that you want to add to exclusions +1. **add** adds specified exclusions -:::note +1. **clear** clears the list of exclusions in the current mode -To add many exclusions, you need to list them comma-separated + Example: `adguardvpn-cli site-exclusions clear` -::: +1. **mode** shows the current mode and allows to switch between them + + Example: `adguardvpn-cli site-exclusions mode selective` (with this command, Selective mode is chosen) + +1. **remove** removes one or more exclusions (if separated by commas) + + Example: `adguardvpn-cli site-exclusions remove %DOMAIN_NAME%` + +1. **show** shows the current list of exclusions -**remove** removes one or more exclusions (if separated by commas) -Example: *adguardvpn-cli site-exclusions remove %DOMAIN_NAME%* -**show** shows the current list of exclusions -Example: *adguardvpn-cli site-exclusions show* -**clear** clears the list in the current mode -Example: *adguardvpn-cli site-exclusions clear* -**mode** allows to switch between modes -Example: *adguardvpn-cli site-exclusions mode selective* (with this selective mode is chosen) \ No newline at end of file + Example: `adguardvpn-cli site-exclusions show` From dbafe93795ff446d4fc0331de975d68761fbaa96 Mon Sep 17 00:00:00 2001 From: an-martynova Date: Fri, 29 Nov 2024 12:17:28 +0300 Subject: [PATCH 03/12] Update settings.md Change of structure, added example of 'add to exclusions' --- docs/adguard-vpn-for-linux/settings.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/adguard-vpn-for-linux/settings.md b/docs/adguard-vpn-for-linux/settings.md index 8d909491a..bc32ad6be 100644 --- a/docs/adguard-vpn-for-linux/settings.md +++ b/docs/adguard-vpn-for-linux/settings.md @@ -132,10 +132,12 @@ To add many exclusions, you need to list them comma-separated. ::: -Here are the options: +Here are the main options: 1. **add** adds specified exclusions + Example: `adguardvpn-cli site-exclusions add` + 1. **clear** clears the list of exclusions in the current mode Example: `adguardvpn-cli site-exclusions clear` @@ -146,7 +148,7 @@ Here are the options: 1. **remove** removes one or more exclusions (if separated by commas) - Example: `adguardvpn-cli site-exclusions remove %DOMAIN_NAME%` + Example: `adguardvpn-cli site-exclusions remove %DOMAIN_NAME%` where `%DOMAIN_NAME%` is the website that you want to remove from exclusions. 1. **show** shows the current list of exclusions From 96c796236a02e0b5fda19a09f0137b25d5398b6d Mon Sep 17 00:00:00 2001 From: an-martynova Date: Fri, 29 Nov 2024 12:38:24 +0300 Subject: [PATCH 04/12] Update settings.md for CLI Change numerals in list, remove blanks --- docs/adguard-vpn-for-linux/settings.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/docs/adguard-vpn-for-linux/settings.md b/docs/adguard-vpn-for-linux/settings.md index bc32ad6be..ea82852f5 100644 --- a/docs/adguard-vpn-for-linux/settings.md +++ b/docs/adguard-vpn-for-linux/settings.md @@ -124,7 +124,11 @@ There are two modes. In *General* mode, websites from the list of exclusions are To read about what you can do with exclusions, write this in the command-line interface: `adguardvpn-cli site-exclusions -h`. -To add an exclusion, enter this command: `adguardvpn-cli site-exclusions add %DOMAIN_NAME%`, where `%DOMAIN_NAME%` is the website that you want to add to exclusions. +Here are the main options: + +1.**add** adds specified exclusions + + Example: `adguardvpn-cli site-exclusions add`, where `%DOMAIN_NAME%` is the website that you want to add to exclusions. :::note @@ -132,24 +136,18 @@ To add many exclusions, you need to list them comma-separated. ::: -Here are the main options: - -1. **add** adds specified exclusions - - Example: `adguardvpn-cli site-exclusions add` - -1. **clear** clears the list of exclusions in the current mode +2.**clear** clears the list of exclusions in the current mode Example: `adguardvpn-cli site-exclusions clear` -1. **mode** shows the current mode and allows to switch between them +3.**mode** shows the current mode and allows to switch between them Example: `adguardvpn-cli site-exclusions mode selective` (with this command, Selective mode is chosen) -1. **remove** removes one or more exclusions (if separated by commas) +4.**remove** removes one or more exclusions (if separated by commas) Example: `adguardvpn-cli site-exclusions remove %DOMAIN_NAME%` where `%DOMAIN_NAME%` is the website that you want to remove from exclusions. -1. **show** shows the current list of exclusions +5.**show** shows the current list of exclusions Example: `adguardvpn-cli site-exclusions show` From 5cc7193f50c20e5611468d25ac82dff44a7b1780 Mon Sep 17 00:00:00 2001 From: an-martynova <40242331+an-martynova@users.noreply.github.com> Date: Fri, 29 Nov 2024 15:50:09 +0300 Subject: [PATCH 05/12] Update docs/adguard-vpn-for-linux/settings.md Co-authored-by: Helen <58733007+el-termikael@users.noreply.github.com> --- docs/adguard-vpn-for-linux/settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adguard-vpn-for-linux/settings.md b/docs/adguard-vpn-for-linux/settings.md index ea82852f5..83e2d78a5 100644 --- a/docs/adguard-vpn-for-linux/settings.md +++ b/docs/adguard-vpn-for-linux/settings.md @@ -126,7 +126,7 @@ To read about what you can do with exclusions, write this in the command-line in Here are the main options: -1.**add** adds specified exclusions +1. **add** adds specified exclusions Example: `adguardvpn-cli site-exclusions add`, where `%DOMAIN_NAME%` is the website that you want to add to exclusions. From adf2196949920dc1a80739af53f7fbd902c47f26 Mon Sep 17 00:00:00 2001 From: an-martynova <40242331+an-martynova@users.noreply.github.com> Date: Fri, 29 Nov 2024 15:50:23 +0300 Subject: [PATCH 06/12] Update docs/adguard-vpn-for-linux/settings.md Co-authored-by: Helen <58733007+el-termikael@users.noreply.github.com> --- docs/adguard-vpn-for-linux/settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adguard-vpn-for-linux/settings.md b/docs/adguard-vpn-for-linux/settings.md index 83e2d78a5..7458cae54 100644 --- a/docs/adguard-vpn-for-linux/settings.md +++ b/docs/adguard-vpn-for-linux/settings.md @@ -148,6 +148,6 @@ To add many exclusions, you need to list them comma-separated. Example: `adguardvpn-cli site-exclusions remove %DOMAIN_NAME%` where `%DOMAIN_NAME%` is the website that you want to remove from exclusions. -5.**show** shows the current list of exclusions +5. **show** shows the current list of exclusions Example: `adguardvpn-cli site-exclusions show` From 05a69e54a77b3539ddd0be05d951d66540d4775d Mon Sep 17 00:00:00 2001 From: an-martynova <40242331+an-martynova@users.noreply.github.com> Date: Fri, 29 Nov 2024 15:50:34 +0300 Subject: [PATCH 07/12] Update docs/adguard-vpn-for-linux/settings.md Co-authored-by: Helen <58733007+el-termikael@users.noreply.github.com> --- docs/adguard-vpn-for-linux/settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adguard-vpn-for-linux/settings.md b/docs/adguard-vpn-for-linux/settings.md index 7458cae54..8fde6a262 100644 --- a/docs/adguard-vpn-for-linux/settings.md +++ b/docs/adguard-vpn-for-linux/settings.md @@ -136,7 +136,7 @@ To add many exclusions, you need to list them comma-separated. ::: -2.**clear** clears the list of exclusions in the current mode +2. **clear** clears the list of exclusions in the current mode Example: `adguardvpn-cli site-exclusions clear` From baff0e4f9031057e8f14f142afe5653821f314ff Mon Sep 17 00:00:00 2001 From: an-martynova <40242331+an-martynova@users.noreply.github.com> Date: Fri, 29 Nov 2024 15:50:48 +0300 Subject: [PATCH 08/12] Update docs/adguard-vpn-for-linux/settings.md Co-authored-by: Helen <58733007+el-termikael@users.noreply.github.com> --- docs/adguard-vpn-for-linux/settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adguard-vpn-for-linux/settings.md b/docs/adguard-vpn-for-linux/settings.md index 8fde6a262..0eeb31a22 100644 --- a/docs/adguard-vpn-for-linux/settings.md +++ b/docs/adguard-vpn-for-linux/settings.md @@ -140,7 +140,7 @@ To add many exclusions, you need to list them comma-separated. Example: `adguardvpn-cli site-exclusions clear` -3.**mode** shows the current mode and allows to switch between them +3. **mode** shows the current mode and allows to switch between them Example: `adguardvpn-cli site-exclusions mode selective` (with this command, Selective mode is chosen) From 919da28a2b9b167c2c110b47ab9f8f8cb07f5317 Mon Sep 17 00:00:00 2001 From: an-martynova <40242331+an-martynova@users.noreply.github.com> Date: Fri, 29 Nov 2024 15:51:05 +0300 Subject: [PATCH 09/12] Update docs/adguard-vpn-for-linux/settings.md Co-authored-by: Helen <58733007+el-termikael@users.noreply.github.com> --- docs/adguard-vpn-for-linux/settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adguard-vpn-for-linux/settings.md b/docs/adguard-vpn-for-linux/settings.md index 0eeb31a22..6ee88fcb7 100644 --- a/docs/adguard-vpn-for-linux/settings.md +++ b/docs/adguard-vpn-for-linux/settings.md @@ -144,7 +144,7 @@ To add many exclusions, you need to list them comma-separated. Example: `adguardvpn-cli site-exclusions mode selective` (with this command, Selective mode is chosen) -4.**remove** removes one or more exclusions (if separated by commas) +4. **remove** removes one or more exclusions (if separated by commas) Example: `adguardvpn-cli site-exclusions remove %DOMAIN_NAME%` where `%DOMAIN_NAME%` is the website that you want to remove from exclusions. From 68c27c4ac531af902d6c747f86aff2b7e075dbd8 Mon Sep 17 00:00:00 2001 From: Elena Ter-Mikaelyan Date: Fri, 29 Nov 2024 16:06:09 +0300 Subject: [PATCH 10/12] fix ordered list item prefix --- docs/adguard-vpn-for-linux/settings.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/adguard-vpn-for-linux/settings.md b/docs/adguard-vpn-for-linux/settings.md index 6ee88fcb7..c1b2a28b8 100644 --- a/docs/adguard-vpn-for-linux/settings.md +++ b/docs/adguard-vpn-for-linux/settings.md @@ -136,18 +136,18 @@ To add many exclusions, you need to list them comma-separated. ::: -2. **clear** clears the list of exclusions in the current mode +1. **clear** clears the list of exclusions in the current mode Example: `adguardvpn-cli site-exclusions clear` -3. **mode** shows the current mode and allows to switch between them +1. **mode** shows the current mode and allows to switch between them Example: `adguardvpn-cli site-exclusions mode selective` (with this command, Selective mode is chosen) -4. **remove** removes one or more exclusions (if separated by commas) +1. **remove** removes one or more exclusions (if separated by commas) Example: `adguardvpn-cli site-exclusions remove %DOMAIN_NAME%` where `%DOMAIN_NAME%` is the website that you want to remove from exclusions. -5. **show** shows the current list of exclusions +1. **show** shows the current list of exclusions Example: `adguardvpn-cli site-exclusions show` From 4e1dc000228ce83b081e73240fd7f5bd16378743 Mon Sep 17 00:00:00 2001 From: Elena Ter-Mikaelyan Date: Fri, 29 Nov 2024 16:44:26 +0300 Subject: [PATCH 11/12] fix formatting --- docs/adguard-vpn-for-linux/settings.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/adguard-vpn-for-linux/settings.md b/docs/adguard-vpn-for-linux/settings.md index c1b2a28b8..43f1573c5 100644 --- a/docs/adguard-vpn-for-linux/settings.md +++ b/docs/adguard-vpn-for-linux/settings.md @@ -113,7 +113,7 @@ Disable this setting after exporting logs. The setting is responsible for the appearance of system notifications when AdGuard VPN is turned on/off or waiting for reconnection, for example: - A user turns VPN on — the *VPN connected* notification appears. -- A user turns VPN off — the *VPN disconnected notification appears. +- A user turns VPN off — the *VPN disconnected* notification appears. - A user is waiting for the VPN connection to be recovered — the *Waiting for connection* notification appears. adguardvpn-cli config set-show-notifications on From a3d5658e092bfb0e58774cdda09faaca5739517e Mon Sep 17 00:00:00 2001 From: Elena Ter-Mikaelyan Date: Fri, 29 Nov 2024 17:18:38 +0300 Subject: [PATCH 12/12] one more fix --- docs/adguard-vpn-for-linux/settings.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/adguard-vpn-for-linux/settings.md b/docs/adguard-vpn-for-linux/settings.md index 43f1573c5..05faecafa 100644 --- a/docs/adguard-vpn-for-linux/settings.md +++ b/docs/adguard-vpn-for-linux/settings.md @@ -130,11 +130,11 @@ Here are the main options: Example: `adguardvpn-cli site-exclusions add`, where `%DOMAIN_NAME%` is the website that you want to add to exclusions. -:::note + :::note -To add many exclusions, you need to list them comma-separated. + o add many exclusions, you need to list them comma-separated. -::: + ::: 1. **clear** clears the list of exclusions in the current mode