Talpinkite FreshRSS Managed VPS serveryje: jūsų RSS srautai jūsų serveryje

Ką daro FreshRSS

FreshRSS yra PHP kalba parašyta RSS srautų kaupimo programa, skirta talpinti savo serveryje. README ją apibūdina kaip lengvą, paprastą naudoti, galingą ir pritaikomą, išverstą į daugiau nei dvidešimt kalbų. Tai daugelio naudotojų programa su anoniminio skaitymo režimu ir pasirinktinėmis žymomis.

• Skaitymas: jūsų prenumeratos, surūšiuotos į kategorijas, žymos, mėgstamiausi ir išsaugotos paieškos.
• WebSub: FreshRSS naujus straipsnius iškart gauna iš suderinamų šaltinių, kurie juos patys atsiunčia, nelaukdami kito atnaujinimo.
• Turinio nuskaitymas: svetainės be RSS ar Atom srauto puslapį FreshRSS pati perskaito pagal XPath taisykles, taip pat gali skaityti JSON dokumentus.
• Dalijimasis: straipsnių rinkinį galima iš naujo paskelbti HTML, RSS ar OPML formatu.
• Programėlės: API mobiliosioms ir darbalaukio programėlėms, komandinės eilutės sąsaja ir plėtiniai.

FreshRSS kuria jos bendruomenė GitHub platformoje, o oficialią svetainę leidžia FreshRSS bendruomenė. Plėtiniai laikomi atskiroje saugykloje, o dokumentacija skirta naudotojams, administratoriams ir kūrėjams.

Ką leidžia AGPL-3.0 licencija

FreshRSS platinama pagal GNU Affero General Public License, 3 versiją: jos manifestas composer.json deklaruoja ją kaip AGPL-3.0, o README pateikia nuorodą į licencijos tekstą. Šiame tekste patvirtinamas neribotas leidimas paleisti nepakeistą programą. Todėl projekto paskelbtą atvaizdą galite naudoti savo įmonei ir komandai, nieko nepirkdami dėl licencijos.

13 straipsnis prideda AGPL būdingą sąlygą: jei programą keičiate, jūsų versija visiems ja nuotoliniu būdu, per tinklą, besinaudojantiems turi suteikti galimybę nemokamai gauti jos šaltinio kodą. Trečiosios šalies plėtiniui, įdėtam į tomą extensions, taikoma jo paties licencija.

Diegimas su Docker Compose

Projektas savo oficialius atvaizdus skelbia Docker Hub kaip freshrss/freshrss, kartu su Compose failo pavyzdžiu. Serveryje, kuriame įdiegtas Docker, sukurkite katalogą freshrss ir įdėkite į jį šį compose.yaml, paimtą iš to failo ir Docker README:

volumes:
  data:
  extensions:

services:
  freshrss:
    image: freshrss/freshrss:latest
    container_name: freshrss
    hostname: freshrss
    restart: unless-stopped
    logging:
      options:
        max-size: 10m
    volumes:
      - data:/var/www/FreshRSS/data
      - extensions:/var/www/FreshRSS/extensions
    ports:
      - 127.0.0.1:8080:80
    environment:
      TZ: UTC
      CRON_MIN: '3,33'
      TRUSTED_PROXY: 172.16.0.1/12 192.168.0.1/16
    healthcheck:
      test: ["CMD", "cli/health.php"]
      timeout: 10s
      start_period: 60s
      start_interval: 11s
      interval: 75s
      retries: 3

docker compose up -d

• Prievadas, paskelbtas adresu 127.0.0.1: FreshRSS pasiekiama tik per atvirkštinį tarpinį serverį, įdiegtą tame pačiame serveryje. Projekto pavyzdiniame faile 8080 prievadas paskelbiamas vietiniam naudojimui; čia adresas 127.0.0.1 jį palieka tarpiniam serveriui.
• Tomas data laiko konfigūraciją, paskyras ir, su SQLite, kiekvieno naudotojo duomenų bazę. README pabrėžia, kad jame yra visi asmeniniai duomenys. Docker Compose jį pavadina pagal katalogą: freshrss_data.
• Tomas extensions laiko trečiųjų šalių plėtinius, jei jų pridedate.
• TZ nurodo serverio laiko juostą PHP formatu; numatytoji reikšmė UTC.
• TRUSTED_PROXY išlaiko pavyzdinio failo reikšmę: privačius adresų diapazonus, iš kurių ateina tarpinio serverio užklausos. Nuo jos priklauso, kuris adresas patenka į žurnalus, lankytojo ar tarpinio serverio.
• Būklės patikra reguliariais intervalais paleidžia cli/health.php, kad Docker žinotų, ar egzempliorius atsako.

