diff --git a/README.md b/README.md index e69de29..1924169 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,41 @@ +# RSS Feedler + +Агрегатор RSS лент. + +- По расписанию обновляет и хранит локально список новостных лент RSS в виде XML файлов. +- Отдает список новостных лент в Web: `http://localhost:8001/` +- Отдает каждую новостную ленту в Web: `http://localhost:8001/feeds/bvn13_blog.xml` + +## Настройка + +```json +[ + { + "src": "https://rsshub.app/telegram/channel/bvn13_blog", + "rss": "tg_bvn13_blog.xml", + "name": "bvn13 blog (text)" + }, + { + "src": "https://blog.bvn13.me/feeds/all.atom.xml", + "rss": "bvn13_blog.xml", + "name": "TG: bvn13's blog" + } +] +``` + +## Запуск + +``` +#!/bin/bash + +CONFIG_FILE=/path/to/settings.json DIRECTORY=/path/to/feeds/ docker compose down +CONFIG_FILE=/path/to/settings.json DIRECTORY=/path/to/feeds/ docker compose up -d --build --no-deps +``` + +## Интервал обновления + +Указывается в минутах при запуске контейнера + +``` +CHECK_INTERVAL=15 +``` \ No newline at end of file