YunoHost-Apps/matterbridge_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/matterbridge_ynh.git synced 2024-09-03 19:36:24 +02:00
Code Issues Activity Actions

Fix

Browse source
This commit is contained in:
ericgaspar 2021-01-26 12:15:23 +01:00
parent 471f45f149
commit e4b0350058
No known key found for this signature in database
GPG key ID: 574F281483054D44
2 changed files with 499 additions and 240 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

479
conf/matterbridge.toml
View file

@ -103,6 +103,16 @@ ColorNicks=false
#OPTIONAL (default empty) #OPTIONAL (default empty)
RunCommands=["PRIVMSG user hello","PRIVMSG chanserv something"] RunCommands=["PRIVMSG user hello","PRIVMSG chanserv something"]
#PingDelay specifies how long to wait to send a ping to the irc server.
#You can use s for second, m for minute
#String
#OPTIONAL (default 1m)
PingDelay="1m"
#StripMarkdown strips markdown from messages
#OPTIONAL (default false)
StripMarkdown=false
#Nicks you want to ignore. #Nicks you want to ignore.
#Regular expressions supported #Regular expressions supported
#Messages from those users will not be sent to other bridges. #Messages from those users will not be sent to other bridges.
@ -177,6 +187,25 @@ StripNick=false
#OPTIONAL (default false) #OPTIONAL (default false)
ShowTopicChange=false ShowTopicChange=false
#Delay in milliseconds between channel joins
#Only useful when you have a LOT of channels to join
#See https://github.com/42wim/matterbridge/issues/1084
#OPTIONAL (default 0)
JoinDelay=0
#Use the optional RELAYMSG extension for username spoofing on IRC.
#This requires an IRCd that supports the draft/relaymsg specification: currently this includes
#Oragono 2.4.0+ and InspIRCd 3 with the m_relaymsg contrib module.
#See https://github.com/42wim/matterbridge/issues/667#issuecomment-634214165 for more details.
#Spoofed nicks will use the configured RemoteNickFormat, replacing reserved IRC characters
#(!+%@&#$:'"?*,.) with a hyphen (-).
#On most configurations, the RemoteNickFormat must include a separator character such as "/".
#You should make sure that the settings here match your IRCd.
#This option overrides ColorNicks.
#OPTIONAL (default false)
UseRelayMsg=false
#RemoteNickFormat="{NICK}/{PROTOCOL}"
################################################################### ###################################################################
#XMPP section #XMPP section
################################################################### ###################################################################
@ -211,6 +240,10 @@ Nick="xmppbot"
#OPTIONAL (default false) #OPTIONAL (default false)
SkipTLSVerify=true SkipTLSVerify=true
#Enable to use plaintext connection to your XMPP server.
#OPTIONAL (default false)
NoTLS=true
## RELOADABLE SETTINGS ## RELOADABLE SETTINGS
## Settings below can be reloaded by editing the file ## Settings below can be reloaded by editing the file
@ -277,6 +310,11 @@ StripNick=false
#OPTIONAL (default false) #OPTIONAL (default false)
ShowTopicChange=false ShowTopicChange=false
#Enable sending messages using a webhook instead of regular MUC messages.
#Only works with a prosody server using mod_slack_webhook. Does not support editing.
#OPTIONAL (default "")
WebhookURL="https://yourdomain/prosody/msg/someid"
################################################################### ###################################################################
#mattermost section #mattermost section
################################################################### ###################################################################
@ -545,6 +583,96 @@ Label=""
# REQUIRED # REQUIRED
Team="myteam" Team="myteam"
###################################################################
# Microsoft teams section
# See https://github.com/42wim/matterbridge/wiki/MS-Teams-setup
###################################################################
[msteams.myteam]
# TenantID
# See https://github.com/42wim/matterbridge/wiki/MS-Teams-setup#get-necessary-ids-for-matterbridge
TenantID="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
# ClientID
# See https://github.com/42wim/matterbridge/wiki/MS-Teams-setup#get-necessary-ids-for-matterbridge
ClientID="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
# TeamID
# See https://github.com/42wim/matterbridge/wiki/MS-Teams-setup#get-necessary-ids-for-matterbridge
TeamID="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
## RELOADABLE SETTINGS
## Settings below can be reloaded by editing the file
#Nicks you want to ignore.
#Regular expressions supported
#Messages from those users will not be sent to other bridges.
#OPTIONAL
IgnoreNicks="ircspammer1 ircspammer2"
#Messages you want to ignore.
#Messages matching these regexp will be ignored and not sent to other bridges
#See https://regex-golang.appspot.com/assets/html/index.html for more regex info
#OPTIONAL (example below ignores messages starting with ~~ or messages containing badword
IgnoreMessages="^~~ badword"
#messages you want to replace.
#it replaces outgoing messages from the bridge.
#so you need to place it by the sending bridge definition.
#regular expressions supported
#some examples:
#this replaces cat => dog and sleep => awake
#replacemessages=[ ["cat","dog"], ["sleep","awake"] ]
#this replaces every number with number. 123 => numbernumbernumber
#replacemessages=[ ["[0-9]","number"] ]
#optional (default empty)
ReplaceMessages=[ ["cat","dog"] ]
#nicks you want to replace.
#see replacemessages for syntaxa
#optional (default empty)
ReplaceNicks=[ ["user--","user"] ]
#Extractnicks is used to for example rewrite messages from other relaybots
#See https://github.com/42wim/matterbridge/issues/713 and https://github.com/42wim/matterbridge/issues/466
#some examples:
#this replaces a message like "Relaybot: <relayeduser> something interesting" to "relayeduser: something interesting"
#ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ] ]
#you can use multiple entries for multiplebots
#this also replaces a message like "otherbot: (relayeduser) something else" to "relayeduser: something else"
#ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ],[ "otherbot","\\((.*?)\\)\\s+" ]
#OPTIONAL (default empty)
ExtractNicks=[ ["otherbot","<(.*?)>\\s+" ] ]
#extra label that can be used in the RemoteNickFormat
#optional (default empty)
Label=""
#RemoteNickFormat defines how remote users appear on this bridge
#See [general] config section for default options
RemoteNickFormat="[{PROTOCOL}] <{NICK}> "
#Enable to show users joins/parts from other bridges
#Currently works for messages from the following bridges: irc, mattermost, slack, discord
#OPTIONAL (default false)
ShowJoinPart=false
#StripNick only allows alphanumerical nicks. See https://github.com/42wim/matterbridge/issues/285
#It will strip other characters from the nick
#OPTIONAL (default false)
StripNick=false
#Enable to show topic changes from other bridges
#Only works hiding/show topic changes from slack bridge for now
#OPTIONAL (default false)
ShowTopicChange=false
#Opportunistically preserve threaded replies between bridges
#that support threading
#OPTIONAL (default false)
PreserveThreading=false
################################################################### ###################################################################
#slack section #slack section
################################################################### ###################################################################
@ -703,114 +831,126 @@ ShowUserTyping=false
################################################################### ###################################################################
[discord] [discord]
#You can configure multiple servers "[discord.name]" or "[discord.name2]" # You can configure multiple servers "[discord.name]" or "[discord.name2]"
#In this example we use [discord.game] # In this example we use [discord.game]
#REQUIRED #REQUIRED
[discord.game] [discord.game]
#Token to connect with Discord API # Token (REQUIRED) is the token to connect with Discord API
#You can get your token by following the instructions on # You can get your token by following the instructions on
#https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token # https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token
#If you want roles/groups mentions to be shown with names instead of ID, you'll need to give your bot the "Manage Roles" permission. # If you want roles/groups mentions to be shown with names instead of ID, you'll need to give your bot the "Manage Roles" permission.
#REQUIRED
Token="Yourtokenhere" Token="Yourtokenhere"
#REQUIRED # Server (REQUIRED) is the ID or name of the guild to connect to, selected from the guilds the bot has been invited to
Server="yourservername" Server="yourservername"
## RELOADABLE SETTINGS ## RELOADABLE SETTINGS
## Settings below can be reloaded by editing the file ## All settings below can be reloaded by editing the file.
## They are also all optional.
#Shows title, description and URL of embedded messages (sent by other bots) # ShowEmbeds shows the title, description and URL of embedded messages (sent by other bots)
#OPTIONAL (default false)
ShowEmbeds=false ShowEmbeds=false
#Shows the username instead of the server nickname # UseLocalAvatar specifies source bridges for which an avatar should be 'guessed' when an incoming message has no avatar.
#OPTIONAL (default false) # This works by comparing the username of the message to an existing Discord user, and using the avatar of the Discord user.
#
# This only works if WebhookURL is set (AND the message has no avatar).
# Example: ["irc"]
UseLocalAvatar=[]
# UseUserName shows the username instead of the server nickname
UseUserName=false UseUserName=false
#Show #xxxx discriminator with UseUserName # UseDiscriminator appends the `#xxxx` discriminator when used with UseUserName
#OPTIONAL (default false)
UseDiscriminator=false UseDiscriminator=false
#Specify WebhookURL. If given, will relay messages using the Webhook, which gives a better look to messages. # AutoWebhooks automatically configures message sending in the style of puppets.
#This only works if you have one discord channel, if you have multiple discord channels you'll have to specify it in the gateway config # This is an easier alternative to manually configuring "WebhookURL" for each gateway,
#OPTIONAL (default empty) # as turning this on will automatically load or create webhooks for each channel.
WebhookURL="Yourwebhooktokenhere" # This feature requires the "Manage Webhooks" permission (either globally or as per-channel).
AutoWebhooks=false
#Disable sending of edits to other bridges # EditDisable disables sending of edits to other bridges
#OPTIONAL (default false)
EditDisable=false EditDisable=false
#Message to be appended to every edited message # EditSuffix specifies the message to be appended to every edited message
#OPTIONAL (default empty) # Example: " (edited)"
EditSuffix=" (edited)" EditSuffix=""
#Nicks you want to ignore. # IgnoreNicks mutes outgoing messages from certain users.
#Regular expressions supported # Messages from these users will not be transmitted to other bridges.
#Messages from those users will not be sent to other bridges. # Regular expressions are also supported.
#OPTIONAL # Example: "ircspammer1 ircspammer2"
IgnoreNicks="ircspammer1 ircspammer2" IgnoreNicks=""
#Messages you want to ignore. # IgnoreMessages mutes outgoing messages of a certain format.
#Messages matching these regexp will be ignored and not sent to other bridges # Messages matching this regular expression will not be transmitted sent to other bridges
#See https://regex-golang.appspot.com/assets/html/index.html for more regex info # See https://regex-golang.appspot.com/assets/html/index.html for more regex info
#OPTIONAL (example below ignores messages starting with ~~ or messages containing badword #
IgnoreMessages="^~~ badword" # Example that ignores messages starting with ~~ or messages containing badword:
# IgnoreMessages="^~~ badword"
IgnoreMessages=""
#messages you want to replace. # ReplaceMessages replaces substrings of messages in outgoing messages.
#it replaces outgoing messages from the bridge. # Regular expressions are supported.
#so you need to place it by the sending bridge definition. #
#regular expressions supported # Example that replaces 'cat' => 'dog' and 'sleep' => 'awake':
#some examples: # ReplaceMessages=[ ["cat","dog"], ["sleep","awake"] ]
#this replaces cat => dog and sleep => awake # Example that replaces all digits with the letter 'X', so 'hello123' becomes 'helloXXX':
#replacemessages=[ ["cat","dog"], ["sleep","awake"] ] # ReplaceMessages=[ ["[0-9]","X"] ]
#this replaces every number with number. 123 => numbernumbernumber ReplaceMessages=[]
#replacemessages=[ ["[0-9]","number"] ]
#optional (default empty)
ReplaceMessages=[ ["cat","dog"] ]
#nicks you want to replace. # ReplaceNicks replaces substrings of usernames in outgoing messages.
#see replacemessages for syntaxa # See the ReplaceMessages setting for examples.
#optional (default empty) # Example: [ ["user--","user"] ]
ReplaceNicks=[ ["user--","user"] ] ReplaceNicks=[]
#Extractnicks is used to for example rewrite messages from other relaybots # ExtractNicks allows for interoperability with other bridge software by rewriting messages and extracting usernames.
#See https://github.com/42wim/matterbridge/issues/713 and https://github.com/42wim/matterbridge/issues/466 #
#some examples: # Recommended reading:
#this replaces a message like "Relaybot: <relayeduser> something interesting" to "relayeduser: something interesting" # - https://github.com/42wim/matterbridge/issues/466
#ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ] ] # - https://github.com/42wim/matterbridge/issues/713
#you can use multiple entries for multiplebots #
#this also replaces a message like "otherbot: (relayeduser) something else" to "relayeduser: something else" # This example translates the following message
#ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ],[ "otherbot","\\((.*?)\\)\\s+" ] # "Relaybot: <relayeduser> something interesting"
#OPTIONAL (default empty) # into this message
ExtractNicks=[ ["otherbot","<(.*?)>\\s+" ] ] # "relayeduser: something interesting"
# like so:
# ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ] ]
#
# This example translates the following message
# "otherbot: (relayeduser) something else"
# into this message
# "relayeduser: something else"
# like so:
# ExtractNicks=[ [ "otherbot","\\((.*?)\\)\\s+" ] ]
#
# This example combines both of the above examples into one:
# ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ],[ "otherbot","\\((.*?)\\)\\s+" ]
#
ExtractNicks=[]
#extra label that can be used in the RemoteNickFormat # Label is as an extra identifier for use in the RemoteNickFormat setting.
#optional (default empty)
Label="" Label=""
#RemoteNickFormat defines how remote users appear on this bridge # RemoteNickFormat formats how remote users appear on this bridge.
#See [general] config section for default options # See the [general] config section for default options
RemoteNickFormat="[{PROTOCOL}] <{NICK}> " RemoteNickFormat="[{PROTOCOL}] <{NICK}> "
#Enable to show users joins/parts from other bridges # ShowJoinPart emits messages that show joins/parts from other bridges
#Currently works for messages from the following bridges: irc, mattermost, slack, discord # Supported from the following bridges: irc, mattermost, slack, discord
#OPTIONAL (default false)
ShowJoinPart=false ShowJoinPart=false
#StripNick only allows alphanumerical nicks. See https://github.com/42wim/matterbridge/issues/285 # StripNick strips non-alphanumeric characters from nicknames.
#It will strip other characters from the nick # Recommended reading: https://github.com/42wim/matterbridge/issues/285
#OPTIONAL (default false)
StripNick=false StripNick=false
#Enable to show topic/purpose changes from other bridges # ShowTopicChange emits messages that show topic/purpose updates from other bridges
#Only works hiding/show topic changes from slack bridge for now # Supported from the following bridges: slack
#OPTIONAL (default false)
ShowTopicChange=false ShowTopicChange=false
#Enable to sync topic/purpose changes from other bridges # SyncTopic synchronises topic/purpose updates from other bridges
#Only works syncing topic changes from slack bridge for now # Supported from the following bridges: slack
#OPTIONAL (default false)
SyncTopic=false SyncTopic=false
################################################################### ###################################################################
@ -831,12 +971,17 @@ Token="Yourtokenhere"
## Settings below can be reloaded by editing the file ## Settings below can be reloaded by editing the file
#OPTIONAL (default empty) #OPTIONAL (default empty)
#Supported formats are "HTML", "Markdown" and "HTMLNick" #Supported formats are:
#See https://core.telegram.org/bots/api#html-style #"HTML" https://core.telegram.org/bots/api#html-style
#See https://core.telegram.org/bots/api#markdown-style #"Markdown" https://core.telegram.org/bots/api#markdown-style - deprecated, doesn't display links with underscores correctly
#HTMLNick only allows HTML for the nick, the message itself will be html-escaped #"MarkdownV2" https://core.telegram.org/bots/api#markdownv2-style
#"HTMLNick" - only allows HTML for the nick, the message itself will be html-escaped
MessageFormat="" MessageFormat=""
#OPTIONAL (default false)
#Disables link previews for links in messages
DisableWebPagePreview=false
#If enabled use the "First Name" as username. If this is empty use the Username #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 disabled use the "Username" as username. If this is empty use the First Name
#If all names are empty, username will be "unknown" #If all names are empty, username will be "unknown"
@ -853,6 +998,10 @@ UseInsecureURL=false
#OPTIONAL (default false) #OPTIONAL (default false)
QuoteDisable=false QuoteDisable=false
#Set the max. quoted length if 0 the whole message will be quoted
#OPTIONAL (default 0)
QuoteLengthLimit=0
#Format quoted/reply messages #Format quoted/reply messages
#OPTIONAL (default "{MESSAGE} (re @{QUOTENICK}: {QUOTEMESSAGE})") #OPTIONAL (default "{MESSAGE} (re @{QUOTENICK}: {QUOTEMESSAGE})")
QuoteFormat="{MESSAGE} (re @{QUOTENICK}: {QUOTEMESSAGE})" QuoteFormat="{MESSAGE} (re @{QUOTENICK}: {QUOTEMESSAGE})"
@ -1093,9 +1242,17 @@ Password="yourpass"
#OPTIONAL (default false) #OPTIONAL (default false)
NoHomeServerSuffix=false NoHomeServerSuffix=false
#Whether to disable sending of HTML content to matrix
#See https://github.com/42wim/matterbridge/issues/1022
#OPTIONAL (default false)
HTMLDisable=false
## RELOADABLE SETTINGS ## RELOADABLE SETTINGS
## Settings below can be reloaded by editing the file ## Settings below can be reloaded by editing the file
# UseUserName shows the username instead of the server nickname
UseUserName=false
#Whether to prefix messages from other bridges to matrix with the sender's nick. #Whether to prefix messages from other bridges to matrix with the sender's nick.
#Useful if username overrides for incoming webhooks isn't enabled on the #Useful if username overrides for incoming webhooks isn't enabled on the
#matrix server. If you set PrefixMessagesWithNick to true, each message #matrix server. If you set PrefixMessagesWithNick to true, each message
@ -1258,7 +1415,76 @@ StripNick=false
#OPTIONAL (default false) #OPTIONAL (default false)
ShowTopicChange=false ShowTopicChange=false
###################################################################
#
# NCTalk (Nextcloud Talk)
#
###################################################################
[nctalk.bridge]
# Url of your Nextcloud server
Server = "https://cloud.youdomain.me"
# Enable to not verify the certificate on your Nextcloud server.
# e.g. when using selfsigned certificates
# OPTIONAL (default false)
SkipTLSVerify=true
# Username of the bot
Login = "talkuser"
# Password of the bot
Password = "talkuserpass"
# Suffix for Guest Users
GuestSuffix = " (Guest)"
###################################################################
#
# Mumble
#
###################################################################
[mumble.bridge]
# Host and port of your Mumble server
Server = "mumble.yourdomain.me:64738"
# Nickname to log in as
Nick = "matterbridge"
# Some servers require a password
# OPTIONAL (default empty)
Password = "serverpasswordhere"
# User comment to set on the Mumble user, visible to other users.
# OPTIONAL (default empty)
UserComment="I am bridging text messages between this channel and #general on irc.yourdomain.me"
# Self-signed TLS client certificate + private key used to connect to
# Mumble. This is required if you want to register the matterbridge
# user on your Mumble server, so its nick becomes reserved.
# You can generate a keypair using e.g.
#
# openssl req -x509 -newkey rsa:2048 -nodes -days 10000 \
# -keyout mumble.key -out mumble.crt
#
# To actually register the matterbridege user, connect to Mumble as an
# admin, right click on the user and click "Register".
#
# OPTIONAL (default empty)
TLSClientCertificate="mumble.crt"
TLSClientKey="mumble.key"
# TLS CA certificate used to validate the Mumble server.
# OPTIONAL (defaults to Go system CA)
TLSCACertificate=mumble-ca.crt
# Enable to not verify the certificate on your Mumble server.
# e.g. when using selfsigned certificates
# OPTIONAL (default false)
SkipTLSVerify=false
################################################################### ###################################################################
# #
@ -1400,6 +1626,8 @@ Buffer=1000
#Bearer token used for authentication #Bearer token used for authentication
#curl -H "Authorization: Bearer token" http://localhost:4242/api/messages #curl -H "Authorization: Bearer token" http://localhost:4242/api/messages
# https://github.com/vi/websocat
# websocat -H="Authorization: Bearer token" ws://127.0.0.1:4242/api/websocket
#OPTIONAL (no authorization if token is empty) #OPTIONAL (no authorization if token is empty)
Token="mytoken" Token="mytoken"
@ -1423,7 +1651,8 @@ RemoteNickFormat="{NICK}"
## Settings below can be reloaded by editing the file ## Settings below can be reloaded by editing the file
#RemoteNickFormat defines how remote users appear on this bridge #RemoteNickFormat defines how remote users appear on this bridge
#The string "{NICK}" (case sensitive) will be replaced by the actual nick / username. #The string "{NICK}" (case sensitive) will be replaced by the actual nick.
#The string "{USERID}" (case sensitive) will be replaced by the user ID.
#The string "{BRIDGE}" (case sensitive) will be replaced by the sending bridge #The string "{BRIDGE}" (case sensitive) will be replaced by the sending bridge
#The string "{LABEL}" (case sensitive) will be replaced by label= field of the sending bridge #The string "{LABEL}" (case sensitive) will be replaced by label= field of the sending bridge
#The string "{PROTOCOL}" (case sensitive) will be replaced by the protocol used by the bridge #The string "{PROTOCOL}" (case sensitive) will be replaced by the protocol used by the bridge
@ -1479,6 +1708,14 @@ MediaDownloadBlacklist=[".html$",".htm$"]
#OPTIONAL (default false) #OPTIONAL (default false)
IgnoreFailureOnStart=false IgnoreFailureOnStart=false
#LogFile defines the location of a file to write logs into, rather
#than stdout.
#Logging will still happen on stdout if the file cannot be open for
#writing, or if the value is empty. Note that the log won't roll, so
#you might want to use logrotate(8) with this feature.
#OPTIONAL (default empty)
LogFile="/var/log/matterbridge.log"
################################################################### ###################################################################
#Tengo configuration #Tengo configuration
################################################################### ###################################################################
@ -1490,7 +1727,7 @@ IgnoreFailureOnStart=false
#This script will receive every incoming message and can be used to modify the Username and the Text of that message. #This script will receive every incoming message and can be used to modify the Username and the Text of that message.
#The script will have the following global variables: #The script will have the following global variables:
#to modify: msgUsername and msgText #to modify: msgUsername and msgText
#to read: msgChannel and msgAccount #to read: msgUserID, msgChannel, msgAccount
# #
#The script is reloaded on every message, so you can modify the script on the fly. #The script is reloaded on every message, so you can modify the script on the fly.
# #
@ -1514,9 +1751,12 @@ InMessage="example.tengo"
#read-only: #read-only:
#inAccount, inProtocol, inChannel, inGateway, inEvent #inAccount, inProtocol, inChannel, inGateway, inEvent
#outAccount, outProtocol, outChannel, outGateway, outEvent #outAccount, outProtocol, outChannel, outGateway, outEvent
#msgUserID
# #
#read-write: #read-write:
#msgText, msgUsername #msgText, msgUsername, msgDrop
#
#msgDrop is a bool which is default false, when set true this message will be dropped
# #
#The script is reloaded on every message, so you can modify the script on the fly. #The script is reloaded on every message, so you can modify the script on the fly.
# #
@ -1529,7 +1769,7 @@ OutMessage="example.tengo"
#RemoteNickFormat allows you to specify the location of a tengo (https://github.com/d5/tengo/) script. #RemoteNickFormat allows you to specify the location of a tengo (https://github.com/d5/tengo/) script.
#The script will have the following global variables: #The script will have the following global variables:
#to modify: result #to modify: result
#to read: channel, bridge, gateway, protocol, nick #to read: channel, bridge, gateway, protocol, nick, msgUserID
# #
#The result will be set in {TENGO} in the RemoteNickFormat key of every bridge where {TENGO} is specified #The result will be set in {TENGO} in the RemoteNickFormat key of every bridge where {TENGO} is specified
# #
@ -1569,32 +1809,48 @@ enable=true
# REQUIRED # REQUIRED
account="irc.freenode" account="irc.freenode"
# channel to connect on that account # The channel key in each gateway is mapped to a similar group chat ID on the chat platform
# How to specify them for the different bridges: # To find the group chat ID for different platforms, refer to the table below
# #
# irc - #channel (# is required) (this needs to be lowercase!) # Platform | Identifier name | Example | Description
# mattermost - channel (the channel name as seen in the URL, not the displayname) # -------------------------------------------------------------------------------------------------------------------------------------
# gitter - username/room # | channel | general | Do not include the # symbol
# xmpp - channel # discord | channel id | ID:123456789 | See https://github.com/42wim/matterbridge/issues/57
# slack - channel (without the #) # | category/channel | Media/gaming | Without # symbol. If you're using discord categories to group your channels
# - ID:C123456 (where C123456 is the channel ID) does not work with webhook # -------------------------------------------------------------------------------------------------------------------------------------
# discord - channel (without the #) # gitter | username/room | general | As seen in the gitter.im URL
# - ID:123456789 (where 123456789 is the channel ID) # -------------------------------------------------------------------------------------------------------------------------------------
# (https://github.com/42wim/matterbridge/issues/57) # hipchat | id_channel | example needed | See https://www.hipchat.com/account/xmpp for the correct channel
# - category/channel (without the #) if you're using discord categories to group your channels # -------------------------------------------------------------------------------------------------------------------------------------
# telegram - chatid (a large negative number, eg -123456789) # irc | channel | #general | The # symbol is required and should be lowercase!
# see (https://www.linkedin.com/pulse/telegram-bots-beginners-marco-frau) # -------------------------------------------------------------------------------------------------------------------------------------
# hipchat - id_channel (see https://www.hipchat.com/account/xmpp for the correct channel) # mattermost | channel | general | This is the channel name as seen in the URL, not the display name
# rocketchat - #channel (# is required (also needed for private channels!) # -------------------------------------------------------------------------------------------------------------------------------------
# matrix - #channel:server (eg #yourchannel:matrix.org) # matrix | #channel:server | #yourchannel:matrix.org | Encrypted rooms are not supported in matrix
# - encrypted rooms are not supported in matrix # -------------------------------------------------------------------------------------------------------------------------------------
# steam - chatid (a large number). # msteams | threadId | 19:82abcxx@thread.skype | You'll find the threadId in the URL
# The number in the URL when you click "enter chat room" in the browser # -------------------------------------------------------------------------------------------------------------------------------------
# whatsapp - 48111222333-123455678999@g.us A unique group JID; # mumble | channel id | 42 | The channel ID, as shown in the channel's "Edit" window
# if you specify an empty string bridge will list all the possibilities # -------------------------------------------------------------------------------------------------------------------------------------
# - "Group Name" if you specify a group name the bridge will hint its JID to specify # rocketchat | channel | #channel | # is required for private channels too
# as group names might change in time and contain weird emoticons # -------------------------------------------------------------------------------------------------------------------------------------
# zulip - stream/topic:topicname (without the #) # slack | channel name | general | Do not include the # symbol
# | channel id | ID:C123456 | The underlying ID of a channel. This doesn't work with
# -------------------------------------------------------------------------------------------------------------------------------------
# steam | chatid | example needed | The number in the URL when you click "enter chat room" in the browser
# -------------------------------------------------------------------------------------------------------------------------------------
# nctalk | token | xs25tz5y | The token in the URL when you are in a chat. It will be the last part of the URL.
# -------------------------------------------------------------------------------------------------------------------------------------
# telegram | chatid | -123456789 | A large negative number. see https://www.linkedin.com/pulse/telegram-bots-beginners-marco-frau
# -------------------------------------------------------------------------------------------------------------------------------------
# whatsapp | group JID | 48111222333-123455678999@g.us | A unique group JID. If you specify an empty string, bridge will list all the possibilities
# | "Group Name" | "Family Chat" | if you specify a group name, the bridge will find hint the JID to specify. Names can change over time and are not stable.
# -------------------------------------------------------------------------------------------------------------------------------------
# xmpp | channel | general | The room name
# -------------------------------------------------------------------------------------------------------------------------------------
# zulip | stream/topic:topic | general/off-topic:food | Do not use the # when specifying a topic
# -------------------------------------------------------------------------------------------------------------------------------------
# #
# REQUIRED # REQUIRED
channel="#testing" channel="#testing"
@ -1626,13 +1882,16 @@ enable=true
#OPTIONAL - your irc / xmpp channel key #OPTIONAL - your irc / xmpp channel key
key="yourkey" key="yourkey"
# Discord specific gateway options
[[gateway.inout]] [[gateway.inout]]
account="discord.game" account="discord.game"
channel="mygreatgame" channel="mygreatgame"
#OPTIONAL - webhookurl only works for discord (it needs a different URL for each cahnnel)
[gateway.inout.options] [gateway.inout.options]
webhookurl="https://discordapp.com/api/webhooks/123456789123456789/C9WPqExYWONPDZabcdef-def1434FGFjstasJX9pYht73y" # WebhookURL sends messages in the style of "puppets". You must configure a webhook URL for each channel you want to bridge.
# If you have more than one channel and don't wnat to configure each channel manually, see the "AutoWebhooks" option in the gateway config.
# Example: "https://discord.com/api/webhooks/1234/abcd_xyzw"
WebhookURL=""
[[gateway.inout]] [[gateway.inout]]
account="zulip.streamchat" account="zulip.streamchat"