Numatytoji žyma latest seka naujausią numeruotą versiją; edge seka nuolat atnaujinamą versiją; žyma, pavyzdžiui, 1.30.4, užfiksuoja versiją, o priesaga -alpine pateikia tą patį Alpine, o ne Debian pagrindu. Prie šio pasirinkimo grįžtama atnaujinimų skyriuje.

Diegimo užbaigimas

Įdiegę atvirkštinį tarpinį serverį, atverkite savo HTTPS adresą: diegimo vedlys paklausia kalbos, patikrina serverį, pasiūlo pasirinkti duomenų bazę, tada sukuria administratoriaus paskyrą su jos slaptažodžiu ir prisijungimo būdu. SQLite veikia nieko neparuošus. Įdiegti galima ir iš komandinės eilutės su cli/do-install.php ir cli/create-user.php, paleidžiamais per docker exec --user www-data freshrss.

Dėl išteklių README nurodo lengvą serverį su Linux ar Windows ir pažymi, kad FreshRSS veikia net Raspberry Pi 1, atsakydama greičiau nei per sekundę, turint 150 srautų ir 22 000 straipsnių. Dydis priklauso nuo naudotojų, srautų ir saugomų straipsnių skaičiaus. Naudojant Managed VPS, papasakokite mums, kaip ketinate naudotis, ir mes rekomenduosime tinkamą dydį.

HTTPS: atvirkštinis tarpinis serveris

Gamybinei aplinkai Docker README pataria naudoti atvirkštinį tarpinį serverį pagrindiniame serveryje, kuris užtikrina HTTPS. Pirmiausia pasirinkite domeno vardą ar subdomeną, pavyzdžiui, rss.example.com, nukreiptą į serverį A ir AAAA įrašais. Projektas rekomenduoja Traefik ir jam skelbia visą Compose failą su Let’s Encrypt sertifikatais ir peradresavimu iš HTTP į HTTPS; jis taip pat pateikia pavyzdžių Apache, Nginx ir Caddy.

Su Caddy

Caddy pati gauna sertifikatą ir įjungia HTTPS. Šis blokas seka dokumentacijos pavyzdį subdomenui, čia nukreiptą į vietiniu adresu paskelbtą prievadą:

rss.example.com {
  reverse_proxy 127.0.0.1:8080
}

Su Nginx ir Certbot

Šis blokas perima Docker README Nginx pavyzdį domeno šakniai, sutrumpintą iki 80 prievado, kad HTTPS įdiegtų Certbot. Paskutinės dvi eilutės perduoda antraštę Authorization, kurios reikia Google Reader API:

upstream freshrss {
  server 127.0.0.1:8080;
  keepalive 64;
}

server {
  listen 80;
  listen [::]:80;
  server_name rss.example.com;

  location / {
    proxy_pass http://freshrss/;
    proxy_redirect off;
    proxy_buffering off;
    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;
    proxy_set_header X-Forwarded-Port $server_port;
    proxy_read_timeout 90;

    proxy_set_header Authorization $http_authorization;
    proxy_pass_header Authorization;
  }
}

Tada Certbot įdiegia sertifikatą ir pasirūpina jo atnaujinimu:

sudo certbot --nginx

Viešas adresas: base_url

FreshRSS savo viešą adresą laiko parametre base_url, faile data/config.php. Juo remiasi API ir WebSub: patikrinkite, ar jame yra jūsų https adresas. Docker README parodo, kur šį failą rasti tome:

docker volume inspect freshrss_data
sudo nano /var/lib/docker/volumes/freshrss_data/_data/config.php
docker compose restart freshrss

'base_url' => 'https://rss.example.com/',

