linkchanbot

[python] Telegram bot link substituter for frontends
git clone https://git.torresjrjr.com/linkchanbot.git
Log | Files | Refs | README | LICENSE

linkchanbot.1.scd (1918B)

      1 linkchanbot(1)
      2 
      3 # NAME
      4 
      5 *linkchanbot* -
      6 A Telegram Bot which sanitises and substitutes share links
      7 with lightweight, privacy respecting proxy frontend alternatives.
      8 
      9 # SYNOPSIS
     10 
     11 *linkchanbot* [-h] [-v] [-l _LOGFILE_]
     12 
     13 # DESCRIPTION
     14 
     15 *linkchanbot* is a Telegram bot utility that transforms share links from common
     16 social media services to links which point to alternative lightweight, privacy
     17 respecting frontends, like Nitter, Invidious, Bibliogram, and Teddit.
     18 *linkchanbot* can substitute links in chat, inline mode, and group chats.
     19 
     20 # USAGE
     21 
     22 \-h, --help
     23 	show help and exit
     24 
     25 \-v, --version
     26 	print version and exit
     27 
     28 \-l _LOGFILE_, --logfile _LOGFILE_
     29 	specify the log file
     30 
     31 # CONFIGURATION
     32 
     33 *linkchanbot* adheres to the XDG Base Directory System,
     34 and sources configuration files
     35 from _$XDG_CONFIG_HOME/linkchan_ (defaults to _$HOME/.config/linkchan_).
     36 *linkchanbot* will copy missing configuration files
     37 from _/etc/local/share/linkchanbot_.
     38 
     39 _bot.cfg_
     40 	Defines the *token* and *admin* variables.
     41 
     42 	*token*
     43 		Required. The Telegram bot token. Visit @botfather.
     44 	*admin*
     45 		Optional. A Telegram username
     46 		to whom the bot will provide the special
     47 		*/restart* and */shutdown* commands.
     48 
     49 _alts.json_
     50 	Defines the alternative services (proxies or otherwise)
     51 	available as a substitute.
     52 	An alt's *service* value should exist
     53 	and have a corresponding a key in _services.json_,
     54 	else it will be ignored.
     55 
     56 _services.json_
     57 	Defines common services to be recognised and replaced.
     58 	For each domain, defines the alternate domains and whitelists
     59 	of queries to be left untouched during substitution.
     60 
     61 # TELEGRAM USAGE
     62 
     63 Send */start* on Telegram. *linkchanbot* will present usage information.
     64 
     65 Additionally, if *admin* is specified in configuration, the Telegram user
     66 with the username *admin* will be provided with the following commands:
     67 
     68 */restart*
     69 	Restart the bot. Reads new configuration.
     70 
     71 */shutdown*
     72 	Shutdown the bot.
     73