Актуализация страниц о деплое и разработке + мелочи по оформлению
This commit is contained in:
@@ -0,0 +1,100 @@
|
||||
---
|
||||
icon: material/file-refresh-outline
|
||||
tags: ["статусы", "плейлисты", "каналы", "iptvc"]
|
||||
---
|
||||
|
||||
# :material-file-refresh-outline: Проверки и статусы
|
||||
|
||||
Плейлисты проверяются автоматически с некоей периодичностью, если приложение запущено [соответствующим образом](deploy.md).
|
||||
|
||||
Хотя я и стараюсь улучшать качество проверок, но всё же рекомендую проверять желаемые плейлисты самостоятельно вручную, ибо нет никаких гарантий:
|
||||
|
||||
* что плейлист составлен корректно и обработается правильно;
|
||||
* что плейлист (не) работоспособен:
|
||||
* он может работать, но проверка заврешена из-за какой-то технической ошибки;
|
||||
* он уже может не работать, но результаты последней проверки показывают обратное;
|
||||
* что транслируемый контент соответствует заявленным названиям;
|
||||
* что сейчас или через X времени там не окажется [заглушка](../../aggregator/faq.md#заглушка).
|
||||
|
||||
## Статусы плейлистов { id="playlists" }
|
||||
|
||||
Каждый плейлист может быть в одном из трёх статусов:
|
||||
|
||||
* <span class="badge unknown">unknown</span> — **Плейлист в очереди на проверку**
|
||||
Он сменит свой статус в ближайшие минуты.
|
||||
|
||||
* <span class="badge online">online</span> — **Плейлист проверен**
|
||||
Это не значит, что он работает.
|
||||
Это значит, что адрес плейлиста корректен и *вероятно* там *что-то* транслируется.
|
||||
|
||||
* <span class="badge offline">offline</span> — **Плейлист недоступен**
|
||||
Либо плейлист удалён с сервера, где он располагался когда-то, либо это просто разовый сбой (например, таймаут проверки).
|
||||
*Возможно*, (не) скоро он (не) станет доступен.
|
||||
|
||||
!!! info "Обрати внимание"
|
||||
Независимо от статуса плейлиста на сайте, его можно добавить в свой плеер по "Ссылке для ТВ" и проверить самостоятельно.
|
||||
Проверка плейлиста не влияет на его работоспособность.
|
||||
|
||||
### Дополнительные возможности { id="extra" }
|
||||
|
||||
Если плейлист <span class="badge online">online</span> (успешно проверен), то у него могут быть дополнительные значки:
|
||||
|
||||
* <span class="badge online-percent">95%</span> — количество рабочих каналов на момент проверки;
|
||||
* <span class="badge adult">18+</span> — плейлист имеет каналы для взрослых;
|
||||
* <span class="badge lapka">:material-paw:</span> — плейлист может быть нестабилен:
|
||||
Это значит, что в нём есть каналы со специальными параметрами: токенами, логинами и паролями, которые рано или поздно истекут или будут заблокированы (если ещё не).
|
||||
Также это признак бесплатного пробного периода.
|
||||
* :material-folder-open-outline: — каналы плейлиста разбиты на группы (например, музыкальные каналы и региональные);
|
||||
* :material-newspaper-variant-outline: — плейлист предоставляет программу передач для каналов;
|
||||
* :material-skip-backward: — плейлист предоставляет возможность перемотки передач.
|
||||
|
||||
Если плейлист <span class="badge unknown">unknown</span> или <span class="badge offline">offline</span>, этих иконок не будет.
|
||||
|
||||
!!! info "Обрати внимание"
|
||||
1. Пропорции рабочих и нерабочих каналов в плейлистах могут меняться от проверки к проверке.
|
||||
Это нормально, таковы технические особенности проверки.
|
||||
2. Работа архива и программы передач зависит от выбранного [плеера](../../ref/players.md).
|
||||
Некоторые это просто не поддерживают.
|
||||
|
||||
## Статусы каналов { id="channels" }
|
||||
|
||||
Каждый канал в любом плейлисте может быть в одном из трёх статусов:
|
||||
|
||||
* <span class="icon online">:material-radiobox-marked:</span> — ***Возможно*, канал работает**
|
||||
Но там может транслироваться какая-нибудь [заглушка](../../aggregator/faq.md#заглушка) (например, от [Wink](../../aggregator/faq.md#wink)) или другой канал.
|
||||
|
||||
* <span class="icon offline">:material-radiobox-marked:</span> — ***Возможно*, канал не работает**
|
||||
Чем больше таких каналов в плейлисте, тем сложнее будет листать плейлист в плеере или на ТВ.
|
||||
Но *возможно когда-нибудь* плейлист обновят и канал будет работать исправно.
|
||||
Также здесь может быть просто разовый сбой (например, таймаут проверки).
|
||||
|
||||
* <span class="badge lapka">:material-paw:</span> — **Канал может быть нестабилен**
|
||||
Это значит, что для него указаны специальные параметры: токен, логин или пароль, которые рано или поздно истекут или будут заблокированы.
|
||||
Тогда канал перестанет работать.
|
||||
Также это признак бесплатного пробного периода.
|
||||
|
||||
* <span class="badge adult">18+</span> — **Канал для взрослых**
|
||||
Читай ниже.
|
||||
|
||||
## Контент для взрослых { id="adult" }
|
||||
|
||||
Это откровенно порнографический, эротический или другой контент, неприемлемый для детской психики (например, жанровые каналы с фильмами ужасов).
|
||||
|
||||
Если при проверке плейлиста обнаружен хотя бы один канал для взрослых, то этот канал и весь плейлист помечается значком <span class="badge adult">18+</span>.
|
||||
|
||||
Такие каналы определяются благодаря правилам, описанным в файле [channels.json](../../ref/formats/channels.md).
|
||||
Они применяются к названиям каналов и их атрибутам (`tvg-id`, `tvg-name`), которые описывают канал в плейлисте.
|
||||
|
||||
Для каналов со взрослым контентом применяется тег `adult`.
|
||||
|
||||
!!! warning "Обрати внимание"
|
||||
Далеко не все каналы могут быть помечены таким тегом.
|
||||
Хотя набор правил для тегов очень богат, но невозможно угадать все каналы с приемлемой точностью.
|
||||
Почему — читай [здесь](../../ref/formats/channels.md#warnings).
|
||||
|
||||
---
|
||||
|
||||
!!! info "Примечание"
|
||||
Теперь должно стать понятно, почему я не даю и не могу дать никаких гарантий относительно результатов проверок и тегов.
|
||||
Каждый раз это просто непредсказуемый процесс.
|
||||
|
||||
@@ -5,10 +5,10 @@ tags: ["плееры", "плейлисты"]
|
||||
|
||||
# :material-television-play: Как подключить плейлист
|
||||
|
||||
1. Найти какой-нибудь [плеер](../../common/players.md)
|
||||
1. Найти какой-нибудь [плеер](../../ref/players.md)
|
||||
2. Узнать как в него добавить плейлист по ссылке
|
||||
3. Найти желаемый плелист из [списка](./list.md)
|
||||
4. Найти на странице ["Ссылку для ТВ"](details.md#shortlink) и ввести (скопировать) её в поле ввода адреса в плеере
|
||||
|
||||
Для некоторых [плееров](../../common/players.md) уже есть информация как добавить плейлист.
|
||||
Для некоторых [плееров](../../ref/players.md) уже есть информация как добавить плейлист.
|
||||
|
||||
|
||||
+307
-27
@@ -1,29 +1,133 @@
|
||||
---
|
||||
icon: material/upload-network
|
||||
tags: ["iptvc", "docker", "deploy"]
|
||||
tags: ["iptvc", "docker", "deploy", "nginx", "apache", "ssl"]
|
||||
---
|
||||
|
||||
# :material-upload-network: Развёртывание и доставка обновлений
|
||||
# :material-upload-network: Развёртывание сайта
|
||||
|
||||
В этом разделе описан фактический порядок настройки окружения `iptv` с приложением `iptvc`, хранилищем KeyDB и сайтом документации.
|
||||
В этом разделе описан фактический порядок настройки `iptvc`, хранилищем KeyDB и документацией.
|
||||
|
||||
## Требования { id="requirements" }
|
||||
## :material-flag-checkered: Базовый вариант развёртывания сервиса { id="local" }
|
||||
|
||||
Для запуска приложения не нужен репозиторий с исходниками.
|
||||
Достаточно [скачать актуальный релиз](../install.md) для своей платформы.
|
||||
|
||||
Чтобы запустить его, достаточно расположить его в любой удобной директории на диске и выполнить команду:
|
||||
|
||||
```shell
|
||||
./iptvc serve
|
||||
```
|
||||
|
||||
Откройте в браузере адрес <http://localhost:8800/> и убедитесь в работе сервиса.
|
||||
|
||||
Вы должны увидеть ошибку:
|
||||
|
||||
```
|
||||
Не удалось загрузить список плейлистов. Проверьте наличие файла playlists.ini.
|
||||
```
|
||||
|
||||
Всё верно.
|
||||
Для полноценной работы приложения в качестве веб-сервиса следует провести минимальные настройки.
|
||||
|
||||
### Список плейлистов — `playlists.ini` { id="playlists" }
|
||||
|
||||
!!! info "Синтаксис описан в [этом разделе документации](../../ref/formats/playlists.md)"
|
||||
|
||||
Без этого файла нет смысла запускать веб-сервис.
|
||||
|
||||
Файл можно положить рядом с `iptvc`.
|
||||
|
||||
Как только вы подготовите файл, перезапустите сервис командой выше.
|
||||
Вы должны увидеть список плейлистов на главной странице.
|
||||
|
||||
Но все они будут серого цвета и будет доступна только базовая информация о них.
|
||||
Зато будут работать короткие ссылки и их уже можно будет казывать в своём любимом [плеере](../../ref/players.md).
|
||||
|
||||
Чтобы плейлисты позеленели, нужно запустить приложение в режиме активной проверки плейлистов:
|
||||
|
||||
```shell
|
||||
./iptvc serve --check
|
||||
```
|
||||
|
||||
!!! tip "У этой команды есть и другие аргументы"
|
||||
Полный список указан здесь: [**Команда `serve`**](../commands/serve.md).
|
||||
Они позволят, при необходимости, очень гибко настроить параметры сайта и режима проверки.
|
||||
|
||||
### Список правил — `channels.json` { id="channels" }
|
||||
|
||||
!!! info "Синтаксис описан в [этом разделе документации](../../ref/formats/channels.md)"
|
||||
|
||||
Без этого файла можно жить: веб-сервис будет работать, плейлисты и каналы будут проверяться, короткие ссылки в вашем распоряжении.
|
||||
|
||||
Но **все** каналы будут помечены как `#untagged`.
|
||||
Это значит, что такие каналы можно будет искать только по названиям.
|
||||
Поиск по жанрам и странам будет недоступен.
|
||||
|
||||
Это может быть важно для разных пользователей.
|
||||
|
||||
Поэтому варианта здесь три:
|
||||
|
||||
1. продолжать пользоваться сервисом как есть;
|
||||
2. подготовить свой файл `channels.json` согласно его правил синтаксиса;
|
||||
3. скачать готовый файл из репозитория: [channels.json](https://git.axenov.dev/IPTV/iptvc/raw/branch/master/channels.json)
|
||||
|
||||
??? tip "Рекомендуется третий вариант"
|
||||
Файл в репозитории периодически обновляется по тем плейлистам, которые широко распространяются в сети.
|
||||
В нём собраны правла для многих телеканалов СНГ и Европы.
|
||||
Хотя и далеко не все.
|
||||
Поэтому, если вы умеете работать с регулярными выражениями, вы можете предложить свои правила в репозиторий.
|
||||
|
||||
Файл можно положить туда же — рядом с `iptvc`.
|
||||
|
||||
Когда файл будет готов, перезапустите приложение предыдущей командой.
|
||||
|
||||
Поздравляю, теперь у вас свой собственный рабочий агрегатор плейлистов.
|
||||
Вы можете его использовать в домашней сети или на своём ПК — для мониторинга состояния плейлистов или для просмотра.
|
||||
|
||||
### Конфигурация приложения — `config.yml`
|
||||
|
||||
!!! info "Синтаксис описан в [этом разделе документации](../../ref/config.md)"
|
||||
|
||||
Теперь можете приступить к конфигурации приложения.
|
||||
|
||||
Это позволит вам освободить руки и мозг, чтобы не запоминать и не писать длинные аргументы, а также изменять параметры, недоступные через в командной строке.
|
||||
|
||||
Файл можно положить туда же — рядом с `iptvc`.
|
||||
|
||||
Но постойте.
|
||||
Вы уже несколько раз перезапустили приложение, а результаты проверки плейлистов сбрасываются.
|
||||
А если вы перезагрузите компьютер, то придётся заново вручную запускать приложение.
|
||||
|
||||
Давайте это исправим в следующих шагах.
|
||||
|
||||
## :simple-docker: Развёртывание через Docker { id="docker" }
|
||||
|
||||
Установка docker осуществляется согласно официальной документации.
|
||||
|
||||
??? tip "Для MacOS вместо Docker Desktop рекомендую [OrbStack](https://orbstack.dev)"
|
||||
Он быстрый, лёгкий, бесплатный и не жрёт столько ресурсов, как официальное приложение.
|
||||
В общем-то, сама по себе гуйня для докера бесполезна и не нужна, но на маке эта тулза поможет с запуском докера на сокете в пространстве текущего пользователя.
|
||||
К сожалению, иначе на маке докер работать в фоне не может из-за политик безопасности.
|
||||
Либо может, но это потребует кучу гемора на ровном месте.
|
||||
|
||||
Для этого нужно будет скачать ещё один файл из репозитория: [compose.yml](https://git.axenov.dev/IPTV/iptvc/raw/branch/master/compose.yml)
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
- [Docker](https://docs.docker.com/engine/install/) с плагином `docker compose` версии 2
|
||||
- Git и доступ к репозиторию `git.axenov.dev/IPTV`
|
||||
- Права на запись в каталог данных KeyDB
|
||||
- Доступ к registry `git.axenov.dev`, если вы публикуете образ `iptvc`
|
||||
|
||||
!!! warning "Только docker compose v2"
|
||||
Используйте команду `docker compose`.
|
||||
Устаревшая команда `docker-compose` в этом сценарии не поддерживается.
|
||||
|
||||
## Подготовка репозитория { id="repository" }
|
||||
|
||||
Клонируйте основной репозиторий и перейдите в его каталог:
|
||||
|
||||
```bash
|
||||
git clone https://git.axenov.dev/IPTV.git
|
||||
git clone https://git.axenov.dev/IPTV/.git
|
||||
cd IPTV
|
||||
```
|
||||
|
||||
@@ -108,30 +212,206 @@ docker compose logs -f iptvc
|
||||
docker compose down
|
||||
```
|
||||
|
||||
## Реверс-прокси и SSL { id="reverse-proxy" }
|
||||
|
||||
Для публикации приложения на домене с HTTPS настроим реверс-прокси, который будет терминировать SSL и проксировать запросы на контейнеры `iptvc` (порт `8800`) и `docs` (порт `8801`).
|
||||
|
||||
Ниже рассмотрены два варианта: nginx и Apache2.
|
||||
|
||||
!!! tip "site.base-url"
|
||||
После настройки домена укажите внешний адрес в `config.yml` или `.env`:
|
||||
|
||||
```yaml
|
||||
site:
|
||||
base-url: https://example.com
|
||||
```
|
||||
|
||||
Или через переменную окружения:
|
||||
|
||||
```bash
|
||||
SITE_BASE_URL=https://example.com
|
||||
```
|
||||
|
||||
### Подготовка { id="reverse-proxy-prep" }
|
||||
|
||||
Убедитесь, что:
|
||||
|
||||
- домен `example.com` (и при необходимости `docs.example.com`) направляет A-запись на IP сервера;
|
||||
- порты `80` и `443` открыты в файрволе;
|
||||
- Docker-окружение запущено (`docker compose up -d`);
|
||||
- порты `8800` и `8801` доступны локально (проверьте `curl -I http://localhost:8800`).
|
||||
|
||||
### nginx { id="reverse-proxy-nginx" }
|
||||
|
||||
Установите nginx и Certbot:
|
||||
|
||||
```bash
|
||||
sudo apt update
|
||||
sudo apt install -y nginx certbot python3-certbot-nginx
|
||||
```
|
||||
|
||||
Создайте конфигурацию для приложения:
|
||||
|
||||
```nginx title="/etc/nginx/sites-available/iptvc" linenums="1"
|
||||
server {
|
||||
listen 80;
|
||||
server_name example.com;
|
||||
|
||||
location / {
|
||||
proxy_pass http://127.0.0.1:8800;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
При необходимости добавьте отдельный `server`-блок для документации:
|
||||
|
||||
```nginx title="/etc/nginx/sites-available/iptv-docs" linenums="1"
|
||||
server {
|
||||
listen 80;
|
||||
server_name docs.example.com;
|
||||
|
||||
location / {
|
||||
proxy_pass http://127.0.0.1:8801;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Включите конфигурации и проверьте синтаксис:
|
||||
|
||||
```bash
|
||||
sudo ln -s /etc/nginx/sites-available/iptvc /etc/nginx/sites-enabled/
|
||||
sudo ln -s /etc/nginx/sites-available/iptv-docs /etc/nginx/sites-enabled/
|
||||
sudo nginx -t
|
||||
sudo systemctl reload nginx
|
||||
```
|
||||
|
||||
Получите SSL-сертификат через Certbot:
|
||||
|
||||
```bash
|
||||
sudo certbot --nginx -d example.com -d docs.example.com
|
||||
```
|
||||
|
||||
Certbot автоматически изменит конфигурацию nginx, добавит HTTPS и настройке редирект с HTTP на HTTPS.
|
||||
|
||||
Проверьте автоматическое продление:
|
||||
|
||||
```bash
|
||||
sudo certbot renew --dry-run
|
||||
```
|
||||
|
||||
### Apache2 { id="reverse-proxy-apache" }
|
||||
|
||||
Установите Apache2 и Certbot:
|
||||
|
||||
```bash
|
||||
sudo apt update
|
||||
sudo apt install -y apache2 certbot python3-certbot-apache
|
||||
```
|
||||
|
||||
Включите необходимые модули:
|
||||
|
||||
```bash
|
||||
sudo a2enmod proxy proxy_http ssl rewrite headers
|
||||
sudo systemctl restart apache2
|
||||
```
|
||||
|
||||
Создайте конфигурацию виртуального хоста для приложения:
|
||||
|
||||
```apache title="/etc/apache2/sites-available/iptvc.conf" linenums="1"
|
||||
<VirtualHost *:80>
|
||||
ServerName example.com
|
||||
|
||||
ProxyPreserveHost On
|
||||
ProxyPass / http://127.0.0.1:8800/
|
||||
ProxyPassReverse / http://127.0.0.1:8800/
|
||||
|
||||
RequestHeader set X-Forwarded-Proto "http"
|
||||
RequestHeader set X-Forwarded-Port "80"
|
||||
</VirtualHost>
|
||||
```
|
||||
|
||||
При необходимости добавьте виртуальный хост для документации:
|
||||
|
||||
```apache title="/etc/apache2/sites-available/iptv-docs.conf" linenums="1"
|
||||
<VirtualHost *:80>
|
||||
ServerName docs.example.com
|
||||
|
||||
ProxyPreserveHost On
|
||||
ProxyPass / http://127.0.0.1:8801/
|
||||
ProxyPassReverse / http://127.0.0.1:8801/
|
||||
|
||||
RequestHeader set X-Forwarded-Proto "http"
|
||||
RequestHeader set X-Forwarded-Port "80"
|
||||
</VirtualHost>
|
||||
```
|
||||
|
||||
Включите конфигурации и проверьте синтаксис:
|
||||
|
||||
```bash
|
||||
sudo a2ensite iptvc iptv-docs
|
||||
sudo apache2ctl configtest
|
||||
sudo systemctl reload apache2
|
||||
```
|
||||
|
||||
Получите SSL-сертификат через Certbot:
|
||||
|
||||
```bash
|
||||
sudo certbot --apache -d example.com -d docs.example.com
|
||||
```
|
||||
|
||||
Certbot автоматически создаст HTTPS-виртуальные хосты и настроит редирект с HTTP на HTTPS.
|
||||
|
||||
Проверьте автоматическое продление:
|
||||
|
||||
```bash
|
||||
sudo certbot renew --dry-run
|
||||
```
|
||||
|
||||
### Проверка { id="reverse-proxy-check" }
|
||||
|
||||
После настройки откройте в браузере:
|
||||
|
||||
- `https://example.com` — веб-интерфейс `iptvc`;
|
||||
- `https://docs.example.com` — сайт документации.
|
||||
|
||||
Убедитесь, что сертификат валиден, а редирект с HTTP на HTTPS работает.
|
||||
|
||||
!!! note "Ограничение портов"
|
||||
После настройки реверс-прокси можно убрать публикацию портов `8800` и `8801` наружу в `compose.yml`, оставив их доступными только локально.
|
||||
Это предотвратит прямой доступ к сервисам в обход прокси.
|
||||
|
||||
## Сборка образа iptvc { id="image" }
|
||||
|
||||
Для публикации образа используйте скрипт `iptvc/build-docker-image.sh`.
|
||||
|
||||
Скрипт вычисляет версию из Git, собирает образы с тегами `iptvc:<тег>` и `git.axenov.dev/iptv/iptvc:<тег>`, а затем отправляет registry-тег в registry:
|
||||
Для сборки и публикации образа используйте цели Makefile в каталоге `iptvc/`:
|
||||
|
||||
```bash
|
||||
cd iptvc
|
||||
./build-docker-image.sh latest
|
||||
|
||||
# Сборка одноархитектурного образа (linux/amd64 по умолчанию)
|
||||
make image
|
||||
|
||||
# Сборка под arm64
|
||||
make image GOARCH=arm64
|
||||
|
||||
# Сборка с указанием тега
|
||||
make image IMAGE_TAG=v1.2.3
|
||||
```
|
||||
|
||||
Для публикации релизного тега:
|
||||
Для публикации multi-arch манифеста (linux/amd64 + linux/arm64):
|
||||
|
||||
```bash
|
||||
./build-docker-image.sh v1.2.3
|
||||
make image-all
|
||||
```
|
||||
|
||||
По умолчанию скрипт собирает Linux-образ для `amd64`.
|
||||
|
||||
Платформу можно изменить переменными окружения:
|
||||
|
||||
```bash
|
||||
GOOS=linux GOARCH=arm64 ./build-docker-image.sh v1.2.3
|
||||
```
|
||||
Цель `image-all` всегда отправляет образ в registry — это ограничение `docker buildx`: multi-arch манифест нельзя загрузить в локальный Docker daemon.
|
||||
|
||||
Перед публикацией войдите в registry, если это требуется вашей настройкой:
|
||||
|
||||
@@ -140,8 +420,8 @@ docker login git.axenov.dev
|
||||
```
|
||||
|
||||
!!! warning "Рабочее дерево Git"
|
||||
Скрипт переключается на Git-тег, переданный первым аргументом, или на тег, возвращённый `git describe`.
|
||||
Перед запуском сохраните локальные изменения и убедитесь, что нужный тег существует.
|
||||
Версия и коммит вшиваются в бинарь из `git describe` и `git rev-parse` на хосте в момент запуска `make`.
|
||||
Перед сборкой убедитесь, что рабочая копия чистая и находится на нужном теге или коммите.
|
||||
|
||||
## Обновление { id="update" }
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ tags: ["сайт", "статусы", "каналы"]
|
||||
|
||||
Страница содержит подробности об одном конкретном плейлисте.
|
||||
|
||||
В её заголовке указано [название плейлиста](../../common/formats/playlists.md#name).
|
||||
В её заголовке указано [название плейлиста](../../ref/formats/playlists.md#name).
|
||||
|
||||
Ниже страница разделена на две части: слева две вкладки с информацией и список каналов справа.
|
||||
|
||||
@@ -19,17 +19,17 @@ tags: ["сайт", "статусы", "каналы"]
|
||||
|
||||
На этой вкладке выводится таблица со следующими строками:
|
||||
|
||||
* **Код** — короткий уникальный [код плейлиста](../../common/formats/playlists.md#code);
|
||||
* **Описание** — [описание плейлиста](../../common/formats/playlists.md#desc) (при наличии);
|
||||
* **Код** — короткий уникальный [код плейлиста](../../ref/formats/playlists.md#code);
|
||||
* **Описание** — [описание плейлиста](../../ref/formats/playlists.md#desc) (при наличии);
|
||||
* **Ccылка для ТВ** — короткая ссылка, которую можно использовать для [подключения плейлиста](connect.md), подробнее о ней см. ниже;
|
||||
* **Источник** — [ссылка на ресурс](../../common/formats/playlists.md#src), где была найдена ссылка на плейлист (при наличии);
|
||||
* **Источник** — [ссылка на ресурс](../../ref/formats/playlists.md#src), где была найдена ссылка на плейлист (при наличии);
|
||||
* **Наполнение**:
|
||||
* группы — количество групп, на которые поделены каналы;
|
||||
* каналы — количества каналов общее, онлайн и оффлайн;
|
||||
(всё по нулям, если плейлист <span class="badge offline">offline</span>)
|
||||
* **Возможности** — наличие программы передач и перемотки каналов;
|
||||
* **M3U** — [прямая ссылка](../../common/formats/playlists.md#pls) на плейлист;
|
||||
* **Проверка плейлиста** — дата и время последней [проверки](../../aggregator/checks.md) плейлиста с помощью [iptvc](../overview.md);
|
||||
* **M3U** — [прямая ссылка](../../ref/formats/playlists.md#pls) на плейлист;
|
||||
* **Проверка плейлиста** — дата и время последней [проверки](checks.md) плейлиста с помощью [iptvc](../overview.md);
|
||||
* **Ошибка проверки** — текст ошибки, которая возникла при проверке
|
||||
(только если плейлист <span class="badge offline">offline</span>)
|
||||
|
||||
@@ -82,7 +82,7 @@ tags: ["сайт", "статусы", "каналы"]
|
||||
Справа от строки поиска есть **кнопки фильтрации каналов по их статусу**.
|
||||
Справа — **кнопка сброса** для отображения всех каналов.
|
||||
|
||||
Под строкой поиска есть [**облако тегов**](../../common/formats/channels.md#доступные-теги).
|
||||
Под строкой поиска есть [**облако тегов**](../../ref/formats/channels.md#доступные-теги).
|
||||
|
||||
!!! question inline end "Про теги"
|
||||
Откуда они там появляются, можешь прочесть [здесь](../../common/index.md) и [здесь](../overview.md).
|
||||
@@ -99,11 +99,15 @@ tags: ["сайт", "статусы", "каналы"]
|
||||
Она может быть задана в нескольких форматах.
|
||||
Поясню базовые принципы формирования адреса:
|
||||
|
||||
1. необязателен префикс протокола `http://` или `https://` перед доменом
|
||||
2. обязателен домен `m3u.su`
|
||||
1. префикс протокола `http://` или `https://` перед доменом
|
||||
2. ваш домен или IP-адрес, порт после `:`
|
||||
3. обязателен `/код` плейлиста после домена
|
||||
4. необязателен суффикс расширения после кода `.m3u` или `.m3u8`
|
||||
|
||||
Пункты 1 и 2 напрямую зависят от того, как развёрнут сайт.
|
||||
Базово, если запускать на своём ПК без дополнительных настроек, то адрес будет `http://localhost:8000`.
|
||||
Доступ по домену требует, помимо самого домена, грамотную настройку реверс-прокси и SSL (в наше время иначе уже не модно).
|
||||
|
||||
На примере ниже я наглядно покажу все возможные ссылки на один и тот же плейлист с кодом `ru`:
|
||||
|
||||
```
|
||||
@@ -119,12 +123,12 @@ m3u.su/ru
|
||||
```
|
||||
|
||||
!!! info "Адрес может быть любым"
|
||||
Смотря как будет развёрнут сайт, ты можешь заходить на localhost, либо по прямому IP-адресу или доменному имения.
|
||||
Смотря как будет развёрнут сайт, ты можешь заходить на `localhost`, либо по прямому IP-адресу или доменному имени.
|
||||
См. раздел [**Развёртывание**](deploy.md) для подробностей.
|
||||
|
||||
По идее, можешь использовать любую ссылку из подобных, т. к. технически они отработают одинаково.
|
||||
|
||||
А вот твой [плеер](../../common/players.md) может не принять какую-то из них.
|
||||
А вот твой [плеер](../../ref/players.md) может не принять какую-то из них.
|
||||
Так что, если не подойдёт один формат, используй другой — добавь префикс или суффикс.
|
||||
|
||||
Префикс плееру требуется чаще всего, потому что он при добавлении плейлиста проверяет — а ссылку ли мне вообще предоставил пользователь?
|
||||
|
||||
@@ -36,7 +36,7 @@ tags: ["iptvc", "serve", "сайт"]
|
||||
|
||||
## Шаг 2. Добавляем плейлисты
|
||||
|
||||
Список плейлистов описывается в файле [`playlists.ini`](../../common/formats/playlists.md).
|
||||
Список плейлистов описывается в файле [`playlists.ini`](../../ref/formats/playlists.md).
|
||||
Создадим его рядом с `iptvc`:
|
||||
|
||||
```ini title="playlists.ini"
|
||||
@@ -66,7 +66,7 @@ pls = 'https://example.com/movies.m3u'
|
||||
Чтобы статусы появились, нужно включить фоновую проверку.
|
||||
|
||||
!!! tip "Путь к ini-файлу"
|
||||
Если файл лежит не рядом с программой, укажите путь через флаг [`-i`](../commands/serve.md#ini) или в [`config.yml`](../../common/config/config.md) → `app.playlists`.
|
||||
Если файл лежит не рядом с программой, укажите путь через флаг [`-i`](../commands/serve.md#ini) или в [`config.yml`](../../ref/config.md) → `app.playlists`.
|
||||
|
||||
---
|
||||
|
||||
@@ -92,7 +92,7 @@ pls = 'https://example.com/movies.m3u'
|
||||
./iptvc serve --check --repeat 1
|
||||
```
|
||||
|
||||
Если не хочется каждый раз писать `--check`, можно включить проверку через [`config.yml`](../../common/config/config.md):
|
||||
Если не хочется каждый раз писать `--check`, можно включить проверку через [`config.yml`](../../ref/config.md):
|
||||
|
||||
```yaml title="config.yml"
|
||||
check:
|
||||
@@ -106,7 +106,7 @@ check:
|
||||
## Шаг 4. Настраиваем внешний вид сайта
|
||||
|
||||
Сайт можно настроить под себя: заголовок, иконку, навигацию в шапке и ссылки в подвале.
|
||||
Всё это — в секции [`site`](../../common/config/config.md) файла `config.yml`.
|
||||
Всё это — в секции [`site`](../../ref/config.md) файла `config.yml`.
|
||||
|
||||
```yaml title="config.yml"
|
||||
site:
|
||||
@@ -150,7 +150,7 @@ site:
|
||||
## Шаг 5. Добавляем теги каналам
|
||||
|
||||
Теги помогают посетителям находить каналы по темам: спорт, фильмы, музыка и так далее.
|
||||
Правила описываются в файле [`channels.json`](../../common/formats/channels.md).
|
||||
Правила описываются в файле [`channels.json`](../../ref/formats/channels.md).
|
||||
|
||||
```json title="channels.json"
|
||||
[
|
||||
@@ -169,13 +169,13 @@ site:
|
||||
]
|
||||
```
|
||||
|
||||
Путь к файлу указывается в [`config.yml`](../../common/config/config.md) → `app.tags` или через флаг [`-t`](../commands/serve.md#tags):
|
||||
Путь к файлу указывается в [`config.yml`](../../ref/config.md) → `app.tags` или через флаг [`-t`](../commands/serve.md#tags):
|
||||
|
||||
```bash
|
||||
./iptvc serve --check -t /path/to/channels.json
|
||||
```
|
||||
|
||||
Полный список доступных тегов — в [справочнике по channels.json](../../common/formats/channels.md#доступные-теги).
|
||||
Полный список доступных тегов — в [справочнике по channels.json](../../ref/formats/channels.md#доступные-теги).
|
||||
|
||||
---
|
||||
|
||||
@@ -185,7 +185,7 @@ site:
|
||||
Если программу перезапустить — все результаты пропадут, и плейлисты снова станут `unknown` до следующей проверки.
|
||||
|
||||
Кеш решает эту проблему: результаты сохраняются в KeyDB (или Redis) и переживают перезапуск.
|
||||
Включается одной строкой в [`config.yml`](../../common/config/config.md):
|
||||
Включается одной строкой в [`config.yml`](../../ref/config.md):
|
||||
|
||||
```yaml title="config.yml"
|
||||
cache:
|
||||
@@ -217,7 +217,7 @@ CACHE_ENABLED=true CACHE_TTL=3600 ./iptvc serve --check
|
||||
## Шаг 7. Тонкая настройка проверки
|
||||
|
||||
Когда плейлистов много, полезно управлять параллелизмом, таймаутами и задержками.
|
||||
Все параметры — в секции [`check`](../../common/config/config.md) файла `config.yml`.
|
||||
Все параметры — в секции [`check`](../../ref/config.md) файла `config.yml`.
|
||||
|
||||
### Параллелизм
|
||||
|
||||
@@ -277,7 +277,7 @@ check:
|
||||
user-agent: Mozilla/5.0 (Linux; Android 11) AppleWebKit/537.36
|
||||
```
|
||||
|
||||
Все эти параметры можно также задавать через [переменные окружения](../../common/config/config.md) или [CLI-флаги](../commands/serve.md) — они имеют наивысший приоритет.
|
||||
Все эти параметры можно также задавать через [переменные окружения](../../ref/config.md) или [CLI-флаги](../commands/serve.md) — они имеют наивысший приоритет.
|
||||
|
||||
---
|
||||
|
||||
@@ -403,15 +403,15 @@ docker compose up -d
|
||||
|
||||
## Краткая шпаргалка
|
||||
|
||||
| Задача | Как |
|
||||
| ----------------------------- | ------------------------------------------------------- |
|
||||
| Запустить сайт | `./iptvc serve` |
|
||||
| С проверкой плейлистов | `./iptvc serve --check` |
|
||||
| На другом порту | `./iptvc serve -p 3000` |
|
||||
| С ini-файлом из другого места | `./iptvc serve -i /path/to/playlists.ini` |
|
||||
| С кешем | `./iptvc serve --check --cache-enabled` |
|
||||
| Один цикл проверки | `./iptvc serve --check --repeat 1` |
|
||||
| Пауза 2 минуты между циклами | `./iptvc serve --check --playlists-all-cooldown 120` |
|
||||
| Подробные логи | `./iptvc serve --check --verbose` |
|
||||
| Задача | Как |
|
||||
| ----------------------------- | ---------------------------------------------------- |
|
||||
| Запустить сайт | `./iptvc serve` |
|
||||
| С проверкой плейлистов | `./iptvc serve --check` |
|
||||
| На другом порту | `./iptvc serve -p 3000` |
|
||||
| С ini-файлом из другого места | `./iptvc serve -i /path/to/playlists.ini` |
|
||||
| С кешем | `./iptvc serve --check --cache-enabled` |
|
||||
| Один цикл проверки | `./iptvc serve --check --repeat 1` |
|
||||
| Пауза 2 минуты между циклами | `./iptvc serve --check --playlists-all-cooldown 120` |
|
||||
| Подробные логи | `./iptvc serve --check --verbose` |
|
||||
|
||||
Полный список параметров — в [справочнике по `config.yml`](../../common/config/config.md), [переменным окружения](../../common/config/config.md) и [команде `serve`](../commands/serve.md).
|
||||
Полный список параметров — в [справочнике по `config.yml`](../../ref/config.md), [переменным окружения](../../ref/config.md) и [команде `serve`](../commands/serve.md).
|
||||
|
||||
@@ -5,10 +5,10 @@ tags: ["плейлисты", "каналы", "теги", "iptvc", "плееры"
|
||||
|
||||
# :material-cogs: Как работает сервис
|
||||
|
||||
1. В специальном файле [playlists.ini](../../common/formats/playlists.md) описываются плейлисты, которые кем-то опубликованы в интернете.
|
||||
1. В специальном файле [playlists.ini](../../ref/formats/playlists.md) описываются плейлисты, которые кем-то опубликованы в интернете.
|
||||
Каждому плейлисту присваивается свой уникальный **короткий код**.
|
||||
2. В специальном файле [channels.json](../../common/formats/channels.md) описываются **ключевые слова** (метки, теги), которые характеризуют каналы.
|
||||
3. В фоновом режиме [работает ПО](../overview.md), которое периодически [проверяет все плейлисты](../../aggregator/checks.md) из п. 1 и **присваивает теги** каналам из п. 2.
|
||||
2. В специальном файле [channels.json](../../ref/formats/channels.md) описываются **ключевые слова** (метки, теги), которые характеризуют каналы.
|
||||
3. В фоновом режиме [работает ПО](../overview.md), которое периодически [проверяет все плейлисты](checks.md) из п. 1 и **присваивает теги** каналам из п. 2.
|
||||
4. На главной странице сайта выводится [весь список плейлистов](list.md), которые описаны в п. 1: с тегами, описаниями и короткими кодами.
|
||||
5. Каждому плейлисту на сайте посвящена [своя страничка](details.md), где отображаются результаты его проверки, проверки его каналов (с присвоенными тегами) и пр.
|
||||
6. Когда пользователь [обращается к плейлисту](connect.md) по короткому коду (например, `https://m3u.su/xyz`), то происходит **переадресация** на исходный плейлист.
|
||||
|
||||
+10
-10
@@ -7,30 +7,30 @@ tags: ["сайт", "плейлисты"]
|
||||
|
||||
Это главная страница сайта.
|
||||
|
||||
|
||||
|
||||
|
||||
Наверху отображаются:
|
||||
|
||||
* дата последнего изменения файла [playlists.ini](../../common/formats/playlists.md)
|
||||
* дата последнего изменения файла [playlists.ini](../../ref/formats/playlists.md)
|
||||
* общее количество плейлистов и с разделением по статусам.
|
||||
|
||||
Ниже — спиcок плейлистов.
|
||||
|
||||
## Из чего состоит список
|
||||
|
||||
* **Код** — короткий уникальный [код плейлиста](../../common/formats/playlists.md#code)
|
||||
* **Код** — короткий уникальный [код плейлиста](../../ref/formats/playlists.md#code)
|
||||
* **Информация о плейлисте**
|
||||
* [статус плейлиста](../../aggregator/checks.md#playlists)
|
||||
* может быть [значок 18+](../../aggregator/checks.md#adult)
|
||||
* [название плейлиста](../../common/formats/playlists.md#name) — ссылка на [страницу плейлиста](details.md)
|
||||
* [статус плейлиста](checks.md#playlists)
|
||||
* может быть [значок 18+](checks.md#adult)
|
||||
* [название плейлиста](../../ref/formats/playlists.md#name) — ссылка на [страницу плейлиста](details.md)
|
||||
под ним:
|
||||
* [иконки возможностей плейлиста](../../aggregator/checks.md#extra) (только при статусе <span class="badge online">online</span>)
|
||||
* [описание плейлиста](../../common/formats/playlists.md#desc) (при наличии)
|
||||
* [список тегов](../../common/formats/channels.md#доступные-теги), собранный со всех каналов после их проверки (только при статусе <span class="badge online">online</span>)
|
||||
* [иконки возможностей плейлиста](checks.md#extra) (только при статусе <span class="badge online">online</span>)
|
||||
* [описание плейлиста](../../ref/formats/playlists.md#desc) (при наличии)
|
||||
* [список тегов](../../ref/formats/channels.md#доступные-теги), собранный со всех каналов после их проверки (только при статусе <span class="badge online">online</span>)
|
||||
* ещё одна ссылка на [страницу плейлиста](details.md)
|
||||
* **Каналов** — фактическое количество каналов в плейлисте (только при статусе <span class="badge online">online</span>) или 0 (при других статусах)
|
||||
* **Ссылка для ТВ** — [короткая ссылка](details.md#shortlink), которую можно использовать для [подключения плейлиста](connect.md).
|
||||
|
||||
В зависимости от ширины экрана, для экономии места может быть скрыто описание с иконками возможностей и короткая ссылка.
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user