Billy H. scraper

Czego potrzebujemy?

Dockera, lub po prostu działającego pythona na naszej maszynie
docker-compose
Bota na Telegramie (potrzebujemy jego token)
Webhook na kanale Discordowym (potrzebujemy jego URL)

Scraper może wysyłać aktualizacje przez Telegrama, Discorda, lub i tu i tu.

Uruchomienie dockera

Budowanie projektu

Zbudowanie projektu polega na uruchomieniu polecenia

docker build --network=host -t fajfer/billy-h-scraper:latest .

'Czysty' docker

Skrypt można uruchomić jedną linijką, jeżeli nie zależy nam na wygodzie docker-compose

docker run \
  --env WEB_URL='<url>' \
  --env GROUPS='<grupy oddzielone przecinkami>' \
  --env BOT_TOKEN='<token>' \
  --env MSG_DELAY='<int>' \
  --volume ./history:/app/history \
  fajfer/billy-h-scraper:latest

Docker compose

Możemy też utrzymywać konfigurację w wygodnym YAMLu i postawić kontener jednym poleceniem

docker-compose up -d

Zbudowanie obrazu i uruchomienie kontenera za jednym zamachem

Można też zbudować obraz projektu i go uruchomić jednym poleceniem, dzięki docker-compose

docker compose up -d --build

Wyjaśnienie użytych zmiennych

Scraper będzie wysyłał aktualizacje poprzez Telegrama i/lub Discorda jeżeli ich zmienne zostaną dostarczone. Jeżeli oba zestawy zmiennych zostaną dostarczone aktualizacje będą wysyłane i tu i tu.

Zmienne mogą zostać dostarczone przez docker-compose.yaml. Domyślny plik zawiera przykładowy zestaw zmiennych.

Wymagane zmienne

Te zmienne są wymagane niezależnie od tego, czy aktualizacje mają być wysyłane przez Discorda lub Telegrama.

Nazwa	Przykład	Zastosowanie
`WEB_URL`	https://www.wp.pl	Adres URL wybranego shoutboxa
`MSG_DELAY`	60	Zmianna odpowiadająca liczbie sekund zanim zostanie odpytany endpoint `WEB_URL`

Zmienne dotyczące Telegrama

Nazwa	Przykład	Zastosowanie
`GROUPS`	@wp_pl,@onet_pl	ID grup na telegramie oddzielonych przecinkami
`BOT_TOKEN`	000000:AAAAAABBBBBBCCCCCCC	Token, jaki otrzymaliśmy od BotFathera na Telegramie

Zmienne dotyczące Discorda

Nazwa	Przykład	Zastosowanie
`WEBHOOKS`	https://discord.com/api/webhooks/111/AA-BBB-CC	URL Webhooków, można przekazać kila rozdzielonych przecinkami
`AVATAR_URL`	https://shorturl.at/HOVW3	Opcjonalny URL do awatara postów

AVATAR_URL jest parametrem opcjonalnym, bez niego aktualizacje będą miały domyślny awatar Webhooka.