Skip to content

settings.md

Latest commit

 

History

History
131 lines (99 loc) · 3.01 KB

settings.md

File metadata and controls

131 lines (99 loc) · 3.01 KB

Telegram settings

Tip

This page contains the details about telegram settings. More general information about telegram support in matterbridge can be found in README.md.

MediaConvertTgs

Convert Tgs (Telegram animated sticker) images to some other file format before upload. See FAQ for setup instructions.

  • Setting: OPTIONAL, RELOADABLE
  • Format: string
  • Possible values:
    • "png" (still-image)
    • "webp" (animated webp)
  • Example: 
    MediaConvertTgs="png"

MediaConvertWebPToPNG

Convert WebP images to PNG before upload to the media server or other bridges (for compatibility).

  • Setting: OPTIONAL, RELOADABLE
  • Format: boolean
  • Example: 
    MediaConvertWebPToPNG=true

MessageFormat

TODO: is this only for outgoing messages?

  • Setting: OPTIONAL, RELOADABLE
  • Format: string
  • Possible values:
    • "HTML"
    • "Markdown". Deprecated, does not display links with underscores _ correctly.
    • "MarkdownV2"
    • "HTMLNick". This only allows HTML for the nick, the message itself will be html-escaped.
  • Default: ""
  • Example: 
    MessageFormat="MarkdownV2"

QuoteDisable

Disable quotes in reply messages. Disable if your destination bridges understand native replies.

  • Setting: OPTIONAL, RELOADABLE
  • Format: boolean
  • Example: 
    QuoteDisable=true

QuoteFormat

Format quoted/reply messages

  • Setting: OPTIONAL, RELOADABLE
  • Format: string
  • Default: "{MESSAGE} (re @{QUOTENICK}: {QUOTEMESSAGE})"
  • Example: 
    QuoteFormat="{@{QUOTENICK}, {MESSAGE}}"

QuoteLengthLimit

Limits {QUOTEMESSAGE} into integer characters specified in this.

TODO: does this cut graphemes or bytes?

  • Setting: OPTIONAL
  • Format: int
  • Example: 
    QuoteLengthLimit=46

DisableWebPagePreview

Disables link previews for links in messages

  • Setting: OPTIONAL, RELOADABLE
  • Format: boolean
  • Example: 
    DisableWebPagePreview=true

Token

Token to connect with telegram API.

  • Setting: REQUIRED
  • Format: string
  • Example: 
    Token="Yourtokenhere"

UseFirstName

If enabled use the "First Name" as username. If this is empty use the Username If disabled use the "Username" as username. If this is empty use the First Name If all names are empty, username will be "unknown"

  • Setting: OPTIONAL, RELOADABLE
  • Format: boolean
  • Example: 
    UseFirstName=true

UseInsecureURL

Warning

If enabled this will relay GIF/stickers/documents and other attachments as URLs Those URLs will contain your bot-token. This may not be what you want. For now there is no secure way to relay GIF/stickers/documents without seeing your token.

  • Setting: OPTIONAL, RELOADABLE
  • Format: boolean
  • Example: 
    UseInsecureURL=true