Skip to content

Update openvpn.md #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dzx941 wants to merge 16 commits into
base: main
Choose a base branch
from
+28 −29
Open

Update openvpn.md #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
af1e988
Update openvpn.md
dzx941 May 21, 2026
a622bd4
Update openvpn.md
dzx941 May 21, 2026
542b3c1
Update openvpn.en.md
dzx941 May 21, 2026
98369ae
Update openvpn.en.md
dzx941 May 21, 2026
8d57152
Update openvpn.ru.md
dzx941 May 21, 2026
009e17d
Update openvpn.ru.md
dzx941 May 21, 2026
dbdfe40
Update openvpn.md
dzx941 May 21, 2026
64ea01c
Update openvpn.en.md
dzx941 May 21, 2026
e99c7fa
Update openvpn.ru.md
dzx941 May 21, 2026
0d907af
Update openvpn.en.md
dzx941 May 22, 2026
cd40280
Update openvpn.md
dzx941 May 22, 2026
c734936
Update openvpn.ru.md
dzx941 May 22, 2026
b8af0f3
Update openvpn.md
dzx941 May 25, 2026
58d9f1b
Update openvpn.en.md
dzx941 May 25, 2026
435249b
Update openvpn.ru.md
dzx941 May 25, 2026
6ce9112
Update openvpn.ru.md
dzx941 May 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/config/proxies/openvpn.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ proxies:
-----BEGIN CERTIFICATE-----
MIIB...example
-----END CERTIFICATE-----
tls-crypt: |
-----BEGIN OpenVPN Static key V1-----
...
-----END OpenVPN Static key V1-----
# tls-crypt: |
# -----BEGIN OpenVPN Static key V1-----
# ...
# -----END OpenVPN Static key V1-----
# dev: tun
# cipher: AES-128-GCM
# auth: SHA256
Expand Down Expand Up @@ -54,7 +54,7 @@ Optional, protocol type. Supports `udp` or `tcp`. Defaults to `udp`.

## username / password

**Optional**, username and password for `auth-user-pass` authentication mode.
**Optional**, the username and password required for `auth-user-pass` authentication mode.

> **Note**: Must choose between these or `cert` / `key`. Both pairs cannot be empty at the same time.

Expand All @@ -72,19 +72,19 @@ Optional, protocol type. Supports `udp` or `tcp`. Defaults to `udp`.

## tls-crypt

**Required**, TLS encryption key. Copy this from the `<tls-crypt>` tag in your `.ovpn` file; do not include the tags themselves.
**Optional**, TLS encryption key. Copy this from the `<tls-crypt>` tag in your `.ovpn` file; do not include the tags themselves.

## dev

Optional, virtual network interface type. Currently only `tun` is supported. Defaults to `tun`.

## cipher

Optional, encryption method. Supports `AES-128-GCM` / `AES-256-GCM`./ `CHACHA20-POLY1305`Defaults to `AES-128-GCM`.
Optional, encryption method. Supports `AES-128-GCM` / `AES-256-GCM` / `AES-128-CBC` / `AES-256-CBC` / `CHACHA20-POLY1305`. Defaults to `AES-128-GCM`. `AES-CBC` will be treated as `AES-128-CBC`.

## auth

Optional, authentication algorithm. Currently only `SHA256` is supported. Defaults to `SHA256`.
Optional, data authentication algorithm. Supports `MD5` /`SHA1` / `SHA256`/ `SHA384` / `SHA512`. Defaults to `SHA256`. AEAD ciphers will ignore the auth configuration.

## udp

Expand All @@ -96,7 +96,7 @@ Optional, Maximum Transmission Unit. Defaults to `1500`.

## dialer-proxy

Optional, the identifier for an outbound proxy. If set, the OpenVPN connection will be established through the specified proxy.
Optional, specifies the identifier for an outbound proxy. If set, the OpenVPN connection will be established through the specified proxy.

## remote-dns-resolve

Expand Down
14 changes: 7 additions & 7 deletions docs/config/proxies/openvpn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ proxies:
-----BEGIN CERTIFICATE-----
MIIB...example
-----END CERTIFICATE-----
tls-crypt: |
-----BEGIN OpenVPN Static key V1-----
...
-----END OpenVPN Static key V1-----
# tls-crypt: |
# -----BEGIN OpenVPN Static key V1-----
# ...
# -----END OpenVPN Static key V1-----
# dev: tun
# cipher: AES-128-GCM
# auth: SHA256
Expand Down Expand Up @@ -72,19 +72,19 @@ proxies:

## tls-crypt

**必须**，TLS 加密密钥。从 `.ovpn` 文件的 `<tls-crypt>` 标签中复制，不需要保留标签。
**可选**，TLS 加密密钥。从 `.ovpn` 文件的 `<tls-crypt>` 标签中复制，不需要保留标签。

