Self-host TelegramRSS

TelegramRSS README

How to install TelegramRSS

SERVER_ADDRESS, SERVER_PORT, REAL_IP_HEADER, TELEGRAM_CLIENT_ADDRESS, TELEGRAM_CLIENT_PORT, TELEGRAM_CLIENT_USERNAME, TELEGRAM_CLIENT_PASSWORD, SELF_URL, TIMEZONE, MEMORY_LIMIT, RPM, MEDIA_RPM, ERRORS_LIMIT, MEDIA_ERRORS_LIMIT, CLIENTS_SETTINGS, ONLY_PUBLIC_CHANNELS, FORBIDDEN_PEER_REGEX, CACHE_PEER_ERRORS_REGEX, FORBIDDEN_REFERERS_REGEX, IP_BLACKLIST, CACHE_ENABLED, CACHE_MAX_ENTRIES, CACHE_HISTORY_WINDOW_SIZE, CACHE_TTL_SECONDS, CACHE_STALE_TTL_SECONDS, LOGS_LEVEL

How to configure TelegramRSS

• CACHE_ENABLED=1Shared RSS/JSON and media-message cache (memory only). Set to 0 to disable caching. FLOOD_WAIT cooldowns remain active.

  Shared RSS/JSON and media-message cache (memory only). Set to 0 to disable caching. FLOOD_WAIT cooldowns remain active.

• CACHE_HISTORY_WINDOW_SIZE=100Shared latest-history window, in messages (1-100). Older/anchored ranges bypass caching.

  Shared latest-history window, in messages (1-100). Older/anchored ranges bypass caching.

• CACHE_MAX_ENTRIES=2000Maximum cached records; least recently used records are evicted.

  Maximum cached records; least recently used records are evicted.

• CACHE_PEER_ERRORS_REGEX=CHANNEL_PRIVATE|USERNAME_INVALID|This is not a public channel|This peer is not present in the internal peer databaseIf peer resolutions fails with following errors - cache it and dont check this peer again. Leave blanc to disable cache

  If peer resolutions fails with following errors - cache it and dont check this peer again. Leave blanc to disable cache

• CACHE_STALE_TTL_SECONDS=900Maximum age of RSS/JSON and indexed-message fallback on FLOOD_WAIT; 0 disables fallback.

  Maximum age of RSS/JSON and indexed-message fallback on FLOOD_WAIT; 0 disables fallback.

• CACHE_TTL_SECONDS=60Freshness of history, messages, metadata and complete feeds; 0 disables fresh reuse.

  Freshness of history, messages, metadata and complete feeds; 0 disables fresh reuse.

• CLIENTS_SETTINGSJson list of IP addresses and Basic Auth usernames with custom RPM and errors limits. Its a WHITELIST and a BLACKLIST at same time. Override rpm, media_rpm, errors_limit and media_errors_limit per client. Basic Auth usernames require a "password" value and use the same limits format. Example: { \"127.0.0.1\": {\"rpm\":-1, \"errors_limit\":-1}, \"1.1.1.1\": {\"rpm\":0, \"media_rpm\":1, \"errors_lim

  Json list of IP addresses and Basic Auth usernames with custom RPM and errors limits. Its a WHITELIST and a BLACKLIST at same time. Override rpm, media_rpm, errors_limit and media_errors_limit per client. Basic Auth usernames require a "password" value and use the same limits format. Example: { \"127.0.0.1\": {\"rpm\":-1, \"errors_limit\":-1}, \"1.1.1.1\": {\"rpm\":0, \"media_rpm\":1, \"errors_lim

• ERRORS_LIMIT=0;Allowed number of errors per minute Examples: -1 - allow any number of errors 0 - ban after first error 2 - allow 2 errors per minute: ban on 3rd error.

  Allowed number of errors per minute Examples: -1 - allow any number of errors 0 - ban after first error 2 - allow 2 errors per minute: ban on 3rd error.

• FORBIDDEN_PEER_REGEXRegex to disable some channels/users. Example: "(username1|username2|user.*name)" Leave blanc to disable

  Regex to disable some channels/users. Example: "(username1|username2|user.*name)" Leave blanc to disable

• FORBIDDEN_REFERERS_REGEXForbid to view images from webpages

  Forbid to view images from webpages

• IP_BLACKLIST=ip_blacklist.csv
• LOGS_LEVEL=2LOGS LogLevel::DEBUG => 0, LogLevel::INFO => 1, LogLevel::NOTICE => 2, LogLevel::WARNING => 3, LogLevel::ERROR => 4, LogLevel::CRITICAL => 5, LogLevel::ALERT => 6, LogLevel::EMERGENCY => 7,

  LOGS LogLevel::DEBUG => 0, LogLevel::INFO => 1, LogLevel::NOTICE => 2, LogLevel::WARNING => 3, LogLevel::ERROR => 4, LogLevel::CRITICAL => 5, LogLevel::ALERT => 6, LogLevel::EMERGENCY => 7,

• MEDIA_ERRORS_LIMIT=2;
• MEDIA_RPM=50
• MEMORY_LIMIT=128M
• ONLY_PUBLIC_CHANNELS=1Set to 0 if you need to output any channels, chats, etc. Warnign! All client chats will be vissible to users. Make sure to protect this server from internet requests, if you disable this option.

  Set to 0 if you need to output any channels, chats, etc. Warnign! All client chats will be vissible to users. Make sure to protect this server from internet requests, if you disable this option.

• REAL_IP_HEADERIf you use nginx, then provide here name of client header. for example x-real-ip or x-forwarded-for

  If you use nginx, then provide here name of client header. for example x-real-ip or x-forwarded-for

• RPMSymfony sliding window per IP or authenticated username, over 60 seconds. Feed and media quotas are separate. Changes take effect after restart. -1 disables the quota, 0 denies access, a positive value limits requests/minute.

  Symfony sliding window per IP or authenticated username, over 60 seconds. Feed and media quotas are separate. Changes take effect after restart. -1 disables the quota, 0 denies access, a positive value limits requests/minute.

• SELF_URL=http://127.0.0.1:9504
• SERVER_ADDRESS=0.0.0.0HTTP SERVER

  HTTP SERVER

• SERVER_PORT=9504
• TELEGRAM_CLIENT_ADDRESS=api
• TELEGRAM_CLIENT_PASSWORD
• TELEGRAM_CLIENT_PORT=9503
• TELEGRAM_CLIENT_USERNAME
• TIMEZONE=UTCSYSTEM

  SYSTEM