# FlowLock

> FlowLock is a VPN client for macOS, Windows and Linux for the subscription a person already has from a VPN provider. It does not sell VPN access. This documentation covers the app for users and the provider cabinet (provider ID in a subscription, domain verification, app management headers, notifications and commands, limited install links, API).

Every page is also available in Markdown at the same address with `.md` instead of the trailing slash. Russian is the source language; English pages say the same.

## Провайдерам (ru)

- [Кабинет провайдера](https://flowlock.cc/docs/providers.md): Что даёт кабинет провайдера FlowLock и как подключить к нему подписки за пять шагов.
- [ID в подписке](https://flowlock.cc/docs/provider-id.md): Три способа передать приложению ваш ID провайдера — заголовком ответа, строкой в теле подписки или во фрагменте ссылки.
- [Домены и проверка владения](https://flowlock.cc/docs/domains.md): Как подтвердить домен подписки TXT-записью или файлом, что значат статусы и почему подтверждается точное имя.
- [Заголовки подписки](https://flowlock.cc/docs/headers.md): Что FlowLock читает из ответа любой подписки — имя, трафик и срок, поддержка, объявление, интервал обновления — и что сам отправляет панели.
- [Управление приложением](https://flowlock.cc/docs/app-management.md): Параметры подписки, которыми провайдер управляет FlowLock — инфоблок, продление, переезд, запасной адрес и настройки приложения; что FlowLock не читает и почему.
- [Тема оформления подписки](https://flowlock.cc/docs/themes.md): Заголовок flowlock-theme — цвета интерфейса FlowLock для людей вашей подписки, формат значения и правила читаемости.
- [Правила маршрутизации подписки](https://flowlock.cc/docs/routing.md): Как провайдер присылает правила «что через VPN, что напрямую» — профиль Happ в заголовке routing, Xray и sing-box JSON.
- [Ограниченные и HWID-ссылки](https://flowlock.cc/docs/install-links.md): Ссылки на подписку с лимитом устройств или для одного устройства по HWID — адрес подписки пользователь не видит.
- [Уведомления и команды](https://flowlock.cc/docs/messages.md): Сообщения пользователям подтверждённых подписок — уведомления, окно поверх и безопасные команды приложению, адресаты, расписание и ограничения.
- [Статистика](https://flowlock.cc/docs/stats.md): Сколько устройств пользуется вашими подписками — всего, активные за 30 дней, по системам и по месяцам.
- [Ссылки flowlock://](https://flowlock.cc/docs/links.md): Команды схемы flowlock:// — подключить, отключить, добавить подписку, импорт, правила маршрутизации, ограниченные ссылки и темы.
- [User-Agent FlowLock](https://flowlock.cc/docs/user-agent.md): Какой User-Agent FlowLock отправляет при загрузке подписки, как узнать FlowLock в панели и что происходит, если панель его не принимает.
- [Справочник API](https://flowlock.cc/docs/api.md): API кабинета провайдера для панелей и ботов — ключи, домены, ограниченные ссылки, сообщения, устройства и статистика, с примерами curl.
- [Лимиты и «Анлимит»](https://flowlock.cc/docs/limits.md): Сколько доменов, ссылок, устройств и рассылок даёт бесплатный кабинет, что снимает «Анлимит» за 1000 ₽ в месяц и как его оплатить и продлить.
- [Приватность: что видит провайдер](https://flowlock.cc/docs/privacy.md): Какие данные о пользователях видит провайдер в кабинете, чего не видит никто, сколько всё хранится и как пользователь выключает отметки.

## Пользователям (ru)

- [Установка](https://flowlock.cc/docs/install.md): Как поставить FlowLock на macOS, Windows и Linux, что делать с предупреждением «разработчик не подтверждён» и как приходят обновления.
- [Подписки](https://flowlock.cc/docs/subscriptions.md): Как добавить подписку провайдера в FlowLock, что показывает карточка подписки, HWID и подписки по ограниченным ссылкам.
- [Маршруты и свои базы](https://flowlock.cc/docs/rules.md): Режимы маршрутизации, свои правила «через VPN / напрямую / блокировать», правила подписки, отдельные серверы для сайтов и свои базы geosite и geoip.
- [Программы и торренты](https://flowlock.cc/docs/apps.md): Как пустить программу целиком через VPN, напрямую или через выбранный сервер, и как включить «Торренты напрямую».
- [Темы и обмен ими](https://flowlock.cc/docs/user-themes.md): Своя тема оформления FlowLock — цвета светлой и тёмной стороны, как поделиться ей ссылкой, QR-кодом или файлом и как принять чужую.
- [Аккаунт и синхронизация](https://flowlock.cc/docs/account.md): Зачем нужен аккаунт FlowLock, как работают синхронизация, вход по коду, шифрование, общие подписки и статистика трафика.
- [TUN, системный прокси и kill switch](https://flowlock.cc/docs/modes.md): Чем отличаются режимы TUN и системного прокси, зачем права администратора, как работает kill switch и переключение серверов на лету.
- [Частые вопросы](https://flowlock.cc/docs/faq.md): Ответы на частые вопросы о FlowLock — откуда серверы, почему macOS не даёт открыть программу, что делать, если подписка не загружается.

## For providers (en)

- [Provider cabinet](https://flowlock.cc/en/docs/providers.md): What the FlowLock provider cabinet gives you and how to connect your subscriptions to it in five steps.
- [ID in the subscription](https://flowlock.cc/en/docs/provider-id.md): Three ways to pass your provider ID to the app: a response header, a line in the subscription body, or the link fragment.
- [Domains and ownership checks](https://flowlock.cc/en/docs/domains.md): How to verify a subscription domain with a TXT record or a file, what the statuses mean, and why the exact name is what gets verified.
- [Subscription headers](https://flowlock.cc/en/docs/headers.md): What FlowLock reads from any subscription's response (name, traffic and expiry, support, announcement, refresh interval) and what it sends to the panel itself.
- [App management](https://flowlock.cc/en/docs/app-management.md): Subscription parameters a provider uses to manage FlowLock: info block, renewal, moving, fallback address and app settings; what FlowLock doesn't read and why.
- [Subscription colour theme](https://flowlock.cc/en/docs/themes.md): The flowlock-theme header: FlowLock interface colours for the people on your subscription, the value format and the readability rules.
- [Subscription routing rules](https://flowlock.cc/en/docs/routing.md): How a provider sends rules for what goes through the VPN and what goes direct: a Happ profile in the routing header, Xray and sing-box JSON.
- [Limited and HWID links](https://flowlock.cc/en/docs/install-links.md): Subscription links with a device limit, or for a single device by HWID, where the user never sees the subscription address.
- [Notifications and commands](https://flowlock.cc/en/docs/messages.md): Messages to users of verified subscriptions: notifications, a window on top and safe commands to the app, recipients, scheduling and limits.
- [Statistics](https://flowlock.cc/en/docs/stats.md): How many devices use your subscriptions: in total, active in the last 30 days, by system and by month.
- [flowlock:// links](https://flowlock.cc/en/docs/links.md): Commands of the flowlock:// scheme: connect, disconnect, add a subscription, import, routing rules, limited links and themes.
- [FlowLock User-Agent](https://flowlock.cc/en/docs/user-agent.md): Which User-Agent FlowLock sends when it downloads a subscription, how to recognise FlowLock in a panel, and what happens if the panel doesn't accept it.
- [API reference](https://flowlock.cc/en/docs/api.md): The provider cabinet API for panels and bots: keys, domains, limited links, messages, devices and statistics, with curl examples.
- [Limits and “Unlimited”](https://flowlock.cc/en/docs/limits.md): How many domains, links, devices and messages the free cabinet allows, what “Unlimited” lifts for 1000 ₽ a month, and how to pay and renew.
- [Privacy: what the provider sees](https://flowlock.cc/en/docs/privacy.md): What data about users the provider sees in the cabinet, what nobody sees, how long everything is kept, and how a user turns check-ins off.

## For users (en)

- [Installation](https://flowlock.cc/en/docs/install.md): How to install FlowLock on macOS, Windows and Linux, what to do about the “unidentified developer” warning, and how updates arrive.
- [Subscriptions](https://flowlock.cc/en/docs/subscriptions.md): How to add your provider's subscription to FlowLock, what the subscription card shows, HWID, and subscriptions from limited links.
- [Routes and custom databases](https://flowlock.cc/en/docs/rules.md): Routing modes, your own via VPN, direct and block rules, subscription rules, separate servers for sites, and custom geosite and geoip databases.
- [Apps and torrents](https://flowlock.cc/en/docs/apps.md): How to send a whole app through the VPN, directly or through a chosen server, and how to turn on “Torrents direct”.
- [Themes and sharing them](https://flowlock.cc/en/docs/user-themes.md): Your own FlowLock colour theme: colours for the light and dark sides, how to share it as a link, QR code or file, and how to accept someone else's.
- [Account and sync](https://flowlock.cc/en/docs/account.md): Why you might want a FlowLock account, and how sync, sign-in with a code, encryption, shared subscriptions and traffic statistics work.
- [TUN, system proxy and kill switch](https://flowlock.cc/en/docs/modes.md): How TUN and system proxy modes differ, why administrator rights are needed, how the kill switch works, and switching servers on the fly.
- [FAQ](https://flowlock.cc/en/docs/faq.md): Answers to common questions about FlowLock: where the servers come from, why macOS won't open the app, and what to do if a subscription doesn't load.

## Optional

- [All pages in Russian](https://flowlock.cc/llms-full.txt)
- [All pages in English](https://flowlock.cc/en/llms-full.txt)