Skip to content

Commit

Permalink
Fix markdown and instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
sonya-orlova committed Apr 26, 2024
1 parent 510774c commit 2b43f45
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 28 deletions.
12 changes: 6 additions & 6 deletions docs/adguard-vpn-for-linux/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ To install AdGuard VPN, type:

Release

`curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/master/scripts/release/install.sh | sh -s -- -v`
curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/master/scripts/release/install.sh | sh -s -- -v

Beta

`curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/master/scripts/beta/install.sh | sh -s -- -v`
curl -fsSL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/master/scripts/beta/install.sh | sh -s -- -v

Nightly

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

If required, enter your admin password.

Expand All @@ -33,14 +33,14 @@ To uninstall AdGuard VPN, type:

Release

`curl -SsL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/master/scripts/release/install.sh | sh -s -- -v -u`
curl -SsL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/master/scripts/release/install.sh | sh -s -- -v -u

Beta

`curl -SsL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/master/scripts/beta/install.sh | sh -s -- -v -u`
curl -SsL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/master/scripts/beta/install.sh | sh -s -- -v -u

Nightly

`curl -SsL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/master/scripts/nightly/install.sh | sh -s -- -v -u`
curl -SsL https://raw.githubusercontent.com/AdguardTeam/AdGuardVPNCLI/master/scripts/nightly/install.sh | sh -s -- -v -u

If required, enter your admin password.
14 changes: 7 additions & 7 deletions docs/adguard-vpn-for-linux/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 3

To log in or create an account, type:

`adguardvpn-cli login`
adguardvpn-cli login

Enter the email address and password for your AdGuard account. If you don’t have an account yet, you’ll be prompted to create one.

Expand All @@ -17,30 +17,30 @@ You can also create an AdGuard account on our [website](https://auth.adguard.com

To log out of AdGuard VPN, type:

`adguardvpn-cli logout`
adguardvpn-cli logout

## Connect to VPN

For quick connection, type:

`adguard-vpn cli connect`
adguard-vpn cli connect

AdGuard VPN will connect to the fastest available or the last used location.

To view available locations, type:

`adguardvpn-cli list-locations`
adguardvpn-cli list-locations

To connect to a specific location, type:

`adguardvpn-cli connect -l`
adguardvpn-cli connect -l <location>

and enter a city name from the location list.
Replace `<location>` with the city, country, or ISO code of the location you want to connect to.

If required, enter your admin password.

## Check for updates

To check for updates, type:

`adguardvpn-cli check-update`
adguardvpn-cli check-update
30 changes: 15 additions & 15 deletions docs/adguard-vpn-for-linux/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,70 +5,70 @@ sidebar_position: 4

You can manage AdGuard VPN for Linux settings from the command line. To view the current configuration, type:

`adguardvpn-cli config show`
adguardvpn-cli config show

## VPN mode: TUN or SOCKS5

You can choose how AdGuard VPN routes traffic.

To set the default tunnel mode, type:

`adguardvpn-cli config set-mode TUN`
adguardvpn-cli config set-mode TUN

To set the SOCKS5 mode, type:

`adguardvpn-cli config set-mode SOCKS`
adguardvpn-cli config set-mode SOCKS

To set the SOCKS5 port, type:

`adguardvpn-cli config set-socks-port`
adguardvpn-cli config set-socks-port <port_number>

and enter your port number.
Replace `<port_number>` with the port you want to connect to.

## DNS upstream address

To set a DNS upstream, type:

`adguardvpn-cli config set-dns`
adguardvpn-cli config set-dns <server_address>

and enter the address of your DNS server. To use this DNS server at the system level, type:
Replace `<server_address>` with the address of your DNS server. To use this DNS server at the system level, type:

`adguardvpn-cli config set-system-dns on`
adguardvpn-cli config set-system-dns on

## No-route mode

This feature routes only your specified addresses through the VPN tunnel. To enable the no-route mode, type:

`adguardvpn-cli config set-no-routes on`
adguardvpn-cli config set-no-routes on

## Crash reports

If you enable automatic crash reports, AdGuard VPN will notify the developers if something goes wrong. To enable the setting, type:

`adguardvpn-cli config send-reports on`
adguardvpn-cli config send-reports on

To disable it, set it to `off`.

## Update channel

To switch to stable, beta, or nightly, type:
To change the update channel, type:

`adguardvpn-cli config set-updates-channel`
`adguardvpn-cli config set-update-channel <channel>`

and enter the preferred update channel.
Replace `<channel>` with `stable`, `beta`, or `nightly`, depending on your preferences.

## Hints

AdGuard VPN can show you hints after executing commands — for example, what to do next or how to fix an error. This setting is enabled by default but you can disable it by typing:

`adguardvpn-cli config set-show-hints off`
adguardvpn-cli config set-show-hints off

To re-enable it, replace `off` with `on`.

## Debug logging

To report a bug, you may need to share debug logs with the developers or support team. To enable debug logging, type:

`adguardvpn-cli config set-debug-logging on`
adguardvpn-cli config set-debug-logging on

Disable this setting after exporting logs.

0 comments on commit 2b43f45

Please sign in to comment.