verstak-browser-extension/README.ru.md

108 lines
5.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div align="center">
# Расширение Верстака для браузера
### Отправляйте страницы, выделенный текст, ссылки и файлы из браузера в Верстак.
[English](README.md) · **Русский**
[![Релиз](https://img.shields.io/github/v/release/mirivlad/verstak-browser-extension?include_prereleases\&label=release)](https://github.com/mirivlad/verstak-browser-extension/releases)
![Статус](https://img.shields.io/badge/status-alpha-orange)
[![Лицензия](https://img.shields.io/github/license/mirivlad/verstak-browser-extension)](LICENSE)
</div>
> **Alpha-версия.** Используйте с совместимой alpha-сборкой Verstak Desktop.
Расширение Верстака захватывает страницы, выделенный текст, ссылки и выбранные
файлы и отправляет их в локальный приёмник «Входящие из браузера».
Расширение не знает внутреннего устройства Заметок, Файлов, Активности или
Журнала. Оно только отправляет события захвата через публичный протокол
локального приёмника. Если приёмник недоступен, захваты остаются в очереди
расширения.
## Сборка
```bash
npm ci
npm test
npm run build
```
Результат сборки:
- `dist/chromium`
- `dist/firefox`
Загрузите `dist/chromium` как распакованное расширение в браузеры на базе
Chromium или временно загрузите `dist/firefox` в Firefox при разработке.
## Пассивный учёт активности по доменам
Пассивный учёт **выключен по умолчанию**. При первом использовании расширение
объясняет, что оно записывает; пользователь должен явно включить его в
настройках.
Когда учёт включён, расширение наблюдает только за активной вкладкой и
отправляет ограниченные интервалы как каноническое доменное имя плюс
длительность. Оно никогда не отправляет URL-пути, заголовки страниц, текст
страниц, выделенный текст, нажатия клавиш, историю посещений или время
неактивных вкладок.
Ручные действия «Отправить страницу», «Отправить выделенный текст», «Отправить
ссылку» и «Отправить файл» отделены от пассивного учёта. Они создают записи во
«Входящих из браузера», а не дела или записи журнала.
## Загрузка и обновления в Firefox
Подписанный XPI публикуется на странице
[GitHub Releases](https://github.com/mirivlad/verstak-browser-extension/releases).
Скачайте Firefox-ассет `verstak-firefox-<версия>.xpi` из последнего релиза и
откройте его в Firefox для установки.
После первого публичного релиза установленные копии проверяют GitHub Releases
на наличие обновлений через ассет `updates.json` релиза.
## Сопряжение
1. В Verstak Desktop откройте настройки «Входящих из браузера».
2. Скопируйте адрес приёмника и токен сопряжения.
3. Вставьте оба значения в настройки расширения и сохраните.
Смена токена в Desktop делает недействительным значение, сохранённое в расширении.
## Язык
Настройки расширения предлагают выбор языка: `System / English / Russian`.
`System` следует языку интерфейса браузера: русская локаль выбирает русский,
остальные — английский.
Расширение и desktop-приложение хранят выбор языка независимо. Изменение одного
не меняет другой.
## Протокол локального приёмника
Эндпоинт по умолчанию:
```text
POST http://127.0.0.1:47731/api/browser-inbox/v1/captures
```
Заголовки:
- `Content-Type: application/json`
- `X-Verstak-Receiver-Token: <токен>` — обязателен, когда приёмник в paired mode
Поддерживаемые виды захвата:
- `page` — страница (url, title, domain)
- `selection` — выделенный текст
- `link` — ссылка (url, опционально текст)
- `file` — файл (имя, base64 или текст до 8 МБ)
## Лицензия
Copyright © 2026 Verstak contributors. Распространяется на условиях
[GNU AGPLv3 или новее](LICENSE).