Srautų atnaujinimas: CRON_MIN

FreshRSS naujus straipsnius gauna savo scenarijumi app/actualize_script.php. Docker atvaizde yra suplanuota užduotis, kuri jį paleidžia kintamajame CRON_MIN nurodytomis minutėmis. Be šio kintamojo arba su tuščia reikšme užduotis lieka išjungta, ir srautai patys nebeatsinaujina.

• Tempas: projektas rekomenduoja maždaug du paleidimus per valandą, pavyzdžiui, 13,43; tinka ir */20.
• Riba: scenarijus to paties srauto neatnaujina dažniau nei kas dvidešimt minučių, todėl tankesnis grafikas nieko neduoda.
• Realusis laikas: suderinamiems šaltiniams darbą perima WebSub. Jam reikia viešo adreso, nuskaitomo iš base_url, o diegimo vedlys jį įjungia, kai serveris tokį turi.

Kitas dokumentuotas būdas: suplanuota užduotis pagrindiniame serveryje, kuri iškviečia scenarijų konteinerio viduje. Tokiu atveju pašalinkite CRON_MIN iš compose.yaml, kad liktų vienas būdas:

7,37 * * * * root docker exec --user www-data freshrss php ./app/actualize_script.php > /tmp/FreshRSS.log 2>&1

Nuo 1.30.0 versijos FreshRSS numatytai atmeta vietinio tinklo adresus, tokius kaip 127.0.0.1, kad apsisaugotų nuo serverio pusės užklausų klastojimo. Gretimai paslaugai, kuri kuria srautus, pavyzdžiui, RSS-Bridge, leidžiama per kintamąjį INTERNAL_HOST_ALLOWLIST, forma rss-bridge:80, arba sistemos konfigūracijoje. Reikšmė * panaikina visas patikras, o dokumentacija ją vadina nesaugia.

Paskyros ir prisijungimas

Diegimo metu FreshRSS pasiūlo prisijungimą per formą, kuriam reikia JavaScript. Tai numatytasis būdas, tinkantis daugumai egzempliorių. Dokumentacija aprašo ir kitus:

Dokumentacija įspėja, kad FreshRSS pasitiki bet kuriuo adresu, nurodytu TRUSTED_PROXY: prastai apsaugotas tarpinis serveris leistų užpuolikui nustatyti antraštę ir gauti administratoriaus prieigą. Čia prievadas klausosi tik adresu 127.0.0.1, todėl jis paliekamas paties serverio tarpiniam serveriui. Dokumentacija taip pat nepataria naudoti egzemplioriaus be autentifikavimo, kai tik serverį galima pasiekti iš už jūsų tinklo ribų.

Registracijos ir naudotojai

• Numatytai uždarytos: konfigūracija paskyrų skaičių nustato į 1, administratoriaus paskyrą. Registracijos forma atsiranda tik padidinus šį skaičių skiltyje Administration, System configuration; 0 panaikina bet kokią ribą.
• Administratoriaus kuriamos paskyros: Administration, Manage users, nurodant kalbą, naudotojo vardą, slaptažodį ir tai, ar paskyra yra administratoriaus.
• Pakartotinis autentifikavimas reikalaujamas prieš jautrius veiksmus, pavyzdžiui, naudotojo paaukštinimą ar atnaujinimo pritaikymą, numatytai po 20 minučių.
• El. pašto adreso patvirtinimas nėra privalomas. Jam reikia SMTP serverio, nustatomo parametrais mailer ir smtp faile data/config.php: dokumentacija nurodo, kad siuntimas per PHP funkciją mail oficialiuose Docker atvaizduose dar nepalaikomas.

Egzemplioriui, kuriuo naudojasi keli žmonės, dokumentacija pataria paskyras atverti žmonėms, kuriais pasitikite, ir laikyti egzempliorių už tarpinio serverio ar ugniasienės, blokuojančios prieigą prie vidinių adresų diapazonų.

Mobiliosios programėlės: Google Reader ir Fever API