14
manifest.json
View file

@ -1,5 +1,5 @@
{ {
"name": "matterbridge", "name": "Matterbridge",
"id": "matterbridge", "id": "matterbridge",
"packaging_format": 1, "packaging_format": 1,
"description": { "description": {
@ -8,13 +8,13 @@
}, },
"version": "1.21.0~ynh1", "version": "1.21.0~ynh1",
"url": "https://github.com/42wim/matterbridge", "url": "https://github.com/42wim/matterbridge",
"license": "GPL-3.0", "license": "Apache-2.0",
"maintainer": { "maintainer": {
"name": "liberodark", "name": "",
"email": "liberodark@gmail.com" "email": ""
}, },
"requirements": { "requirements": {
"yunohost": ">= 3.8.1" "yunohost": ">= 4.0.0"
}, },
"multi_instance": false, "multi_instance": false,
"services": [ "services": [
@ -26,8 +26,8 @@
"name": "domain", "name": "domain",
"type": "domain", "type": "domain",
"ask": { "ask": {
"en": "Choose a domain name for ynhexample", "en": "Choose a domain name for Matterbridge",
"fr": "Choisissez un nom de domaine pour ynhexample" "fr": "Choisissez un nom de domaine pour Matterbridge"
}, },
"example": "example.com" "example": "example.com"
}, },