Skip to content

Commit

Permalink
automatically update translations
Browse files Browse the repository at this point in the history
  • Loading branch information
ss-orlova authored Apr 26, 2024
1 parent 8cbe8bb commit 860bc28
Show file tree
Hide file tree
Showing 128 changed files with 5,837 additions and 37 deletions.
4 changes: 4 additions & 0 deletions i18n/cs/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,9 @@
"sidebar.sidebar.category.solving-problems": {
"message": "řešení problémů",
"description": "The label for category solving-problems in sidebar sidebar"
},
"sidebar.sidebar.category.AdGuard VPN for Linux": {
"message": "AdGuard VPN for Linux",
"description": "The label for category AdGuard VPN for Linux in sidebar sidebar"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: AdGuard VPN for Linux
sidebar_position: 1
---

AdGuard VPN for Linux, also known as AdGuard VPN CLI, is a command-line VPN client. You can use it on Linux or macOS devices as well as on MIPS or MIPSel routers.

Below are commands you may need to log in, connect, and manage AdGuard VPN’s settings.

- [Installation and removal](/adguard-vpn-for-linux/installation)
- [Login, connection, and update](/adguard-vpn-for-linux/login)
- [Settings](/adguard-vpn-for-linux/settings)
- [Sending feedback](/adguard-vpn-for-linux/feedback)

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

To view all available commands, type:

```
`adguardvpn-cli --help-all`
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: Sending feedback
sidebar_position: 5
---

## Report a problem or suggest a feature

If you’ve found a bug in AdGuard VPN 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/vpn_linux/form.html).
- [Create a GitHub issue](https://github.com/AdguardTeam/AdGuardVPNCLI/issues/new/choose). But before you do, check the [repository](https://github.com/AdguardTeam/AdGuardVPNCLI/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 by typing:

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

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

3. Wait a while, then archive the logs in the _Downloads_ or _Home_ folder by typing:

For Linux

`zip -rj logs.zip ${XDG_DATA_HOME:-~/.local/share}/adguardvpn-cli/*.log`

For Mac

`zip -rj ~/Downloads/logs.zip ~/Library/"Application Support"/adguardvpn-cli/*.log`

4. 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.

5. Disable debug logging by typing:

`adguardvpn-cli config set-debug-logging off`
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: Installation and removal
sidebar_position: 2
---

## Install AdGuard VPN for Linux

To install AdGuard VPN, type:

Release

```
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
```

Nightly

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

If required, enter your admin password.

Agree to link the binary to `usr/local/bin` by pressing `y` and wait until the installation is complete.

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

## Uninstall AdGuard VPN for Linux

To uninstall AdGuard VPN, type:

Release

```
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
```

Nightly

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

If required, enter your admin password.
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: Login, connection, and update
sidebar_position: 3
---

## Log in and log out

To log in or create an account, type:

```
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.

:::note
You can also create an AdGuard account on our [website](https://auth.adguard.com/login.html) and then log in to AdGuard VPN for Linux using your credentials.
:::

To log out of AdGuard VPN, type:

```
adguardvpn-cli logout
```

## Connect to VPN

For quick connection, type:

```
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
```

To connect to a specific location, type:

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

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
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
---
title: Settings
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
```

## 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
```

To set the SOCKS5 mode, type:

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

To set the SOCKS5 port, type:

```
adguardvpn-cli config set-socks-port <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 <server_address>
```

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
```

## 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
```

## 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
```

To disable it, set it to `off`.

## Update channel

To change the update channel, type:

```
`adguardvpn-cli config set-update-channel <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
```

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
```

Disable this setting after exporting logs.
Loading

0 comments on commit 860bc28

Please sign in to comment.