FreshRSS veikia naršyklėje, tiek dideliuose, tiek mažuose ekranuose, ir programėlėse Android, iOS, Linux, Windows ir macOS sistemoms. Šios programėlės naudoja vieną iš dviejų jos API: Google Reader, kurią README vertina kaip geriausią, ir Fever, su ribotesnėmis funkcijomis, mažiau efektyvią ir mažiau saugią.

1. Kaip administratorius, skiltyje Authentication įjunkite parinktį, leidžiančią prieigą prie API.
2. Kiekvienas naudotojas savo profilyje nustato API slaptažodį. Jis atskiras nuo pagrindinio slaptažodžio, suteikia prieigą prie mažesnės dalies ir skirtas mažiau saugioms situacijoms.
3. Programėlėje įveskite adresą https://rss.example.com/api/greader.php arba https://rss.example.com/api/fever.php Fever atveju, su naudotojo vardu ir šiuo API slaptažodžiu.

Patikrai profilyje šalia API slaptažodžio rodoma nuoroda atveria bandymo puslapį: PASS visoje patikroje patvirtina, kad viskas veikia. Docker atvaizdas Apache jau nustato priimti užkoduotus pasviruosius brūkšnius, kurių reikia kai kurioms programėlėms; su Nginx priekyje palikite antraštės Authorization perdavimą.

README pateikia suderinamų programėlių lentelę su jų platforma, API ir funkcijomis: tarp kitų, Capy Reader ir Readrops Android sistemai, FeedFlow mobiliesiems ir darbalaukiui, RSS Guard ir NewsFlash darbalaukiui, ReadKit ir Reeder Classic iOS ir macOS sistemoms.

SQLite, PostgreSQL, MySQL ar MariaDB

FreshRSS turi integruotą SQLite, kurią Docker README apibūdina kaip paprasčiausią galimybę su geru našumu. Reikalavimų puslapis rekomenduoja PostgreSQL 10 ar naujesnę, taip pat priima MariaDB 10.6 ir MySQL 8.0 ar naujesnes. Pasirenkama diegimo vedlyje.

PostgreSQL atveju pridėkite šią paslaugą prie compose.yaml, paimtą iš projekto failo docker-compose-db.yml, o tomą db įtraukite į tomų sąrašą. Slaptažodis dedamas į failą .env, šalia compose.yaml:

  freshrss-db:
    image: postgres:18
    container_name: freshrss-db
    hostname: freshrss-db
    restart: unless-stopped
    logging:
      options:
        max-size: 10m
    volumes:
      - db:/var/lib/postgresql
    environment:
      POSTGRES_DB: freshrss
      POSTGRES_USER: freshrss
      POSTGRES_PASSWORD: ${DB_PASSWORD}

DB_PASSWORD='a-long-unique-password'

Vedlyje pasirinkite PostgreSQL ir kaip pagrindinį kompiuterį įveskite freshrss-db, su naudotoju, slaptažodžiu ir duomenų baze freshrss.

Prie šio pasirinkimo galite grįžti vėliau. Dokumentacija aprašo perėjimą iš vienos duomenų bazės į kitą, pavyzdžiui, iš MySQL į PostgreSQL, arba į naujesnę pagrindinę PostgreSQL versiją: cli/db-backup.php nukopijuoja kiekvieno naudotojo duomenų bazę į SQLite failą, tada cli/db-restore.php ją įkelia į naują duomenų bazę.

Atsarginės kopijos

README nurodo, kad FreshRSS teikiama be jokios garantijos: jūsų atsarginės kopijos išsaugo jūsų prenumeratas, straipsnius ir nustatymus. Štai ką dokumentacija prašo kopijuoti:

Tomai, sustabdžius paslaugą

Dokumentacija mano, kad techninės priežiūros metu saugiau paslaugą sustabdyti. Docker tomai kopijuojami laikinu konteineriu, Docker dokumentacijoje aprašytu būdu:

docker compose stop freshrss
docker run --rm --volumes-from freshrss -v "$PWD":/backup ubuntu tar -czf /backup/freshrss-$(date +%F).tgz --exclude=data/cache -C /var/www/FreshRSS data extensions
docker compose start freshrss

Duomenų bazės, paslaugai veikiant

