There are hundreds and hundreds of news collected every week for the FOSS News digest.
FOSS News Telegram Bot sends you those news one by one to filter and categorize.
Take part in making the next digest on the go! 😃
docker-compose up -d fossnewsbot-dev
docker-compose up -d fossnewsbot
FOSS News Bot uses Dynaconf to handle configuration files and environment variables.
Key | Description | Secret? | Type | Default value |
---|---|---|---|---|
bot.token |
Authentication token for Telegram Bot API | Yes | str |
|
bot.host |
Name of host where bot is deployed | No | str |
"127.0.0.1" |
bot.port |
Port number bot is listening to | No | int |
2048 |
webhook.base |
Webhook base URL | No | str |
"https://fn.permlug.org" |
webhook.path |
Webhook path | No | str |
"/bot/" |
fngs.endpoint |
FOSS News Gathering Server API endpoint | No | str |
"https://fn.permlug.org/api/v1/" |
fngs.username |
Username for FOSS News Gathering Server API | Yes | str |
|
fngs.password |
Password for FOSS News Gathering Server API | Yes | str |
|
fngs.timeout |
Timeout for FNGS API requests (in seconds) | No | int |
5 |
fngs.retries |
Number of retries for FNGS API requests | No | int |
3 |
cache.token.ttl |
FNGS token time to live (in days; 0 — no TTL) |
No | int |
29 |
cache.attrs.ttl |
Attributes time to live (in days; 0 — no TTL) |
No | int |
1 |
cache.users.ttl |
FNGS users time to live (in days; 0 — no TTL) |
No | int |
1 |
cache.users.size |
FNGS users cache size — number of cached users | No | int |
256 |
url.channel |
URL of PermLUG channel in Telegram | No | str |
"https://t.me/permlug" |
url.chat |
URL of PermLUG chat in Telegram | No | str |
"https://t.me/permlug_chat" |
log.level |
Logging level | No | str |
"info" |
localedir |
Directory with locales (translations) | No | str |
"locales" |
marker.count |
Emoji marker for news count | No | str |
"📊" |
marker.date |
Emoji marker for news date and time | No | str |
"🗓" |
marker.lang |
Emoji marker for news language | No | str |
"🌏" |
marker.keywords.foss |
Emoji marker for FOSS keywords | No | str |
"🟢" |
marker.keywords.proprietary |
Emoji marker for proprietary keywords | No | str |
"🟡" |
marker.content_type |
Emoji marker for content type | No | str |
"🔖" |
marker.content_category |
Emoji marker for content category | No | str |
"🗂" |
marker.include |
Emoji marker for news included in digest | No | str |
"✅" |
marker.exclude |
Emoji marker for news excluded from digest | No | str |
"⛔️" |
marker.unknown |
Emoji marker for skipped news | No | str |
"🤷🏻♂️" |
marker.main |
Emoji marker for main news | No | str |
"❗️" |
marker.short |
Emoji marker for short (title only) news | No | str |
"📃" |
marker.error |
Emoji marker for error message | No | str |
"🤔" |
keyboard.columns |
Number of columns in inline keyboard | No | int |
3 |
Parameters with no default value must be set explicitly.
Sensitive data for bot (tokens, passwords etc.) must be stored in configuration file .secrets.yml
(see Secrets).
This file is excluded from Git (see .gitignore
).
A value <dict>.dynaconf_merge = true
must be defined for every dict in every environment (see Merging).
See secrets file template in .secrets.yml.dist
.
Put the following location block in a server block somewhere in /etc/nginx/conf.d/*.conf
or /etc/nginx/sites-enabled/*
:
server {
…
location = /bot/ {
proxy_pass https://localhost:2048;
}
…
}
These settings must match webhook.base
and webhook.path
configuration parameters.
- Advanced usage of Python requests - timeouts, retries, hooks by Dani Hodovic (2020-02-28)
- jlhutch/pylru — GitHub — A least recently used (LRU) cache for Python