## dev

可选，虚拟网卡类型，当前仅支持 `tun`，默认 `tun`。

## cipher

可选，加密方式，支持 `AES-128-GCM` / `AES-256-GCM`/ `CHACHA20-POLY1305`默认 `AES-128-GCM`。
可选，加密方式，支持 `AES-128-GCM` / `AES-256-GCM`/ `AES-128-CBC` / `AES-256-CBC` /`CHACHA20-POLY1305`默认 `AES-128-GCM`， `AES-CBC` 会按 `AES-128-CBC` 处理。

## auth

可选，数据验证算法，目前仅支持 `SHA256`，默认 `SHA256`。
可选，数据验证算法，支持 `MD5` /`SHA1` / `SHA256`/ `SHA384` / `SHA512`，默认 `SHA256`；AEAD cipher 会忽略 auth。

## udp

Expand Down
25 changes: 12 additions & 13 deletions docs/config/proxies/openvpn.ru.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ proxies:
-----BEGIN CERTIFICATE-----
MIIB...example
-----END CERTIFICATE-----
tls-crypt: |
-----BEGIN OpenVPN Static key V1-----
...
-----END OpenVPN Static key V1-----
# tls-crypt: |
# -----BEGIN OpenVPN Static key V1-----
# ...
# -----END OpenVPN Static key V1-----
# dev: tun
# cipher: AES-128-GCM
# auth: SHA256
Expand Down Expand Up @@ -54,7 +54,7 @@ proxies:

## username / password

**Опционально**, имя пользователя и пароль для режима аутентификации `auth-user-pass`.
**Опционально**, имя пользователя и пароль, необходимые для режима аутентификации `auth-user-pass`.

> **Примечание**: Необходимо выбрать либо этот вариант, либо пару `cert` / `key`. Оба варианта не могут быть пустыми одновременно.

Expand All @@ -64,31 +64,30 @@ proxies:

## cert

**Опционально**, содержимое клиентского сертификата. Скопируйте содержимое тега `<cert>` из вашего `.ovpn` файла. Можно пропустить при использовании логина и пароля.
**Опционально**, содержимое клиентского сертификата. Скопируйте содержимое тега `<cert>` из вашего `.ovpn` файла. Можно пропустить при использовании режима с именем пользователя и паролем.

## key

**Опционально**, содержимое закрытого ключа клиента. Скопируйте содержимое тега `<key>` из вашего `.ovpn` файла. Можно пропустить при использовании логина и пароля.
**Опционально**, содержимое закрытого ключа клиента. Скопируйте содержимое тега `<key>` из вашего `.ovpn` файла. Можно пропустить при использовании режима с именем пользователя и паролем.

## tls-crypt

**Обязательно**, ключ шифрования TLS. Скопируйте содержимое тега `<tls-crypt>` из вашего `.ovpn` файла (сами теги копировать не нужно).
**Опционально**, ключ шифрования TLS. Скопируйте содержимое тега `<tls-crypt>` из вашего `.ovpn` файла (сами теги копировать не нужно).

## dev

Опционально, тип виртуального сетевого интерфейса, на данный момент поддерживается только `tun`, по умолчанию `tun`.

## cipher

Опционально, метод шифрования, поддерживаются `AES-128-GCM` / `AES-256-GCM`/ `CHACHA20-POLY1305` по умолчанию `AES-128-GCM`.
Опционально, метод шифрования, поддерживаются `AES-128-GCM` / `AES-256-GCM` / `AES-128-CBC` / `AES-256-CBC` / `CHACHA20-POLY1305`, по умолчанию `AES-128-GCM`. Значение `AES-CBC` будет обрабатываться как `AES-128-CBC`.

## auth

Опционально, алгоритм аутентификации данных, на данный момент поддерживается только `SHA256`, по умолчанию `SHA256`.

Опционально, алгоритм аутентификации данных, поддерживаются `MD5` /`SHA1` / `SHA256`/ `SHA384` / `SHA512`, по умолчанию `SHA256`. При использовании AEAD-шифров параметр auth игнорируется.
## udp

Опционально, использовать ли протокол UDP. `true` для UDP, `false` для TCP.
Опционально, использовать ли протокол UDP. `true` означает использование UDP, `false` — использование TCP.

## mtu

Expand All @@ -104,4 +103,4 @@ proxies:

## dns

Опционально, работает только если `remote-dns-resolve` установлено в `true`. Список адресов DNS-серверов.
Опционально, работает только если параметр `remote-dns-resolve` установлен в `true`. Задает список адресов DNS-серверов для удаленного разрешения.