Nuo 1.29.1 versijos FreshRSS pati sugeba eksportuoti kiekvieno naudotojo duomenų bazę į SQLite failą, nesvarbu, kokią duomenų bazę naudojate, ir išlaikyti tik naujausius. Įjunkite šį eksportą faile data/config.php:

'auto_sqlite_export' => [
    'enabled' => true,
    'retention' => 7,
],

Tada suplanuokite komandą serveryje, čia kiekvieną naktį. Kiekvienas paleidimas įrašo data/users/<user>/sqlite-backups/<date>.sqlite ir ištrina failus, viršijančius paskutinius septynis:

20 2 * * * root docker exec --user www-data freshrss cli/export-sqlite-auto.php --quiet

Su PostgreSQL pridėkite eksportą pačios duomenų bazės įrankiu, kaip Docker README. Parinktis -T atsisako terminalo, kurio suplanuotai užduočiai nereikia:

docker compose exec -T freshrss-db pg_dump -U freshrss freshrss | gzip -9 > freshrss-postgres-$(date +%F).sql.gz

OPML eksportas iš sąsajos išsaugo jūsų srautų sąrašą, be kai kurių FreshRSS būdingų nustatymų, tokių kaip prieigos duomenys ar puslapių nuskaitymo taisyklės. Visai kopijai laikykite SQLite eksportus: padėti serverio diske, jie patenka ir į jo naktines atsargines kopijas.

Atkūrimas

1. Sustabdykite FreshRSS su docker compose stop freshrss.
2. Įkelkite archyvą atgal į tomus: docker run --rm --volumes-from freshrss -v "$PWD":/backup ubuntu tar -xzf /backup/freshrss-YYYY-MM-DD.tgz -C /var/www/FreshRSS.
3. Su išorine duomenų baze atkurkite ją iš jos eksporto arba iš SQLite failų su cli/db-restore.php --delete-backup --force-overwrite.
4. Vėl paleiskite su docker compose start freshrss, tada patikrinkite, ar jūsų srautai ir straipsniai vietoje.

Retkarčiais pakartokite šį pratimą su kopija: taip įsitikinate, kad atsarginė kopija veikia.

Atnaujinimai

Docker README pateikia dvi komandas, vykdomas kataloge su compose.yaml. Tomai lieka vietoje:

docker compose pull
docker compose up -d

FreshRSS versijas skelbia dviem kanalais. Numeruotos versijos, žyma latest, pasirodo kelis kartus per metus, be nustatyto tvarkaraščio, o jų pataisos neperkeliamos į senesnes versijas. Nuolat atnaujinama versija, žyma edge, naujas funkcijas ir pataisas gauna vos jas įtraukus: nuo 1.30.0 versijos projektas ją rekomenduoja dėl greitesnių saugumo pataisų.

• Pirmiausia atsarginė kopija: dokumentacija prieš kiekvieną atnaujinimą prašo sukurti data/, plėtinių ir duomenų bazės atsarginę kopiją.
• Versija po versijos: jei atsilikote keliomis versijomis, pereikite kiekvieną iš jų, pavyzdžiui, iš 1.26.0 į 1.27.1, prieš 1.28.1, tikrindami kiekviename žingsnyje. Su Docker tokį kelią leidžia žymos, pavyzdžiui, 1.29.1.
• Naujausios versijos: 2026 m. spalio 21 d. 1.30.4 yra ketvirtoji saugumo versija 1.30 serijoje. Ji pataiso PHP pažeidžiamumus Alpine atvaizduose, po 1.30.3, kuri numatytąjį Debian atvaizdą perkėlė į Debian 13.

Kad sektumėte naujas versijas, projektas skelbia savo versijų Atom srautą: užsiprenumeruokite jį savo FreshRSS egzemplioriuje.

Kas ką daro Managed VPS serveryje

Talpinant savo serveryje, be programos reikia prižiūrėti ir patį serverį. Naudojant Managed VPS, mūsų komandos perima serverį ir proaktyviai stebi jūsų egzempliorių; FreshRSS lieka jūsų programa su savo nustatymais ir duomenimis.

Jei norite, kad mūsų komandos įsikištų į pačią programą, ši paslauga apmokestinama valandomis arba fiksuota kaina, o skaičiavimas pateikiamas prieš įsikišimą.