Unlock_connect На главную
$ unlock --docs

Документация

Редакция от 5 сентября 2026 года

Здесь описано то, что клиент умеет сегодня. Разделы, помеченные «скоро», ещё не реализованы — они перечислены, чтобы было видно направление, а не чтобы по ним что-то пробовать.

Что понимает клиент

Клиент разбирает семь протокольных схем, десять с учётом коротких синонимов. Схемы, которых нет в списке, он пропускает.

протоколсхемачто это
vlessvless://VLESS, в том числе Reality
hysteria2hysteria2:// · hy2://Hysteria2 поверх QUIC
trojantrojan://Trojan
ssss://Shadowsocks
vmessvmess://VMess
sockssocks:// · socks5://SOCKS5-прокси
wireguardwireguard:// · wg://WireGuard

В каком виде принимается конфигурация

Ссылку на конфигурацию можно вставить в поле или из буфера обмена. Тело ответа принимается в трёх видах: строки в base64, те же строки открытым текстом и одиночная ссылка на один сервер.

Каждая ссылка превращается в самостоятельный профиль. Локальные socks- и http-входы клиент в профиль не кладёт намеренно: незапароленный локальный socks на устройстве — это дыра.

Заголовки ответа

Сервер конфигурации может передать клиенту четыре заголовка. Все они необязательны.

заголовокназначение
Profile-Titleимя профиля в списке клиента
Profile-Update-Intervalчерез сколько часов обновлять
Subscription-Userinfoupload, download, total, expire — байты и unix-время
Support-URLссылка на поддержку провайдера

Subscription-Userinfo передаётся одной строкой вида upload=0; download=0; total=0; expire=0 — байты и unix-время. Ноль в total означает отсутствие ограничения, ноль в expire — отсутствие срока.

Появится позже

раздело чём будет
Provider API скороконфигурация провайдера по хешу домена, оформление, лимит устройств
Deep links скороуправление клиентом по ссылке: импорт, подключение, маршрутизация
HWID скороаппаратный идентификатор устройства и привязка к нему

Кода за этими разделами пока нет. Как появится — документация придёт вместе с ним, а не раньше.

Точность

Список схем сверен с разбором ссылок в клиенте, заголовки — с кодом, который их отдаёт. При расхождении документации и поведения клиента верно поведение: напишите нам, и мы поправим страницу.

Unlock_connect документация приватность условия лицензии Novikov dev