Справочник настроек

Все настройки TorrPlay управляются через единый эндпоинт:

PATCH /api/v1/settings

Тело запроса представляет собой объект JSON. Обновляются только переданные поля — поля, не включённые в запрос, сохраняют текущие значения.

Настройки верхнего уровня

Поля только для чтения

При включённой аутентификации GET /api/v1/settings также возвращает два ограниченных токена. Через PATCH их изменить нельзя — сервер игнорирует эти поля в запросе:

Фоновая загрузка

Если включён параметр enable_downloader, TorrPlay автоматически скачивает в фоне торренты с файловым хранилищем. Фоновая загрузка автоматически ставится на паузу, как только начинается стриминг видео, чтобы не забивать интернет-канал, и возобновляется после окончания просмотра. Новые раздачи для загрузки проверяются каждую минуту.

Память для потокового воспроизведения

Подсистема потокового воспроизведения рассчитывает бюджет опережающего чтения из max_memory. При лимите до 64 MiB на него выделяется 50% памяти, а при лимите от 512 MiB — 75%. Этот бюджет делят потоки воспроизведения и предзагрузка, работающие с оперативной памятью, причём подсистема всегда оставляет запас для новых сеансов просмотра. Для файлового хранилища используется окно фиксированного размера.

Формат трекеров

Поле torrent_trackers задаётся массивом строк. Каждый элемент соответствует одному уровню трекеров (tier). Чтобы объединить несколько трекеров в один уровень, перечислите их адреса через запятую в одной строке.

Пример:

[
  "udp://explodie.org:6969",
  "udp://tracker.opentrackr.org:1337,udp://tracker.leechers-paradise.org:6969"
]

В этом примере первый уровень содержит один трекер, а второй — два.

Настройки торрент-клиента

Объект torrent_client определяет поведение BitTorrent-клиента.

Пример: обновление нескольких параметров

Этот запрос за один вызов задаёт лимит оперативной памяти, включает фоновую загрузку, переключает логи в формат JSON и настраивает параметры торрент-клиента:

curl -X PATCH http://localhost:8090/api/v1/settings \
  -H "Content-Type: application/json" \
  -d '{
    "max_memory": 134217728,
    "enable_downloader": true,
    "log_level": "DEBUG",
    "log_format": "json",
    "log_store_size": 500,
    "torrent_trackers": [
      "udp://explodie.org:6969",
      "udp://tracker.opentrackr.org:1337,udp://tracker.leechers-paradise.org:6969"
    ],
    "torrent_client": {
      "download_rate_limit": 10485760,
      "upload_rate_limit": 2097152,
      "disable_ipv6": true,
      "established_conns_per_torrent": 80,
      "seed": true
    }
  }'

В случае успешного выполнения запроса сервер возвращает ответ 204 No Content.