├── .github ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── ALL_README.md ├── LICENSE ├── README.md ├── README_es.md ├── README_eu.md ├── README_fr.md ├── README_gl.md ├── README_id.md ├── README_it.md ├── README_zh_Hans.md ├── conf ├── matterbridge.toml ├── matterbridge.toml.example └── systemd.service ├── doc ├── ADMIN.md ├── ADMIN_fr.md ├── DESCRIPTION.md └── DESCRIPTION_fr.md ├── manifest.toml ├── scripts ├── _common.sh ├── backup ├── install ├── remove ├── restore └── upgrade └── tests.toml /.github/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: When creating a bug report, please use the following template to provide all the relevant information and help debugging efficiently. 4 | 5 | --- 6 | 7 | **How to post a meaningful bug report** 8 | 1. *Read this whole template first.* 9 | 2. *Determine if you are on the right place:* 10 | - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!* 11 | - *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.* 12 | - *When in doubt, post here and we will figure it out together.* 13 | 3. *Delete the italic comments as you write over them below, and remove this guide.* 14 | --- 15 | 16 | ### Describe the bug 17 | 18 | *A clear and concise description of what the bug is.* 19 | 20 | ### Context 21 | 22 | - Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...* 23 | - YunoHost version: x.x.x 24 | - I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...* 25 | - Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes* 26 | - If yes, please explain: 27 | - Using, or trying to install package version/branch: 28 | - If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`* 29 | 30 | ### Steps to reproduce 31 | 32 | - *If you performed a command from the CLI, the command itself is enough. For example:* 33 | ```sh 34 | sudo yunohost app install the_app 35 | ``` 36 | - *If you used the webadmin, please perform the equivalent command from the CLI first.* 37 | - *If the error occurs in your browser, explain what you did:* 38 | 1. *Go to '...'* 39 | 2. *Click on '...'* 40 | 3. *Scroll down to '...'* 41 | 4. *See error* 42 | 43 | ### Expected behavior 44 | 45 | *A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.* 46 | 47 | ### Logs 48 | 49 | *When an operation fails, YunoHost provides a simple way to share the logs.* 50 | - *In the webadmin, the error message contains a link to the relevant log page. On that page, you will be able to 'Share with Yunopaste'. If you missed it, the logs of previous operations are also available under Tools > Logs.* 51 | - *In command line, the command to share the logs is displayed at the end of the operation and looks like `yunohost log display [log name] --share`. If you missed it, you can find the log ID of a previous operation using `yunohost log list`.* 52 | 53 | *After sharing the log, please copypaste directly the link provided by YunoHost (to help readability, no need to copypaste the entire content of the log here, just the link is enough...)* 54 | 55 | *If applicable and useful, add screenshots to help explain your problem.* 56 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## Problem 2 | 3 | - *Description of why you made this PR* 4 | 5 | ## Solution 6 | 7 | - *And how do you fix that problem* 8 | 9 | ## PR Status 10 | 11 | - [ ] Code finished and ready to be reviewed/tested 12 | - [ ] The fix/enhancement were manually tested (if applicable) 13 | 14 | ## Automatic tests 15 | 16 | Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization) 17 | -------------------------------------------------------------------------------- /ALL_README.md: -------------------------------------------------------------------------------- 1 | # All available README files by language 2 | 3 | - [Read the README in English](README.md) 4 | - [Lea el README en español](README_es.md) 5 | - [Irakurri README euskaraz](README_eu.md) 6 | - [Lire le README en français](README_fr.md) 7 | - [Le o README en galego](README_gl.md) 8 | - [Baca README dalam bahasa bahasa Indonesia](README_id.md) 9 | - [阅读中文（简体）的 README](README_zh_Hans.md) 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Matterbridge for YunoHost 7 | 8 | [![Integration level](https://dash.yunohost.org/integration/matterbridge.svg)](https://ci-apps.yunohost.org/ci/apps/matterbridge/) ![Working status](https://ci-apps.yunohost.org/ci/badges/matterbridge.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/matterbridge.maintain.svg) 9 | 10 | [![Install Matterbridge with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matterbridge) 11 | 12 | *[Read this README in other languages.](./ALL_README.md)* 13 | 14 | > *This package allows you to install Matterbridge quickly and simply on a YunoHost server.* 15 | > *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.* 16 | 17 | ## Overview 18 | 19 | A simple chat bridge between a growing number of protocols: 20 | 21 | Discord, Gitter, IRC, Keybase, Matrix, Mattermost, MSTeams, Rocket.Chat, Slack, Telegram, Twitch, WhatsApp, XMPP, Zulip, And more... 22 | 23 | 24 | **Shipped version:** 1.26.0~ynh2 25 | ## Documentation and resources 26 | 27 | - Official admin documentation: 28 | - Upstream app code repository: 29 | - YunoHost Store: 30 | - Report a bug: 31 | 32 | ## Developer info 33 | 34 | Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing). 35 | 36 | To try the `testing` branch, please proceed like that: 37 | 38 | ```bash 39 | sudo yunohost app install https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug 40 | or 41 | sudo yunohost app upgrade matterbridge -u https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug 42 | ``` 43 | 44 | **More info regarding app packaging:** 45 | -------------------------------------------------------------------------------- /README_es.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Matterbridge para Yunohost 7 | 8 | [![Nivel de integración](https://dash.yunohost.org/integration/matterbridge.svg)](https://ci-apps.yunohost.org/ci/apps/matterbridge/) ![Estado funcional](https://ci-apps.yunohost.org/ci/badges/matterbridge.status.svg) ![Estado En Mantención](https://ci-apps.yunohost.org/ci/badges/matterbridge.maintain.svg) 9 | 10 | [![Instalar Matterbridge con Yunhost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matterbridge) 11 | 12 | *[Leer este README en otros idiomas.](./ALL_README.md)* 13 | 14 | > *Este paquete le permite instalarMatterbridge rapidamente y simplement en un servidor YunoHost.* 15 | > *Si no tiene YunoHost, visita [the guide](https://yunohost.org/install) para aprender como instalarla.* 16 | 17 | ## Descripción general 18 | 19 | A simple chat bridge between a growing number of protocols: 20 | 21 | Discord, Gitter, IRC, Keybase, Matrix, Mattermost, MSTeams, Rocket.Chat, Slack, Telegram, Twitch, WhatsApp, XMPP, Zulip, And more... 22 | 23 | 24 | **Versión actual:** 1.26.0~ynh2 25 | ## Documentaciones y recursos 26 | 27 | - Documentación administrador oficial: 28 | - Repositorio del código fuente oficial de la aplicación : 29 | - Catálogo YunoHost: 30 | - Reportar un error: 31 | 32 | ## Información para desarrolladores 33 | 34 | Por favor enviar sus correcciones a la [`branch testing`](https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing 35 | 36 | Para probar la rama `testing`, sigue asÍ: 37 | 38 | ```bash 39 | sudo yunohost app install https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug 40 | o 41 | sudo yunohost app upgrade matterbridge -u https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug 42 | ``` 43 | 44 | **Mas informaciones sobre el empaquetado de aplicaciones:** 45 | -------------------------------------------------------------------------------- /README_eu.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Matterbridge YunoHost-erako 7 | 8 | [![Integrazio maila](https://dash.yunohost.org/integration/matterbridge.svg)](https://ci-apps.yunohost.org/ci/apps/matterbridge/) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/matterbridge.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/matterbridge.maintain.svg) 9 | 10 | [![Instalatu Matterbridge YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matterbridge) 11 | 12 | *[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* 13 | 14 | > *Pakete honek Matterbridge YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.* 15 | > *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.* 16 | 17 | ## Aurreikuspena 18 | 19 | A simple chat bridge between a growing number of protocols: 20 | 21 | Discord, Gitter, IRC, Keybase, Matrix, Mattermost, MSTeams, Rocket.Chat, Slack, Telegram, Twitch, WhatsApp, XMPP, Zulip, And more... 22 | 23 | 24 | **Paketatutako bertsioa:** 1.26.0~ynh2 25 | ## Dokumentazioa eta baliabideak 26 | 27 | - Administratzaileen dokumentazio ofiziala: 28 | - Jatorrizko aplikazioaren kode-gordailua: 29 | - YunoHost Denda: 30 | - Eman errore baten berri: 31 | 32 | ## Garatzaileentzako informazioa 33 | 34 | Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing). 35 | 36 | `testing` abarra probatzeko, ondorengoa egin: 37 | 38 | ```bash 39 | sudo yunohost app install https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug 40 | edo 41 | sudo yunohost app upgrade matterbridge -u https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug 42 | ``` 43 | 44 | **Informazio gehiago aplikazioaren paketatzeari buruz:** 45 | -------------------------------------------------------------------------------- /README_fr.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Matterbridge pour YunoHost 7 | 8 | [![Niveau d’intégration](https://dash.yunohost.org/integration/matterbridge.svg)](https://ci-apps.yunohost.org/ci/apps/matterbridge/) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/matterbridge.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/matterbridge.maintain.svg) 9 | 10 | [![Installer Matterbridge avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matterbridge) 11 | 12 | *[Lire le README dans d'autres langues.](./ALL_README.md)* 13 | 14 | > *Ce package vous permet d’installer Matterbridge rapidement et simplement sur un serveur YunoHost.* 15 | > *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* 16 | 17 | ## Vue d’ensemble 18 | 19 | Un connecteur de messagerie simple entre un nombre croissant de protocoles : 20 | 21 | Discord, Gitter, IRC, Keybase, Matrix, Mattermost, MSTeams, Rocket.Chat, Slack, Telegram, Twitch, WhatsApp, XMPP, Zulip, Et plus... 22 | 23 | 24 | **Version incluse :** 1.26.0~ynh2 25 | ## Documentations et ressources 26 | 27 | - Documentation officielle de l’admin : 28 | - Dépôt de code officiel de l’app : 29 | - YunoHost Store : 30 | - Signaler un bug : 31 | 32 | ## Informations pour les développeurs 33 | 34 | Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing). 35 | 36 | Pour essayer la branche `testing`, procédez comme suit : 37 | 38 | ```bash 39 | sudo yunohost app install https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug 40 | ou 41 | sudo yunohost app upgrade matterbridge -u https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug 42 | ``` 43 | 44 | **Plus d’infos sur le packaging d’applications :** 45 | -------------------------------------------------------------------------------- /README_gl.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Matterbridge para YunoHost 7 | 8 | [![Nivel de integración](https://dash.yunohost.org/integration/matterbridge.svg)](https://ci-apps.yunohost.org/ci/apps/matterbridge/) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/matterbridge.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/matterbridge.maintain.svg) 9 | 10 | [![Instalar Matterbridge con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matterbridge) 11 | 12 | *[Le este README en outros idiomas.](./ALL_README.md)* 13 | 14 | > *Este paquete permíteche instalar Matterbridge de xeito rápido e doado nun servidor YunoHost.* 15 | > *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.* 16 | 17 | ## Vista xeral 18 | 19 | A simple chat bridge between a growing number of protocols: 20 | 21 | Discord, Gitter, IRC, Keybase, Matrix, Mattermost, MSTeams, Rocket.Chat, Slack, Telegram, Twitch, WhatsApp, XMPP, Zulip, And more... 22 | 23 | 24 | **Versión proporcionada:** 1.26.0~ynh2 25 | ## Documentación e recursos 26 | 27 | - Documentación oficial para admin: 28 | - Repositorio de orixe do código: 29 | - Tenda YunoHost: 30 | - Informar dun problema: 31 | 32 | ## Info de desenvolvemento 33 | 34 | Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing). 35 | 36 | Para probar a rama `testing`, procede deste xeito: 37 | 38 | ```bash 39 | sudo yunohost app install https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug 40 | ou 41 | sudo yunohost app upgrade matterbridge -u https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug 42 | ``` 43 | 44 | **Máis info sobre o empaquetado da app:** 45 | -------------------------------------------------------------------------------- /README_id.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Matterbridge untuk YunoHost 7 | 8 | [![Tingkat integrasi](https://dash.yunohost.org/integration/matterbridge.svg)](https://ci-apps.yunohost.org/ci/apps/matterbridge/) ![Status kerja](https://ci-apps.yunohost.org/ci/badges/matterbridge.status.svg) ![Status pemeliharaan](https://ci-apps.yunohost.org/ci/badges/matterbridge.maintain.svg) 9 | 10 | [![Pasang Matterbridge dengan YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matterbridge) 11 | 12 | *[Baca README ini dengan bahasa yang lain.](./ALL_README.md)* 13 | 14 | > *Paket ini memperbolehkan Anda untuk memasang Matterbridge secara cepat dan mudah pada server YunoHost.* 15 | > *Bila Anda tidak mempunyai YunoHost, silakan berkonsultasi dengan [panduan](https://yunohost.org/install) untuk mempelajari bagaimana untuk memasangnya.* 16 | 17 | ## Ringkasan 18 | 19 | A simple chat bridge between a growing number of protocols: 20 | 21 | Discord, Gitter, IRC, Keybase, Matrix, Mattermost, MSTeams, Rocket.Chat, Slack, Telegram, Twitch, WhatsApp, XMPP, Zulip, And more... 22 | 23 | 24 | **Versi terkirim:** 1.26.0~ynh2 25 | ## Dokumentasi dan sumber daya 26 | 27 | - Dokumentasi admin resmi: 28 | - Depot kode aplikasi hulu: 29 | - Gudang YunoHost: 30 | - Laporkan bug: 31 | 32 | ## Info developer 33 | 34 | Silakan kirim pull request ke [`testing` branch](https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing). 35 | 36 | Untuk mencoba branch `testing`, silakan dilanjutkan seperti: 37 | 38 | ```bash 39 | sudo yunohost app install https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug 40 | atau 41 | sudo yunohost app upgrade matterbridge -u https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug 42 | ``` 43 | 44 | **Info lebih lanjut mengenai pemaketan aplikasi:** 45 | -------------------------------------------------------------------------------- /README_it.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # Matterbridge per YunoHost 7 | 8 | [![Livello di integrazione](https://dash.yunohost.org/integration/matterbridge.svg)](https://dash.yunohost.org/appci/app/matterbridge) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/matterbridge.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/matterbridge.maintain.svg) 9 | 10 | [![Installa Matterbridge con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matterbridge) 11 | 12 | *[Leggi questo README in altre lingue.](./ALL_README.md)* 13 | 14 | > *Questo pacchetto ti permette di installare Matterbridge su un server YunoHost in modo semplice e veloce.* 15 | > *Se non hai YunoHost, consulta [la guida](https://yunohost.org/install) per imparare a installarlo.* 16 | 17 | ## Panoramica 18 | 19 | A simple chat bridge between a growing number of protocols: 20 | 21 | Discord, Gitter, IRC, Keybase, Matrix, Mattermost, MSTeams, Rocket.Chat, Slack, Telegram, Twitch, WhatsApp, XMPP, Zulip, And more... 22 | 23 | 24 | **Versione pubblicata:** 1.26.0~ynh2 25 | ## Documentazione e risorse 26 | 27 | - Documentazione ufficiale per gli amministratori: 28 | - Repository upstream del codice dell’app: 29 | - Store di YunoHost: 30 | - Segnala un problema: 31 | 32 | ## Informazioni per sviluppatori 33 | 34 | Si prega di inviare la tua pull request alla [branch di `testing`](https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing). 35 | 36 | Per provare la branch di `testing`, si prega di procedere in questo modo: 37 | 38 | ```bash 39 | sudo yunohost app install https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug 40 | o 41 | sudo yunohost app upgrade matterbridge -u https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug 42 | ``` 43 | 44 | **Maggiori informazioni riguardo il pacchetto di quest’app:** 45 | -------------------------------------------------------------------------------- /README_zh_Hans.md: -------------------------------------------------------------------------------- 1 | 5 | 6 | # YunoHost 上的 Matterbridge 7 | 8 | [![集成程度](https://dash.yunohost.org/integration/matterbridge.svg)](https://ci-apps.yunohost.org/ci/apps/matterbridge/) ![工作状态](https://ci-apps.yunohost.org/ci/badges/matterbridge.status.svg) ![维护状态](https://ci-apps.yunohost.org/ci/badges/matterbridge.maintain.svg) 9 | 10 | [![使用 YunoHost 安装 Matterbridge](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=matterbridge) 11 | 12 | *[阅读此 README 的其它语言版本。](./ALL_README.md)* 13 | 14 | > *通过此软件包，您可以在 YunoHost 服务器上快速、简单地安装 Matterbridge。* 15 | > *如果您还没有 YunoHost，请参阅[指南](https://yunohost.org/install)了解如何安装它。* 16 | 17 | ## 概况 18 | 19 | A simple chat bridge between a growing number of protocols: 20 | 21 | Discord, Gitter, IRC, Keybase, Matrix, Mattermost, MSTeams, Rocket.Chat, Slack, Telegram, Twitch, WhatsApp, XMPP, Zulip, And more... 22 | 23 | 24 | **分发版本：** 1.26.0~ynh2 25 | ## 文档与资源 26 | 27 | - 官方管理文档： 28 | - 上游应用代码库： 29 | - YunoHost 商店： 30 | - 报告 bug： 31 | 32 | ## 开发者信息 33 | 34 | 请向 [`testing` 分支](https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing) 发送拉取请求。 35 | 36 | 如要尝试 `testing` 分支，请这样操作： 37 | 38 | ```bash 39 | sudo yunohost app install https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug 40 | 或 41 | sudo yunohost app upgrade matterbridge -u https://github.com/YunoHost-Apps/matterbridge_ynh/tree/testing --debug 42 | ``` 43 | 44 | **有关应用打包的更多信息：** 45 | -------------------------------------------------------------------------------- /conf/matterbridge.toml: -------------------------------------------------------------------------------- 1 | [irc] 2 | [irc.freenode] 3 | Server="irc.freenode.net:6667" 4 | Nick="yourbotname" 5 | 6 | [mattermost] 7 | [mattermost.work] 8 | Server="yourmattermostserver.tld" 9 | Team="yourteam" 10 | Login="yourlogin" 11 | Password="yourpass" 12 | PrefixMessagesWithNick=true 13 | RemoteNickFormat="[{PROTOCOL}] <{NICK}> " 14 | 15 | [[gateway]] 16 | name="mygateway" 17 | enable=true 18 | [[gateway.inout]] 19 | account="irc.freenode" 20 | channel="#testing" 21 | 22 | [[gateway.inout]] 23 | account="mattermost.work" 24 | channel="off-topic" 25 | -------------------------------------------------------------------------------- /conf/matterbridge.toml.example: -------------------------------------------------------------------------------- 1 | #This is configuration for matterbridge. 2 | #WARNING: as this file contains credentials, be sure to set correct file permissions 3 | #See https://github.com/42wim/matterbridge/wiki/How-to-create-your-config for how to create your config 4 | #See https://github.com/42wim/matterbridge/wiki/Settings for all settings 5 | ################################################################### 6 | #IRC section 7 | ################################################################### 8 | #REQUIRED to start IRC section 9 | [irc] 10 | 11 | #You can configure multiple servers "[irc.name]" or "[irc.name2]" 12 | #In this example we use [irc.freenode] 13 | #REQUIRED 14 | [irc.freenode] 15 | #irc server to connect to. 16 | #REQUIRED 17 | Server="irc.freenode.net:6667" 18 | 19 | #Password for irc server (if necessary) 20 | #OPTIONAL (default "") 21 | Password="" 22 | 23 | #Enable to use TLS connection to your irc server. 24 | #OPTIONAL (default false) 25 | UseTLS=false 26 | 27 | #Enable SASL (PLAIN) authentication. (freenode requires this from eg AWS hosts) 28 | #It uses NickServNick and NickServPassword as login and password 29 | #OPTIONAL (default false) 30 | UseSASL=false 31 | 32 | #Enable to not verify the certificate on your irc server. 33 | #e.g. when using selfsigned certificates 34 | #OPTIONAL (default false) 35 | SkipTLSVerify=true 36 | 37 | #If you know your charset, you can specify it manually. 38 | #Otherwise it tries to detect this automatically. Select one below 39 | # "iso-8859-2:1987", "iso-8859-9:1989", "866", "latin9", "iso-8859-10:1992", "iso-ir-109", "hebrew", 40 | # "cp932", "iso-8859-15", "cp437", "utf-16be", "iso-8859-3:1988", "windows-1251", "utf16", "latin6", 41 | # "latin3", "iso-8859-1:1987", "iso-8859-9", "utf-16le", "big5", "cp819", "asmo-708", "utf-8", 42 | # "ibm437", "iso-ir-157", "iso-ir-144", "latin4", "850", "iso-8859-5", "iso-8859-5:1988", "l3", 43 | # "windows-31j", "utf8", "iso-8859-3", "437", "greek", "iso-8859-8", "l6", "l9-iso-8859-15", 44 | # "iso-8859-2", "latin2", "iso-ir-100", "iso-8859-6", "arabic", "iso-ir-148", "us-ascii", "x-sjis", 45 | # "utf16be", "iso-8859-8:1988", "utf16le", "l4", "utf-16", "iso-ir-138", "iso-8859-7", "iso-8859-7:1987", 46 | # "windows-1252", "l2", "koi8-r", "iso8859-1", "latin1", "ecma-114", "iso-ir-110", "elot-928", 47 | # "iso-ir-126", "iso-8859-1", "iso-ir-127", "cp850", "cyrillic", "greek8", "windows-1250", "iso-latin-1", 48 | # "l5", "ibm866", "cp866", "ms-kanji", "ibm850", "ecma-118", "iso-ir-101", "ibm819", "l1", "iso-8859-6:1987", 49 | # "latin5", "ascii", "sjis", "iso-8859-10", "iso-8859-4", "iso-8859-4:1988", "shift-jis 50 | # The select charset will be converted to utf-8 when sent to other bridges. 51 | #OPTIONAL (default "") 52 | Charset="" 53 | 54 | #Your nick on irc. 55 | #REQUIRED 56 | Nick="matterbot" 57 | 58 | #If you registered your bot with a service like Nickserv on freenode. 59 | #Also being used when UseSASL=true 60 | # 61 | #Note: if you want do to quakenet auth, set NickServNick="Q@CServe.quakenet.org" 62 | #OPTIONAL 63 | NickServNick="nickserv" 64 | NickServPassword="secret" 65 | 66 | #OPTIONAL only used for quakenet auth 67 | NickServUsername="username" 68 | 69 | ## RELOADABLE SETTINGS 70 | ## Settings below can be reloaded by editing the file 71 | 72 | #Flood control 73 | #Delay in milliseconds between each message send to the IRC server 74 | #OPTIONAL (default 1300) 75 | MessageDelay=1300 76 | 77 | #Maximum amount of messages to hold in queue. If queue is full 78 | #messages will be dropped. 79 | # will be add to the message that fills the queue. 80 | #OPTIONAL (default 30) 81 | MessageQueue=30 82 | 83 | #Maximum length of message sent to irc server. If it exceeds 84 | # will be add to the message. 85 | #OPTIONAL (default 400) 86 | MessageLength=400 87 | 88 | #Split messages on MessageLength instead of showing the 89 | #WARNING: this could lead to flooding 90 | #OPTIONAL (default false) 91 | MessageSplit=false 92 | 93 | #Delay in seconds to rejoin a channel when kicked 94 | #OPTIONAL (default 0) 95 | RejoinDelay=0 96 | 97 | #ColorNicks will show each nickname in a different color. 98 | #Only works in IRC right now. 99 | ColorNicks=false 100 | 101 | #RunCommands allows you to send RAW irc commands after connection 102 | #Array of strings 103 | #OPTIONAL (default empty) 104 | RunCommands=["PRIVMSG user hello","PRIVMSG chanserv something"] 105 | 106 | #PingDelay specifies how long to wait to send a ping to the irc server. 107 | #You can use s for second, m for minute 108 | #String 109 | #OPTIONAL (default 1m) 110 | PingDelay="1m" 111 | 112 | #StripMarkdown strips markdown from messages 113 | #OPTIONAL (default false) 114 | StripMarkdown=false 115 | 116 | #Nicks you want to ignore. 117 | #Regular expressions supported 118 | #Messages from those users will not be sent to other bridges. 119 | #OPTIONAL 120 | IgnoreNicks="ircspammer1 ircspammer2" 121 | 122 | #Messages you want to ignore. 123 | #Messages matching these regexp will be ignored and not sent to other bridges 124 | #See https://regex-golang.appspot.com/assets/html/index.html for more regex info 125 | #OPTIONAL (example below ignores messages starting with ~~ or messages containing badword 126 | IgnoreMessages="^~~ badword" 127 | 128 | #messages you want to replace. 129 | #it replaces outgoing messages from the bridge. 130 | #so you need to place it by the sending bridge definition. 131 | #regular expressions supported 132 | #some examples: 133 | #this replaces cat => dog and sleep => awake 134 | #replacemessages=[ ["cat","dog"], ["sleep","awake"] ] 135 | #this replaces every number with number. 123 => numbernumbernumber 136 | #replacemessages=[ ["[0-9]","number"] ] 137 | #optional (default empty) 138 | ReplaceMessages=[ ["cat","dog"] ] 139 | 140 | #nicks you want to replace. 141 | #see replacemessages for syntaxa 142 | #optional (default empty) 143 | ReplaceNicks=[ ["user--","user"] ] 144 | 145 | #Extractnicks is used to for example rewrite messages from other relaybots 146 | #See https://github.com/42wim/matterbridge/issues/713 and https://github.com/42wim/matterbridge/issues/466 147 | #some examples: 148 | #this replaces a message like "Relaybot: something interesting" to "relayeduser: something interesting" 149 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ] ] 150 | #you can use multiple entries for multiplebots 151 | #this also replaces a message like "otherbot: (relayeduser) something else" to "relayeduser: something else" 152 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ],[ "otherbot","\\((.*?)\\)\\s+" ] 153 | #OPTIONAL (default empty) 154 | ExtractNicks=[ ["otherbot","<(.*?)>\\s+" ] ] 155 | 156 | #extra label that can be used in the RemoteNickFormat 157 | #optional (default empty) 158 | Label="" 159 | 160 | #RemoteNickFormat defines how remote users appear on this bridge 161 | #See [general] config section for default options 162 | #The string "{NOPINGNICK}" (case sensitive) will be replaced by the actual nick / username, but with a ZWSP inside the nick, so the irc user with the same nick won't get pinged. See https://github.com/42wim/matterbridge/issues/175 for more information 163 | RemoteNickFormat="[{PROTOCOL}] <{NICK}> " 164 | 165 | #Enable to show users joins/parts from other bridges 166 | #Currently works for messages from the following bridges: irc, mattermost, slack, discord 167 | #OPTIONAL (default false) 168 | ShowJoinPart=false 169 | 170 | #Enable to show verbose users joins/parts (ident@host) from other bridges 171 | #Currently works for messages from the following bridges: irc 172 | #OPTIONAL (default false) 173 | VerboseJoinPart=false 174 | 175 | #Do not send joins/parts to other bridges 176 | #Currently works for messages from the following bridges: irc, mattermost, slack 177 | #OPTIONAL (default false) 178 | NoSendJoinPart=false 179 | 180 | #StripNick only allows alphanumerical nicks. See https://github.com/42wim/matterbridge/issues/285 181 | #It will strip other characters from the nick 182 | #OPTIONAL (default false) 183 | StripNick=false 184 | 185 | #Enable to show topic changes from other bridges 186 | #Only works hiding/show topic changes from slack bridge for now 187 | #OPTIONAL (default false) 188 | ShowTopicChange=false 189 | 190 | #Delay in milliseconds between channel joins 191 | #Only useful when you have a LOT of channels to join 192 | #See https://github.com/42wim/matterbridge/issues/1084 193 | #OPTIONAL (default 0) 194 | JoinDelay=0 195 | 196 | #Use the optional RELAYMSG extension for username spoofing on IRC. 197 | #This requires an IRCd that supports the draft/relaymsg specification: currently this includes 198 | #Oragono 2.4.0+ and InspIRCd 3 with the m_relaymsg contrib module. 199 | #See https://github.com/42wim/matterbridge/issues/667#issuecomment-634214165 for more details. 200 | #Spoofed nicks will use the configured RemoteNickFormat, replacing reserved IRC characters 201 | #(!+%@&#$:'"?*,.) with a hyphen (-). 202 | #On most configurations, the RemoteNickFormat must include a separator character such as "/". 203 | #You should make sure that the settings here match your IRCd. 204 | #This option overrides ColorNicks. 205 | #OPTIONAL (default false) 206 | UseRelayMsg=false 207 | #RemoteNickFormat="{NICK}/{PROTOCOL}" 208 | 209 | ################################################################### 210 | #XMPP section 211 | ################################################################### 212 | [xmpp] 213 | 214 | #You can configure multiple servers "[xmpp.name]" or "[xmpp.name2]" 215 | #In this example we use [xmpp.jabber] 216 | #REQUIRED 217 | [xmpp.jabber] 218 | #xmpp server to connect to. 219 | #REQUIRED 220 | Server="jabber.example.com:5222" 221 | 222 | #Jid 223 | #REQUIRED 224 | Jid="user@example.com" 225 | 226 | #Password 227 | #REQUIRED 228 | Password="yourpass" 229 | 230 | #MUC 231 | #REQUIRED 232 | Muc="conference.jabber.example.com" 233 | 234 | #Your nick in the rooms 235 | #REQUIRED 236 | Nick="xmppbot" 237 | 238 | #Enable to not verify the certificate on your xmpp server. 239 | #e.g. when using selfsigned certificates 240 | #OPTIONAL (default false) 241 | SkipTLSVerify=true 242 | 243 | #Enable to use plaintext connection to your XMPP server. 244 | #OPTIONAL (default false) 245 | NoTLS=true 246 | 247 | ## RELOADABLE SETTINGS 248 | ## Settings below can be reloaded by editing the file 249 | 250 | #Nicks you want to ignore. 251 | #Regular expressions supported 252 | #Messages from those users will not be sent to other bridges. 253 | #OPTIONAL 254 | IgnoreNicks="ircspammer1 ircspammer2" 255 | 256 | #Messages you want to ignore. 257 | #Messages matching these regexp will be ignored and not sent to other bridges 258 | #See https://regex-golang.appspot.com/assets/html/index.html for more regex info 259 | #OPTIONAL (example below ignores messages starting with ~~ or messages containing badword 260 | IgnoreMessages="^~~ badword" 261 | 262 | #Messages you want to replace. 263 | #It replaces outgoing messages from the bridge. 264 | #So you need to place it by the sending bridge definition. 265 | #Regular expressions supported 266 | #Some examples: 267 | #This replaces cat => dog and sleep => awake 268 | #ReplaceMessages=[ ["cat","dog"], ["sleep","awake"] ] 269 | #This Replaces every number with number. 123 => numbernumbernumber 270 | #ReplaceMessages=[ ["[0-9]","number"] ] 271 | #OPTIONAL (default empty) 272 | ReplaceMessages=[ ["cat","dog"] ] 273 | 274 | #Nicks you want to replace. 275 | #See ReplaceMessages for syntaxA 276 | #OPTIONAL (default empty) 277 | ReplaceNicks=[ ["user--","user"] ] 278 | 279 | #Extractnicks is used to for example rewrite messages from other relaybots 280 | #See https://github.com/42wim/matterbridge/issues/713 and https://github.com/42wim/matterbridge/issues/466 281 | #some examples: 282 | #this replaces a message like "Relaybot: something interesting" to "relayeduser: something interesting" 283 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ] ] 284 | #you can use multiple entries for multiplebots 285 | #this also replaces a message like "otherbot: (relayeduser) something else" to "relayeduser: something else" 286 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ],[ "otherbot","\\((.*?)\\)\\s+" ] 287 | #OPTIONAL (default empty) 288 | ExtractNicks=[ ["otherbot","<(.*?)>\\s+" ] ] 289 | 290 | #extra label that can be used in the RemoteNickFormat 291 | #optional (default empty) 292 | Label="" 293 | 294 | #RemoteNickFormat defines how remote users appear on this bridge 295 | #See [general] config section for default options 296 | RemoteNickFormat="[{PROTOCOL}] <{NICK}> " 297 | 298 | #Enable to show users joins/parts from other bridges 299 | #Currently works for messages from the following bridges: irc, mattermost, slack, discord 300 | #OPTIONAL (default false) 301 | ShowJoinPart=false 302 | 303 | #StripNick only allows alphanumerical nicks. See https://github.com/42wim/matterbridge/issues/285 304 | #It will strip other characters from the nick 305 | #OPTIONAL (default false) 306 | StripNick=false 307 | 308 | #Enable to show topic changes from other bridges 309 | #Only works hiding/show topic changes from slack bridge for now 310 | #OPTIONAL (default false) 311 | ShowTopicChange=false 312 | 313 | #Enable sending messages using a webhook instead of regular MUC messages. 314 | #Only works with a prosody server using mod_slack_webhook. Does not support editing. 315 | #OPTIONAL (default "") 316 | WebhookURL="https://yourdomain/prosody/msg/someid" 317 | 318 | ################################################################### 319 | #mattermost section 320 | ################################################################### 321 | [mattermost] 322 | #You can configure multiple servers "[mattermost.name]" or "[mattermost.name2]" 323 | #In this example we use [mattermost.work] 324 | #REQUIRED 325 | 326 | [mattermost.work] 327 | #The mattermost hostname. (do not prefix it with http or https) 328 | #REQUIRED (when not using webhooks) 329 | Server="yourmattermostserver.domain" 330 | 331 | #Your team on mattermost. 332 | #REQUIRED (when not using webhooks) 333 | Team="yourteam" 334 | 335 | #login/pass of your bot. 336 | #Use a dedicated user for this and not your own! 337 | #REQUIRED (when not using webhooks) 338 | Login="yourlogin" 339 | Password="yourpass" 340 | 341 | #personal access token of the bot. 342 | #new feature since mattermost 4.1. See https://docs.mattermost.com/developer/personal-access-tokens.html 343 | #OPTIONAL (you can use token instead of login/password) 344 | #Token="abcdefghijklm" 345 | 346 | #Enable this to make a http connection (instead of https) to your mattermost. 347 | #OPTIONAL (default false) 348 | NoTLS=false 349 | 350 | #### Settings for webhook matterbridge. 351 | #NOT RECOMMENDED TO USE INCOMING/OUTGOING WEBHOOK. USE DEDICATED BOT USER WHEN POSSIBLE! 352 | #You don't need to configure this, if you have configured the settings 353 | #above. 354 | 355 | #Url is your incoming webhook url as specified in mattermost. 356 | #See account settings - integrations - incoming webhooks on mattermost. 357 | #If specified, messages will be sent to mattermost using this URL 358 | #OPTIONAL 359 | WebhookURL="https://yourdomain/hooks/yourhookkey" 360 | 361 | #Address to listen on for outgoing webhook requests from mattermost. 362 | #See account settings - integrations - outgoing webhooks on mattermost. 363 | #If specified, messages will be received from mattermost on this ip:port 364 | #(this will only work if WebhookURL above is also configured) 365 | #OPTIONAL 366 | WebhookBindAddress="0.0.0.0:9999" 367 | 368 | #Icon that will be showed in mattermost. 369 | #This only works when WebhookURL is configured 370 | #OPTIONAL 371 | IconURL="http://youricon.png" 372 | 373 | #### End settings for webhook matterbridge. 374 | 375 | #Enable to not verify the certificate on your mattermost server. 376 | #e.g. when using selfsigned certificates 377 | #OPTIONAL (default false) 378 | SkipTLSVerify=true 379 | 380 | ## RELOADABLE SETTINGS 381 | ## Settings below can be reloaded by editing the file 382 | 383 | #how to format the list of IRC nicks when displayed in mattermost. 384 | #Possible options are "table" and "plain" 385 | #OPTIONAL (default plain) 386 | NickFormatter="plain" 387 | #How many nicks to list per row for formatters that support this. 388 | #OPTIONAL (default 4) 389 | NicksPerRow=4 390 | 391 | #Skip the Mattermost server version checks that are normally done when connecting. 392 | #The usage scenario for this feature would be when the Mattermost instance is hosted behind a 393 | #reverse proxy that suppresses "non-standard" response headers in flight. 394 | #OPTIONAL (default false) 395 | SkipVersionCheck=false 396 | 397 | #Whether to prefix messages from other bridges to mattermost with the sender's nick. 398 | #Useful if username overrides for incoming webhooks isn't enabled on the 399 | #mattermost server. If you set PrefixMessagesWithNick to true, each message 400 | #from bridge to Mattermost will by default be prefixed by "bridge-" + nick. You can, 401 | #however, modify how the messages appear, by setting (and modifying) RemoteNickFormat 402 | #OPTIONAL (default false) 403 | PrefixMessagesWithNick=false 404 | 405 | #Disable sending of edits to other bridges 406 | #OPTIONAL (default false) 407 | EditDisable=false 408 | 409 | #Message to be appended to every edited message 410 | #OPTIONAL (default empty) 411 | EditSuffix=" (edited)" 412 | 413 | #Nicks you want to ignore. 414 | #Regular expressions supported 415 | #Messages from those users will not be sent to other bridges. 416 | #OPTIONAL 417 | IgnoreNicks="ircspammer1 ircspammer2" 418 | 419 | #Messages you want to ignore. 420 | #Messages matching these regexp will be ignored and not sent to other bridges 421 | #See https://regex-golang.appspot.com/assets/html/index.html for more regex info 422 | #OPTIONAL (example below ignores messages starting with ~~ or messages containing badword 423 | IgnoreMessages="^~~ badword" 424 | 425 | #messages you want to replace. 426 | #it replaces outgoing messages from the bridge. 427 | #so you need to place it by the sending bridge definition. 428 | #regular expressions supported 429 | #some examples: 430 | #this replaces cat => dog and sleep => awake 431 | #replacemessages=[ ["cat","dog"], ["sleep","awake"] ] 432 | #this replaces every number with number. 123 => numbernumbernumber 433 | #replacemessages=[ ["[0-9]","number"] ] 434 | #optional (default empty) 435 | ReplaceMessages=[ ["cat","dog"] ] 436 | 437 | #nicks you want to replace. 438 | #see replacemessages for syntaxa 439 | #optional (default empty) 440 | ReplaceNicks=[ ["user--","user"] ] 441 | 442 | #Extractnicks is used to for example rewrite messages from other relaybots 443 | #See https://github.com/42wim/matterbridge/issues/713 and https://github.com/42wim/matterbridge/issues/466 444 | #some examples: 445 | #this replaces a message like "Relaybot: something interesting" to "relayeduser: something interesting" 446 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ] ] 447 | #you can use multiple entries for multiplebots 448 | #this also replaces a message like "otherbot: (relayeduser) something else" to "relayeduser: something else" 449 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ],[ "otherbot","\\((.*?)\\)\\s+" ] 450 | #OPTIONAL (default empty) 451 | ExtractNicks=[ ["otherbot","<(.*?)>\\s+" ] ] 452 | 453 | #extra label that can be used in the RemoteNickFormat 454 | #optional (default empty) 455 | Label="" 456 | 457 | #RemoteNickFormat defines how remote users appear on this bridge 458 | #See [general] config section for default options 459 | RemoteNickFormat="[{PROTOCOL}] <{NICK}> " 460 | 461 | #Enable to show users joins/parts from other bridges 462 | #Currently works for messages from the following bridges: irc, mattermost, slack, discord 463 | #OPTIONAL (default false) 464 | ShowJoinPart=false 465 | 466 | #Do not send joins/parts to other bridges 467 | #Currently works for messages from the following bridges: irc, mattermost, slack 468 | #OPTIONAL (default false) 469 | NoSendJoinPart=false 470 | 471 | #StripNick only allows alphanumerical nicks. See https://github.com/42wim/matterbridge/issues/285 472 | #It will strip other characters from the nick 473 | #OPTIONAL (default false) 474 | StripNick=false 475 | 476 | #Enable to show topic changes from other bridges 477 | #Only works hiding/show topic changes from slack bridge for now 478 | #OPTIONAL (default false) 479 | ShowTopicChange=false 480 | 481 | ################################################################### 482 | #Gitter section 483 | #Best to make a dedicated gitter account for the bot. 484 | ################################################################### 485 | 486 | [gitter] 487 | 488 | #You can configure multiple servers "[gitter.name]" or "[gitter.name2]" 489 | #In this example we use [gitter.myproject] 490 | #REQUIRED 491 | [gitter.myproject] 492 | #Token to connect with Gitter API 493 | #You can get your token by going to https://developer.gitter.im/docs/welcome and SIGN IN 494 | #REQUIRED 495 | Token="Yourtokenhere" 496 | 497 | ## RELOADABLE SETTINGS 498 | ## Settings below can be reloaded by editing the file 499 | 500 | #Nicks you want to ignore. 501 | #Regular expressions supported 502 | #Messages from those users will not be sent to other bridges. 503 | #OPTIONAL 504 | IgnoreNicks="ircspammer1 ircspammer2" 505 | 506 | #Messages you want to ignore. 507 | #Messages matching these regexp will be ignored and not sent to other bridges 508 | #See https://regex-golang.appspot.com/assets/html/index.html for more regex info 509 | #OPTIONAL (example below ignores messages starting with ~~ or messages containing badword 510 | IgnoreMessages="^~~ badword" 511 | 512 | #messages you want to replace. 513 | #it replaces outgoing messages from the bridge. 514 | #so you need to place it by the sending bridge definition. 515 | #regular expressions supported 516 | #some examples: 517 | #this replaces cat => dog and sleep => awake 518 | #replacemessages=[ ["cat","dog"], ["sleep","awake"] ] 519 | #this replaces every number with number. 123 => numbernumbernumber 520 | #replacemessages=[ ["[0-9]","number"] ] 521 | #optional (default empty) 522 | ReplaceMessages=[ ["cat","dog"] ] 523 | 524 | #nicks you want to replace. 525 | #see replacemessages for syntaxa 526 | #optional (default empty) 527 | ReplaceNicks=[ ["user--","user"] ] 528 | 529 | #Extractnicks is used to for example rewrite messages from other relaybots 530 | #See https://github.com/42wim/matterbridge/issues/713 and https://github.com/42wim/matterbridge/issues/466 531 | #some examples: 532 | #this replaces a message like "Relaybot: something interesting" to "relayeduser: something interesting" 533 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ] ] 534 | #you can use multiple entries for multiplebots 535 | #this also replaces a message like "otherbot: (relayeduser) something else" to "relayeduser: something else" 536 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ],[ "otherbot","\\((.*?)\\)\\s+" ] 537 | #OPTIONAL (default empty) 538 | ExtractNicks=[ ["otherbot","<(.*?)>\\s+" ] ] 539 | 540 | #extra label that can be used in the RemoteNickFormat 541 | #optional (default empty) 542 | Label="" 543 | 544 | #RemoteNickFormat defines how remote users appear on this bridge 545 | #See [general] config section for default options 546 | RemoteNickFormat="[{PROTOCOL}] <{NICK}> " 547 | 548 | #Enable to show users joins/parts from other bridges 549 | #Currently works for messages from the following bridges: irc, mattermost, slack, discord 550 | #OPTIONAL (default false) 551 | ShowJoinPart=false 552 | 553 | #StripNick only allows alphanumerical nicks. See https://github.com/42wim/matterbridge/issues/285 554 | #It will strip other characters from the nick 555 | #OPTIONAL (default false) 556 | StripNick=false 557 | 558 | #Enable to show topic changes from other bridges 559 | #Only works hiding/show topic changes from slack bridge for now 560 | #OPTIONAL (default false) 561 | ShowTopicChange=false 562 | 563 | ################################################################### 564 | # 565 | # Keybase 566 | # You should have a separate bridge account on Keybase 567 | # (it also needs to be logged in on the system you're running the bridge on) 568 | # 569 | ################################################################### 570 | 571 | [keybase.myteam] 572 | 573 | # RemoteNickFormat defines how remote users appear on this bridge 574 | # See [general] config section for default options 575 | RemoteNickFormat="{NICK} ({PROTOCOL}): " 576 | 577 | # extra label that can be used in the RemoteNickFormat 578 | # optional (default empty) 579 | Label="" 580 | 581 | # Your team on Keybase. 582 | # The bot user MUST be a member of this team 583 | # REQUIRED 584 | Team="myteam" 585 | 586 | ################################################################### 587 | # Microsoft teams section 588 | # See https://github.com/42wim/matterbridge/wiki/MS-Teams-setup 589 | ################################################################### 590 | 591 | [msteams.myteam] 592 | 593 | # TenantID 594 | # See https://github.com/42wim/matterbridge/wiki/MS-Teams-setup#get-necessary-ids-for-matterbridge 595 | TenantID="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" 596 | 597 | # ClientID 598 | # See https://github.com/42wim/matterbridge/wiki/MS-Teams-setup#get-necessary-ids-for-matterbridge 599 | ClientID="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" 600 | 601 | # TeamID 602 | # See https://github.com/42wim/matterbridge/wiki/MS-Teams-setup#get-necessary-ids-for-matterbridge 603 | TeamID="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" 604 | 605 | ## RELOADABLE SETTINGS 606 | ## Settings below can be reloaded by editing the file 607 | 608 | #Nicks you want to ignore. 609 | #Regular expressions supported 610 | #Messages from those users will not be sent to other bridges. 611 | #OPTIONAL 612 | IgnoreNicks="ircspammer1 ircspammer2" 613 | 614 | #Messages you want to ignore. 615 | #Messages matching these regexp will be ignored and not sent to other bridges 616 | #See https://regex-golang.appspot.com/assets/html/index.html for more regex info 617 | #OPTIONAL (example below ignores messages starting with ~~ or messages containing badword 618 | IgnoreMessages="^~~ badword" 619 | 620 | #messages you want to replace. 621 | #it replaces outgoing messages from the bridge. 622 | #so you need to place it by the sending bridge definition. 623 | #regular expressions supported 624 | #some examples: 625 | #this replaces cat => dog and sleep => awake 626 | #replacemessages=[ ["cat","dog"], ["sleep","awake"] ] 627 | #this replaces every number with number. 123 => numbernumbernumber 628 | #replacemessages=[ ["[0-9]","number"] ] 629 | #optional (default empty) 630 | ReplaceMessages=[ ["cat","dog"] ] 631 | 632 | #nicks you want to replace. 633 | #see replacemessages for syntaxa 634 | #optional (default empty) 635 | ReplaceNicks=[ ["user--","user"] ] 636 | 637 | #Extractnicks is used to for example rewrite messages from other relaybots 638 | #See https://github.com/42wim/matterbridge/issues/713 and https://github.com/42wim/matterbridge/issues/466 639 | #some examples: 640 | #this replaces a message like "Relaybot: something interesting" to "relayeduser: something interesting" 641 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ] ] 642 | #you can use multiple entries for multiplebots 643 | #this also replaces a message like "otherbot: (relayeduser) something else" to "relayeduser: something else" 644 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ],[ "otherbot","\\((.*?)\\)\\s+" ] 645 | #OPTIONAL (default empty) 646 | ExtractNicks=[ ["otherbot","<(.*?)>\\s+" ] ] 647 | 648 | #extra label that can be used in the RemoteNickFormat 649 | #optional (default empty) 650 | Label="" 651 | 652 | #RemoteNickFormat defines how remote users appear on this bridge 653 | #See [general] config section for default options 654 | RemoteNickFormat="[{PROTOCOL}] <{NICK}> " 655 | 656 | #Enable to show users joins/parts from other bridges 657 | #Currently works for messages from the following bridges: irc, mattermost, slack, discord 658 | #OPTIONAL (default false) 659 | ShowJoinPart=false 660 | 661 | #StripNick only allows alphanumerical nicks. See https://github.com/42wim/matterbridge/issues/285 662 | #It will strip other characters from the nick 663 | #OPTIONAL (default false) 664 | StripNick=false 665 | 666 | #Enable to show topic changes from other bridges 667 | #Only works hiding/show topic changes from slack bridge for now 668 | #OPTIONAL (default false) 669 | ShowTopicChange=false 670 | 671 | #Opportunistically preserve threaded replies between bridges 672 | #that support threading 673 | #OPTIONAL (default false) 674 | PreserveThreading=false 675 | 676 | ################################################################### 677 | #slack section 678 | ################################################################### 679 | [slack] 680 | 681 | #You can configure multiple servers "[slack.name]" or "[slack.name2]" 682 | #In this example we use [slack.hobby] 683 | #REQUIRED 684 | [slack.hobby] 685 | #Token to connect with the Slack API 686 | #You'll have to use a test/api-token using a dedicated user and not a bot token. 687 | #See https://github.com/42wim/matterbridge/issues/75 for more info. 688 | #Use https://api.slack.com/custom-integrations/legacy-tokens 689 | #REQUIRED (when not using webhooks) 690 | Token="yourslacktoken" 691 | 692 | #Extra slack specific debug info, warning this generates a lot of output. 693 | #OPTIONAL (default false) 694 | Debug="false" 695 | 696 | #### Settings for webhook matterbridge. 697 | #NOT RECOMMENDED TO USE INCOMING/OUTGOING WEBHOOK. USE SLACK API 698 | #AND DEDICATED BOT USER WHEN POSSIBLE! 699 | #Url is your incoming webhook url as specified in slack 700 | #See account settings - integrations - incoming webhooks on slack 701 | #OPTIONAL 702 | WebhookURL="https://hooks.slack.com/services/yourhook" 703 | 704 | #NOT RECOMMENDED TO USE INCOMING/OUTGOING WEBHOOK. USE SLACK API 705 | #AND DEDICATED BOT USER WHEN POSSIBLE! 706 | #Address to listen on for outgoing webhook requests from slack 707 | #See account settings - integrations - outgoing webhooks on slack 708 | #webhooks 709 | #OPTIONAL 710 | WebhookBindAddress="0.0.0.0:9999" 711 | 712 | #Icon that will be showed in slack 713 | #The string "{NICK}" (case sensitive) will be replaced by the actual nick / username. 714 | #The string "{BRIDGE}" (case sensitive) will be replaced by the sending bridge 715 | #The string "{LABEL}" (case sensitive) will be replaced by label= field of the sending bridge 716 | #The string "{PROTOCOL}" (case sensitive) will be replaced by the protocol used by the bridge 717 | #OPTIONAL 718 | IconURL="https://robohash.org/{NICK}.png?size=48x48" 719 | 720 | ## RELOADABLE SETTINGS 721 | ## Settings below can be reloaded by editing the file 722 | 723 | #how to format the list of IRC nicks when displayed in slack 724 | #Possible options are "table" and "plain" 725 | #OPTIONAL (default plain) 726 | NickFormatter="plain" 727 | #How many nicks to list per row for formatters that support this. 728 | #OPTIONAL (default 4) 729 | NicksPerRow=4 730 | 731 | #Disable sending of edits to other bridges 732 | #OPTIONAL (default false) 733 | EditDisable=true 734 | 735 | #Message to be appended to every edited message 736 | #OPTIONAL (default empty) 737 | EditSuffix=" (edited)" 738 | 739 | #Whether to prefix messages from other bridges to mattermost with RemoteNickFormat 740 | #Useful if username overrides for incoming webhooks isn't enabled on the 741 | #slack server. If you set PrefixMessagesWithNick to true, each message 742 | #from bridge to Slack will by default be prefixed by "bridge-" + nick. You can, 743 | #however, modify how the messages appear, by setting (and modifying) RemoteNickFormat 744 | #OPTIONAL (default false) 745 | PrefixMessagesWithNick=false 746 | 747 | #Nicks you want to ignore. 748 | #Regular expressions supported 749 | #Messages from those users will not be sent to other bridges. 750 | #OPTIONAL 751 | IgnoreNicks="ircspammer1 ircspammer2" 752 | 753 | #Messages you want to ignore. 754 | #Messages matching these regexp will be ignored and not sent to other bridges 755 | #See https://regex-golang.appspot.com/assets/html/index.html for more regex info 756 | #OPTIONAL (example below ignores messages starting with ~~ or messages containing badword 757 | IgnoreMessages="^~~ badword" 758 | 759 | #messages you want to replace. 760 | #it replaces outgoing messages from the bridge. 761 | #so you need to place it by the sending bridge definition. 762 | #regular expressions supported 763 | #some examples: 764 | #this replaces cat => dog and sleep => awake 765 | #replacemessages=[ ["cat","dog"], ["sleep","awake"] ] 766 | #this replaces every number with number. 123 => numbernumbernumber 767 | #replacemessages=[ ["[0-9]","number"] ] 768 | #optional (default empty) 769 | ReplaceMessages=[ ["cat","dog"] ] 770 | 771 | #nicks you want to replace. 772 | #see replacemessages for syntaxa 773 | #optional (default empty) 774 | ReplaceNicks=[ ["user--","user"] ] 775 | 776 | #Extractnicks is used to for example rewrite messages from other relaybots 777 | #See https://github.com/42wim/matterbridge/issues/713 and https://github.com/42wim/matterbridge/issues/466 778 | #some examples: 779 | #this replaces a message like "Relaybot: something interesting" to "relayeduser: something interesting" 780 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ] ] 781 | #you can use multiple entries for multiplebots 782 | #this also replaces a message like "otherbot: (relayeduser) something else" to "relayeduser: something else" 783 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ],[ "otherbot","\\((.*?)\\)\\s+" ] 784 | #OPTIONAL (default empty) 785 | ExtractNicks=[ ["otherbot","<(.*?)>\\s+" ] ] 786 | 787 | #extra label that can be used in the RemoteNickFormat 788 | #optional (default empty) 789 | Label="" 790 | 791 | #RemoteNickFormat defines how remote users appear on this bridge 792 | #See [general] config section for default options 793 | RemoteNickFormat="[{PROTOCOL}] <{NICK}> " 794 | 795 | #Enable to show users joins/parts from other bridges 796 | #Currently works for messages from the following bridges: irc, mattermost, slack, discord 797 | #OPTIONAL (default false) 798 | ShowJoinPart=false 799 | 800 | #Do not send joins/parts to other bridges 801 | #Currently works for messages from the following bridges: irc, mattermost, slack 802 | #OPTIONAL (default false) 803 | NoSendJoinPart=false 804 | 805 | #StripNick only allows alphanumerical nicks. See https://github.com/42wim/matterbridge/issues/285 806 | #It will strip other characters from the nick 807 | #OPTIONAL (default false) 808 | StripNick=false 809 | 810 | #Enable to show topic changes from other bridges 811 | #Only works hiding/show topic changes from slack bridge for now 812 | #OPTIONAL (default false) 813 | ShowTopicChange=false 814 | 815 | #Opportunistically preserve threaded replies between Slack channels. 816 | #This only works if the parent message is still in the cache. 817 | #Cache is flushed between restarts. 818 | #Note: Not currently working on gateways with mixed bridges of 819 | # both slack and slack-legacy type. Context in issue #624. 820 | #OPTIONAL (default false) 821 | PreserveThreading=false 822 | 823 | #Enable showing "user_typing" events from across gateway when available. 824 | #Protip: Set your bot/user's "Full Name" to be "Someone (over chat bridge)", 825 | #and so the message will say "Someone (over chat bridge) is typing". 826 | #OPTIONAL (default false) 827 | ShowUserTyping=false 828 | 829 | ################################################################### 830 | #discord section 831 | ################################################################### 832 | [discord] 833 | 834 | # You can configure multiple servers "[discord.name]" or "[discord.name2]" 835 | # In this example we use [discord.game] 836 | #REQUIRED 837 | [discord.game] 838 | # Token (REQUIRED) is the token to connect with Discord API 839 | # You can get your token by following the instructions on 840 | # https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token 841 | # 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. 842 | Token="Yourtokenhere" 843 | 844 | # Server (REQUIRED) is the ID or name of the guild to connect to, selected from the guilds the bot has been invited to 845 | Server="yourservername" 846 | 847 | ## RELOADABLE SETTINGS 848 | ## All settings below can be reloaded by editing the file. 849 | ## They are also all optional. 850 | 851 | # ShowEmbeds shows the title, description and URL of embedded messages (sent by other bots) 852 | ShowEmbeds=false 853 | 854 | # UseLocalAvatar specifies source bridges for which an avatar should be 'guessed' when an incoming message has no avatar. 855 | # This works by comparing the username of the message to an existing Discord user, and using the avatar of the Discord user. 856 | # 857 | # This only works if WebhookURL is set (AND the message has no avatar). 858 | # Example: ["irc"] 859 | UseLocalAvatar=[] 860 | 861 | # UseUserName shows the username instead of the server nickname 862 | UseUserName=false 863 | 864 | # UseDiscriminator appends the `#xxxx` discriminator when used with UseUserName 865 | UseDiscriminator=false 866 | 867 | # AutoWebhooks automatically configures message sending in the style of puppets. 868 | # This is an easier alternative to manually configuring "WebhookURL" for each gateway, 869 | # as turning this on will automatically load or create webhooks for each channel. 870 | # This feature requires the "Manage Webhooks" permission (either globally or as per-channel). 871 | AutoWebhooks=false 872 | 873 | # EditDisable disables sending of edits to other bridges 874 | EditDisable=false 875 | 876 | # EditSuffix specifies the message to be appended to every edited message 877 | # Example: " (edited)" 878 | EditSuffix="" 879 | 880 | # IgnoreNicks mutes outgoing messages from certain users. 881 | # Messages from these users will not be transmitted to other bridges. 882 | # Regular expressions are also supported. 883 | # Example: "ircspammer1 ircspammer2" 884 | IgnoreNicks="" 885 | 886 | # IgnoreMessages mutes outgoing messages of a certain format. 887 | # Messages matching this regular expression will not be transmitted sent to other bridges 888 | # See https://regex-golang.appspot.com/assets/html/index.html for more regex info 889 | # 890 | # Example that ignores messages starting with ~~ or messages containing badword: 891 | # IgnoreMessages="^~~ badword" 892 | IgnoreMessages="" 893 | 894 | # ReplaceMessages replaces substrings of messages in outgoing messages. 895 | # Regular expressions are supported. 896 | # 897 | # Example that replaces 'cat' => 'dog' and 'sleep' => 'awake': 898 | # ReplaceMessages=[ ["cat","dog"], ["sleep","awake"] ] 899 | # Example that replaces all digits with the letter 'X', so 'hello123' becomes 'helloXXX': 900 | # ReplaceMessages=[ ["[0-9]","X"] ] 901 | ReplaceMessages=[] 902 | 903 | # ReplaceNicks replaces substrings of usernames in outgoing messages. 904 | # See the ReplaceMessages setting for examples. 905 | # Example: [ ["user--","user"] ] 906 | ReplaceNicks=[] 907 | 908 | # ExtractNicks allows for interoperability with other bridge software by rewriting messages and extracting usernames. 909 | # 910 | # Recommended reading: 911 | # - https://github.com/42wim/matterbridge/issues/466 912 | # - https://github.com/42wim/matterbridge/issues/713 913 | # 914 | # This example translates the following message 915 | # "Relaybot: something interesting" 916 | # into this message 917 | # "relayeduser: something interesting" 918 | # like so: 919 | # ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ] ] 920 | # 921 | # This example translates the following message 922 | # "otherbot: (relayeduser) something else" 923 | # into this message 924 | # "relayeduser: something else" 925 | # like so: 926 | # ExtractNicks=[ [ "otherbot","\\((.*?)\\)\\s+" ] ] 927 | # 928 | # This example combines both of the above examples into one: 929 | # ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ],[ "otherbot","\\((.*?)\\)\\s+" ] 930 | # 931 | ExtractNicks=[] 932 | 933 | # Label is as an extra identifier for use in the RemoteNickFormat setting. 934 | Label="" 935 | 936 | # RemoteNickFormat formats how remote users appear on this bridge. 937 | # See the [general] config section for default options 938 | RemoteNickFormat="[{PROTOCOL}] <{NICK}> " 939 | 940 | # ShowJoinPart emits messages that show joins/parts from other bridges 941 | # Supported from the following bridges: irc, mattermost, slack, discord 942 | ShowJoinPart=false 943 | 944 | # StripNick strips non-alphanumeric characters from nicknames. 945 | # Recommended reading: https://github.com/42wim/matterbridge/issues/285 946 | StripNick=false 947 | 948 | # ShowTopicChange emits messages that show topic/purpose updates from other bridges 949 | # Supported from the following bridges: slack 950 | ShowTopicChange=false 951 | 952 | # SyncTopic synchronises topic/purpose updates from other bridges 953 | # Supported from the following bridges: slack 954 | SyncTopic=false 955 | 956 | ################################################################### 957 | #telegram section 958 | ################################################################### 959 | [telegram] 960 | 961 | #You can configure multiple servers "[telegram.name]" or "[telegram.name2]" 962 | #In this example we use [telegram.secure] 963 | #REQUIRED 964 | [telegram.secure] 965 | #Token to connect with telegram API 966 | #See https://core.telegram.org/bots#6-botfather and https://www.linkedin.com/pulse/telegram-bots-beginners-marco-frau 967 | #REQUIRED 968 | Token="Yourtokenhere" 969 | 970 | ## RELOADABLE SETTINGS 971 | ## Settings below can be reloaded by editing the file 972 | 973 | #OPTIONAL (default empty) 974 | #Supported formats are: 975 | #"HTML" https://core.telegram.org/bots/api#html-style 976 | #"Markdown" https://core.telegram.org/bots/api#markdown-style - deprecated, doesn't display links with underscores correctly 977 | #"MarkdownV2" https://core.telegram.org/bots/api#markdownv2-style 978 | #"HTMLNick" - only allows HTML for the nick, the message itself will be html-escaped 979 | MessageFormat="" 980 | 981 | #OPTIONAL (default false) 982 | #Disables link previews for links in messages 983 | DisableWebPagePreview=false 984 | 985 | #If enabled use the "First Name" as username. If this is empty use the Username 986 | #If disabled use the "Username" as username. If this is empty use the First Name 987 | #If all names are empty, username will be "unknown" 988 | #OPTIONAL (default false) 989 | UseFirstName=false 990 | 991 | #WARNING! If enabled this will relay GIF/stickers/documents and other attachments as URLs 992 | #Those URLs will contain your bot-token. This may not be what you want. 993 | #For now there is no secure way to relay GIF/stickers/documents without seeing your token. 994 | #OPTIONAL (default false) 995 | UseInsecureURL=false 996 | 997 | #Disable quoted/reply messages 998 | #OPTIONAL (default false) 999 | QuoteDisable=false 1000 | 1001 | #Set the max. quoted length if 0 the whole message will be quoted 1002 | #OPTIONAL (default 0) 1003 | QuoteLengthLimit=0 1004 | 1005 | #Format quoted/reply messages 1006 | #OPTIONAL (default "{MESSAGE} (re @{QUOTENICK}: {QUOTEMESSAGE})") 1007 | QuoteFormat="{MESSAGE} (re @{QUOTENICK}: {QUOTEMESSAGE})" 1008 | 1009 | #Convert WebP images to PNG before upload. 1010 | #https://github.com/42wim/matterbridge/issues/398 1011 | #OPTIONAL (default false) 1012 | MediaConvertWebPToPNG=false 1013 | 1014 | #Disable sending of edits to other bridges 1015 | #OPTIONAL (default false) 1016 | EditDisable=false 1017 | 1018 | #Message to be appended to every edited message 1019 | #OPTIONAL (default empty) 1020 | EditSuffix=" (edited)" 1021 | 1022 | #Nicks you want to ignore. 1023 | #Regular expressions supported 1024 | #Messages from those users will not be sent to other bridges. 1025 | #OPTIONAL 1026 | IgnoreNicks="spammer1 spammer2" 1027 | 1028 | #Messages you want to ignore. 1029 | #Messages matching these regexp will be ignored and not sent to other bridges 1030 | #See https://regex-golang.appspot.com/assets/html/index.html for more regex info 1031 | #OPTIONAL (example below ignores messages starting with ~~ or messages containing badword 1032 | IgnoreMessages="^~~ badword" 1033 | 1034 | #messages you want to replace. 1035 | #it replaces outgoing messages from the bridge. 1036 | #so you need to place it by the sending bridge definition. 1037 | #regular expressions supported 1038 | #some examples: 1039 | #this replaces cat => dog and sleep => awake 1040 | #replacemessages=[ ["cat","dog"], ["sleep","awake"] ] 1041 | #this replaces every number with number. 123 => numbernumbernumber 1042 | #replacemessages=[ ["[0-9]","number"] ] 1043 | #optional (default empty) 1044 | ReplaceMessages=[ ["cat","dog"] ] 1045 | 1046 | #nicks you want to replace. 1047 | #see replacemessages for syntaxa 1048 | #optional (default empty) 1049 | ReplaceNicks=[ ["user--","user"] ] 1050 | 1051 | #Extractnicks is used to for example rewrite messages from other relaybots 1052 | #See https://github.com/42wim/matterbridge/issues/713 and https://github.com/42wim/matterbridge/issues/466 1053 | #some examples: 1054 | #this replaces a message like "Relaybot: something interesting" to "relayeduser: something interesting" 1055 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ] ] 1056 | #you can use multiple entries for multiplebots 1057 | #this also replaces a message like "otherbot: (relayeduser) something else" to "relayeduser: something else" 1058 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ],[ "otherbot","\\((.*?)\\)\\s+" ] 1059 | #OPTIONAL (default empty) 1060 | ExtractNicks=[ ["otherbot","<(.*?)>\\s+" ] ] 1061 | 1062 | #extra label that can be used in the RemoteNickFormat 1063 | #optional (default empty) 1064 | Label="" 1065 | 1066 | #RemoteNickFormat defines how remote users appear on this bridge 1067 | #See [general] config section for default options 1068 | # 1069 | #WARNING: if you have set MessageFormat="HTML" be sure that this format matches the guidelines 1070 | #on https://core.telegram.org/bots/api#html-style otherwise the message will not go through to 1071 | #telegram! eg <{NICK}> should be <{NICK}> 1072 | RemoteNickFormat="[{PROTOCOL}] <{NICK}> " 1073 | 1074 | #Enable to show users joins/parts from other bridges 1075 | #Currently works for messages from the following bridges: irc, mattermost, slack, discord 1076 | #OPTIONAL (default false) 1077 | ShowJoinPart=false 1078 | 1079 | #StripNick only allows alphanumerical nicks. See https://github.com/42wim/matterbridge/issues/285 1080 | #It will strip other characters from the nick 1081 | #OPTIONAL (default false) 1082 | StripNick=false 1083 | 1084 | #Enable to show topic changes from other bridges 1085 | #Only works hiding/show topic changes from slack bridge for now 1086 | #OPTIONAL (default false) 1087 | ShowTopicChange=false 1088 | 1089 | ################################################################### 1090 | #rocketchat section 1091 | ################################################################### 1092 | [rocketchat] 1093 | #You can configure multiple servers "[rocketchat.name]" or "[rocketchat.name2]" 1094 | #In this example we use [rocketchat.work] 1095 | #REQUIRED 1096 | 1097 | [rocketchat.rockme] 1098 | #The rocketchat hostname. (prefix it with http or https) 1099 | #REQUIRED (when not using webhooks) 1100 | Server="https://yourrocketchatserver.domain.com:443" 1101 | 1102 | #login/pass of your bot. 1103 | #login needs to be the login with email address! user@domain.com 1104 | #Use a dedicated user for this and not your own! 1105 | #REQUIRED (when not using webhooks) 1106 | Login="yourlogin@domain.com" 1107 | Password="yourpass" 1108 | # When using access token set Login to the User ID associated with your token and Token to your token. 1109 | # When Token is set Password is ignored. 1110 | # Login="yOurUSerID" 1111 | # Token="YoUrUsER_toKEN" 1112 | 1113 | 1114 | #### Settings for webhook matterbridge. 1115 | #USE DEDICATED BOT USER WHEN POSSIBLE! This allows you to use advanced features like message editing/deleting and uploads 1116 | #You don't need to configure this, if you have configured the settings 1117 | #above. 1118 | 1119 | #Url is your incoming webhook url as specified in rocketchat 1120 | #Read #https://rocket.chat/docs/administrator-guides/integrations/#how-to-create-a-new-incoming-webhook 1121 | #See administration - integrations - new integration - incoming webhook 1122 | #REQUIRED 1123 | WebhookURL="https://yourdomain/hooks/yourhookkey" 1124 | 1125 | #Address to listen on for outgoing webhook requests from rocketchat. 1126 | #See administration - integrations - new integration - outgoing webhook 1127 | #REQUIRED 1128 | WebhookBindAddress="0.0.0.0:9999" 1129 | 1130 | #Your nick/username as specified in your incoming webhook "Post as" setting 1131 | #REQUIRED 1132 | Nick="matterbot" 1133 | 1134 | #Enable this to make a http connection (instead of https) to your rocketchat 1135 | #OPTIONAL (default false) 1136 | NoTLS=false 1137 | 1138 | #Enable to not verify the certificate on your rocketchat server. 1139 | #e.g. when using selfsigned certificates 1140 | #OPTIONAL (default false) 1141 | SkipTLSVerify=true 1142 | 1143 | #### End settings for webhook matterbridge. 1144 | 1145 | ## RELOADABLE SETTINGS 1146 | ## Settings below can be reloaded by editing the file 1147 | 1148 | #Whether to prefix messages from other bridges to rocketchat with the sender's nick. 1149 | #Useful if username overrides for incoming webhooks isn't enabled on the 1150 | #rocketchat server. If you set PrefixMessagesWithNick to true, each message 1151 | #from bridge to rocketchat will by default be prefixed by the RemoteNickFormat setting. i 1152 | #if you're using login/pass you can better enable because of this bug: 1153 | #https://github.com/RocketChat/Rocket.Chat/issues/7549 1154 | #OPTIONAL (default false) 1155 | PrefixMessagesWithNick=false 1156 | 1157 | #Nicks you want to ignore. 1158 | #Regular expressions supported 1159 | #Messages from those users will not be sent to other bridges. 1160 | #OPTIONAL 1161 | IgnoreNicks="ircspammer1 ircspammer2" 1162 | 1163 | #Messages you want to ignore. 1164 | #Messages matching these regexp will be ignored and not sent to other bridges 1165 | #See https://regex-golang.appspot.com/assets/html/index.html for more regex info 1166 | #OPTIONAL (example below ignores messages starting with ~~ or messages containing badword 1167 | IgnoreMessages="^~~ badword" 1168 | 1169 | #messages you want to replace. 1170 | #it replaces outgoing messages from the bridge. 1171 | #so you need to place it by the sending bridge definition. 1172 | #regular expressions supported 1173 | #some examples: 1174 | #this replaces cat => dog and sleep => awake 1175 | #replacemessages=[ ["cat","dog"], ["sleep","awake"] ] 1176 | #this replaces every number with number. 123 => numbernumbernumber 1177 | #replacemessages=[ ["[0-9]","number"] ] 1178 | #optional (default empty) 1179 | ReplaceMessages=[ ["cat","dog"] ] 1180 | 1181 | #nicks you want to replace. 1182 | #see replacemessages for syntaxa 1183 | #optional (default empty) 1184 | ReplaceNicks=[ ["user--","user"] ] 1185 | 1186 | #Extractnicks is used to for example rewrite messages from other relaybots 1187 | #See https://github.com/42wim/matterbridge/issues/713 and https://github.com/42wim/matterbridge/issues/466 1188 | #some examples: 1189 | #this replaces a message like "Relaybot: something interesting" to "relayeduser: something interesting" 1190 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ] ] 1191 | #you can use multiple entries for multiplebots 1192 | #this also replaces a message like "otherbot: (relayeduser) something else" to "relayeduser: something else" 1193 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ],[ "otherbot","\\((.*?)\\)\\s+" ] 1194 | #OPTIONAL (default empty) 1195 | ExtractNicks=[ ["otherbot","<(.*?)>\\s+" ] ] 1196 | 1197 | #extra label that can be used in the RemoteNickFormat 1198 | #optional (default empty) 1199 | Label="" 1200 | 1201 | #RemoteNickFormat defines how remote users appear on this bridge 1202 | #See [general] config section for default options 1203 | RemoteNickFormat="[{PROTOCOL}] <{NICK}> " 1204 | 1205 | #Enable to show users joins/parts from other bridges 1206 | #Currently works for messages from the following bridges: irc, mattermost, slack, discord 1207 | #OPTIONAL (default false) 1208 | ShowJoinPart=false 1209 | 1210 | #StripNick only allows alphanumerical nicks. See https://github.com/42wim/matterbridge/issues/285 1211 | #It will strip other characters from the nick 1212 | #OPTIONAL (default false) 1213 | StripNick=false 1214 | 1215 | #Enable to show topic changes from other bridges 1216 | #Only works hiding/show topic changes from slack bridge for now 1217 | #OPTIONAL (default false) 1218 | ShowTopicChange=false 1219 | 1220 | ################################################################### 1221 | #matrix section 1222 | ################################################################### 1223 | [matrix] 1224 | #You can configure multiple servers "[matrix.name]" or "[matrix.name2]" 1225 | #In this example we use [matrix.neo] 1226 | #REQUIRED 1227 | 1228 | [matrix.neo] 1229 | #Server is your homeserver (eg https://matrix.org) 1230 | #REQUIRED 1231 | Server="https://matrix.org" 1232 | 1233 | #login/pass of your bot. 1234 | #Use a dedicated user for this and not your own! 1235 | #Messages sent from this user will not be relayed to avoid loops. 1236 | #REQUIRED 1237 | Login="yourlogin" 1238 | Password="yourpass" 1239 | 1240 | #Whether to send the homeserver suffix. eg ":matrix.org" in @username:matrix.org 1241 | #to other bridges, or only send "username".(true only sends username) 1242 | #OPTIONAL (default false) 1243 | NoHomeServerSuffix=false 1244 | 1245 | #Whether to disable sending of HTML content to matrix 1246 | #See https://github.com/42wim/matterbridge/issues/1022 1247 | #OPTIONAL (default false) 1248 | HTMLDisable=false 1249 | 1250 | ## RELOADABLE SETTINGS 1251 | ## Settings below can be reloaded by editing the file 1252 | 1253 | # UseUserName shows the username instead of the server nickname 1254 | UseUserName=false 1255 | 1256 | #Whether to prefix messages from other bridges to matrix with the sender's nick. 1257 | #Useful if username overrides for incoming webhooks isn't enabled on the 1258 | #matrix server. If you set PrefixMessagesWithNick to true, each message 1259 | #from bridge to matrix will by default be prefixed by the RemoteNickFormat setting. i 1260 | #OPTIONAL (default false) 1261 | PrefixMessagesWithNick=false 1262 | 1263 | #Nicks you want to ignore. 1264 | #Regular expressions supported 1265 | #Messages from those users will not be sent to other bridges. 1266 | #OPTIONAL 1267 | IgnoreNicks="spammer1 spammer2" 1268 | 1269 | #Messages you want to ignore. 1270 | #Messages matching these regexp will be ignored and not sent to other bridges 1271 | #See https://regex-golang.appspot.com/assets/html/index.html for more regex info 1272 | #OPTIONAL (example below ignores messages starting with ~~ or messages containing badword 1273 | IgnoreMessages="^~~ badword" 1274 | 1275 | #messages you want to replace. 1276 | #it replaces outgoing messages from the bridge. 1277 | #so you need to place it by the sending bridge definition. 1278 | #regular expressions supported 1279 | #some examples: 1280 | #this replaces cat => dog and sleep => awake 1281 | #replacemessages=[ ["cat","dog"], ["sleep","awake"] ] 1282 | #this replaces every number with number. 123 => numbernumbernumber 1283 | #replacemessages=[ ["[0-9]","number"] ] 1284 | #optional (default empty) 1285 | ReplaceMessages=[ ["cat","dog"] ] 1286 | 1287 | #nicks you want to replace. 1288 | #see replacemessages for syntaxa 1289 | #optional (default empty) 1290 | ReplaceNicks=[ ["user--","user"] ] 1291 | 1292 | #Extractnicks is used to for example rewrite messages from other relaybots 1293 | #See https://github.com/42wim/matterbridge/issues/713 and https://github.com/42wim/matterbridge/issues/466 1294 | #some examples: 1295 | #this replaces a message like "Relaybot: something interesting" to "relayeduser: something interesting" 1296 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ] ] 1297 | #you can use multiple entries for multiplebots 1298 | #this also replaces a message like "otherbot: (relayeduser) something else" to "relayeduser: something else" 1299 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ],[ "otherbot","\\((.*?)\\)\\s+" ] 1300 | #OPTIONAL (default empty) 1301 | ExtractNicks=[ ["otherbot","<(.*?)>\\s+" ] ] 1302 | 1303 | #extra label that can be used in the RemoteNickFormat 1304 | #optional (default empty) 1305 | Label="" 1306 | 1307 | #RemoteNickFormat defines how remote users appear on this bridge 1308 | #See [general] config section for default options 1309 | RemoteNickFormat="[{PROTOCOL}] <{NICK}> " 1310 | 1311 | #Enable to show users joins/parts from other bridges 1312 | #Currently works for messages from the following bridges: irc, mattermost, slack, discord 1313 | #OPTIONAL (default false) 1314 | ShowJoinPart=false 1315 | 1316 | #StripNick only allows alphanumerical nicks. See https://github.com/42wim/matterbridge/issues/285 1317 | #It will strip other characters from the nick 1318 | #OPTIONAL (default false) 1319 | StripNick=false 1320 | 1321 | #Enable to show topic changes from other bridges 1322 | #Only works hiding/show topic changes from slack bridge for now 1323 | #OPTIONAL (default false) 1324 | ShowTopicChange=false 1325 | 1326 | ################################################################### 1327 | #steam section 1328 | ################################################################### 1329 | [steam] 1330 | #You can configure multiple servers "[steam.name]" or "[steam.name2]" 1331 | #In this example we use [steam.gamechat] 1332 | #REQUIRED 1333 | 1334 | [steam.gamechat] 1335 | #login/pass of your bot. 1336 | #Use a dedicated user for this and not your own account! 1337 | #REQUIRED 1338 | Login="yourlogin" 1339 | Password="yourpass" 1340 | 1341 | #steamguard mail authcode (not the 2FA code) 1342 | #OPTIONAL 1343 | Authcode="ABCE12" 1344 | 1345 | ## RELOADABLE SETTINGS 1346 | ## Settings below can be reloaded by editing the file 1347 | 1348 | #Whether to prefix messages from other bridges to matrix with the sender's nick. 1349 | #Useful if username overrides for incoming webhooks isn't enabled on the 1350 | #matrix server. If you set PrefixMessagesWithNick to true, each message 1351 | #from bridge to matrix will by default be prefixed by the RemoteNickFormat setting. i 1352 | #OPTIONAL (default false) 1353 | PrefixMessagesWithNick=false 1354 | 1355 | #Nicks you want to ignore. 1356 | #Regular expressions supported 1357 | #Messages from those users will not be sent to other bridges. 1358 | #OPTIONAL 1359 | IgnoreNicks="spammer1 spammer2" 1360 | 1361 | #Messages you want to ignore. 1362 | #Messages matching these regexp will be ignored and not sent to other bridges 1363 | #See https://regex-golang.appspot.com/assets/html/index.html for more regex info 1364 | #OPTIONAL (example below ignores messages starting with ~~ or messages containing badword 1365 | IgnoreMessages="^~~ badword" 1366 | 1367 | #messages you want to replace. 1368 | #it replaces outgoing messages from the bridge. 1369 | #so you need to place it by the sending bridge definition. 1370 | #regular expressions supported 1371 | #some examples: 1372 | #this replaces cat => dog and sleep => awake 1373 | #replacemessages=[ ["cat","dog"], ["sleep","awake"] ] 1374 | #this replaces every number with number. 123 => numbernumbernumber 1375 | #replacemessages=[ ["[0-9]","number"] ] 1376 | #optional (default empty) 1377 | ReplaceMessages=[ ["cat","dog"] ] 1378 | 1379 | #nicks you want to replace. 1380 | #see replacemessages for syntaxa 1381 | #optional (default empty) 1382 | ReplaceNicks=[ ["user--","user"] ] 1383 | 1384 | #Extractnicks is used to for example rewrite messages from other relaybots 1385 | #See https://github.com/42wim/matterbridge/issues/713 and https://github.com/42wim/matterbridge/issues/466 1386 | #some examples: 1387 | #this replaces a message like "Relaybot: something interesting" to "relayeduser: something interesting" 1388 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ] ] 1389 | #you can use multiple entries for multiplebots 1390 | #this also replaces a message like "otherbot: (relayeduser) something else" to "relayeduser: something else" 1391 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ],[ "otherbot","\\((.*?)\\)\\s+" ] 1392 | #OPTIONAL (default empty) 1393 | ExtractNicks=[ ["otherbot","<(.*?)>\\s+" ] ] 1394 | 1395 | #extra label that can be used in the RemoteNickFormat 1396 | #optional (default empty) 1397 | Label="" 1398 | 1399 | #RemoteNickFormat defines how remote users appear on this bridge 1400 | #See [general] config section for default options 1401 | RemoteNickFormat="[{PROTOCOL}] <{NICK}> " 1402 | 1403 | #Enable to show users joins/parts from other bridges 1404 | #Currently works for messages from the following bridges: irc, mattermost, slack, discord 1405 | #OPTIONAL (default false) 1406 | ShowJoinPart=false 1407 | 1408 | #StripNick only allows alphanumerical nicks. See https://github.com/42wim/matterbridge/issues/285 1409 | #It will strip other characters from the nick 1410 | #OPTIONAL (default false) 1411 | StripNick=false 1412 | 1413 | #Enable to show topic changes from other bridges 1414 | #Only works hiding/show topic changes from slack bridge for now 1415 | #OPTIONAL (default false) 1416 | ShowTopicChange=false 1417 | 1418 | ################################################################### 1419 | # 1420 | # NCTalk (Nextcloud Talk) 1421 | # 1422 | ################################################################### 1423 | 1424 | [nctalk.bridge] 1425 | 1426 | # Url of your Nextcloud server 1427 | Server = "https://cloud.youdomain.me" 1428 | 1429 | # Enable to not verify the certificate on your Nextcloud server. 1430 | # e.g. when using selfsigned certificates 1431 | # OPTIONAL (default false) 1432 | SkipTLSVerify=true 1433 | 1434 | # Username of the bot 1435 | Login = "talkuser" 1436 | 1437 | # Password of the bot 1438 | Password = "talkuserpass" 1439 | 1440 | # Suffix for Guest Users 1441 | GuestSuffix = " (Guest)" 1442 | 1443 | ################################################################### 1444 | # 1445 | # Mumble 1446 | # 1447 | ################################################################### 1448 | 1449 | [mumble.bridge] 1450 | 1451 | # Host and port of your Mumble server 1452 | Server = "mumble.yourdomain.me:64738" 1453 | 1454 | # Nickname to log in as 1455 | Nick = "matterbridge" 1456 | 1457 | # Some servers require a password 1458 | # OPTIONAL (default empty) 1459 | Password = "serverpasswordhere" 1460 | 1461 | # User comment to set on the Mumble user, visible to other users. 1462 | # OPTIONAL (default empty) 1463 | UserComment="I am bridging text messages between this channel and #general on irc.yourdomain.me" 1464 | 1465 | # Self-signed TLS client certificate + private key used to connect to 1466 | # Mumble. This is required if you want to register the matterbridge 1467 | # user on your Mumble server, so its nick becomes reserved. 1468 | # You can generate a keypair using e.g. 1469 | # 1470 | # openssl req -x509 -newkey rsa:2048 -nodes -days 10000 \ 1471 | # -keyout mumble.key -out mumble.crt 1472 | # 1473 | # To actually register the matterbridege user, connect to Mumble as an 1474 | # admin, right click on the user and click "Register". 1475 | # 1476 | # OPTIONAL (default empty) 1477 | TLSClientCertificate="mumble.crt" 1478 | TLSClientKey="mumble.key" 1479 | 1480 | # TLS CA certificate used to validate the Mumble server. 1481 | # OPTIONAL (defaults to Go system CA) 1482 | TLSCACertificate="mumble-ca.crt" 1483 | 1484 | # Enable to not verify the certificate on your Mumble server. 1485 | # e.g. when using selfsigned certificates 1486 | # OPTIONAL (default false) 1487 | SkipTLSVerify=false 1488 | 1489 | ################################################################### 1490 | # 1491 | # WhatsApp 1492 | # 1493 | ################################################################### 1494 | 1495 | [whatsapp.bridge] 1496 | 1497 | # Number you will use as a relay bot. Tip: Get some disposable sim card, don't rely on your own number. 1498 | Number="+48111222333" 1499 | 1500 | # First time that you login you will need to scan QR code, then credentials willl be saved in a session file 1501 | # If you won't set SessionFile then you will need to scan QR code on every restart 1502 | # optional (by default the session is stored only in memory, till restarting matterbridge) 1503 | SessionFile="session-48111222333.gob" 1504 | 1505 | # If your terminal is white we need to invert QR code in order for it to be scanned properly 1506 | # optional (default false) 1507 | QrOnWhiteTerminal=true 1508 | 1509 | # Messages will be seen by other WhatsApp contacts as coming from the bridge. Original nick will be part of the message. 1510 | RemoteNickFormat="@{NICK}: " 1511 | 1512 | # extra label that can be used in the RemoteNickFormat 1513 | # optional (default empty) 1514 | Label="Organization" 1515 | 1516 | 1517 | 1518 | ################################################################### 1519 | # 1520 | # zulip 1521 | # 1522 | ################################################################### 1523 | 1524 | [zulip] 1525 | 1526 | #You can configure multiple servers "[zulip.name]" or "[zulip.name2]" 1527 | #In this example we use [zulip.streamchat] 1528 | #REQUIRED 1529 | 1530 | [zulip.streamchat] 1531 | #Token to connect with zulip API (called bot API key in Settings - Your bots) 1532 | #REQUIRED 1533 | Token="Yourtokenhere" 1534 | 1535 | #Username of the bot, normally called yourbot-bot@yourserver.zulipchat.com 1536 | #See username in Settings - Your bots 1537 | #REQUIRED 1538 | Login="yourbot-bot@yourserver.zulipchat.com" 1539 | 1540 | #Servername of your zulip instance 1541 | #REQUIRED 1542 | Server="https://yourserver.zulipchat.com" 1543 | 1544 | ## RELOADABLE SETTINGS 1545 | ## Settings below can be reloaded by editing the file 1546 | 1547 | #Nicks you want to ignore. 1548 | #Regular expressions supported 1549 | #Messages from those users will not be sent to other bridges. 1550 | #OPTIONAL 1551 | IgnoreNicks="spammer1 spammer2" 1552 | 1553 | #Messages you want to ignore. 1554 | #Messages matching these regexp will be ignored and not sent to other bridges 1555 | #See https://regex-golang.appspot.com/assets/html/index.html for more regex info 1556 | #OPTIONAL (example below ignores messages starting with ~~ or messages containing badword 1557 | IgnoreMessages="^~~ badword" 1558 | 1559 | #messages you want to replace. 1560 | #it replaces outgoing messages from the bridge. 1561 | #so you need to place it by the sending bridge definition. 1562 | #regular expressions supported 1563 | #some examples: 1564 | #this replaces cat => dog and sleep => awake 1565 | #replacemessages=[ ["cat","dog"], ["sleep","awake"] ] 1566 | #this replaces every number with number. 123 => numbernumbernumber 1567 | #replacemessages=[ ["[0-9]","number"] ] 1568 | #optional (default empty) 1569 | ReplaceMessages=[ ["cat","dog"] ] 1570 | 1571 | #nicks you want to replace. 1572 | #see replacemessages for syntaxa 1573 | #optional (default empty) 1574 | ReplaceNicks=[ ["user--","user"] ] 1575 | 1576 | #Extractnicks is used to for example rewrite messages from other relaybots 1577 | #See https://github.com/42wim/matterbridge/issues/713 and https://github.com/42wim/matterbridge/issues/466 1578 | #some examples: 1579 | #this replaces a message like "Relaybot: something interesting" to "relayeduser: something interesting" 1580 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ] ] 1581 | #you can use multiple entries for multiplebots 1582 | #this also replaces a message like "otherbot: (relayeduser) something else" to "relayeduser: something else" 1583 | #ExtractNicks=[ [ "Relaybot", "<(.*?)>\\s+" ],[ "otherbot","\\((.*?)\\)\\s+" ] 1584 | #OPTIONAL (default empty) 1585 | ExtractNicks=[ ["otherbot","<(.*?)>\\s+" ] ] 1586 | 1587 | #extra label that can be used in the RemoteNickFormat 1588 | #optional (default empty) 1589 | Label="" 1590 | 1591 | #RemoteNickFormat defines how remote users appear on this bridge 1592 | #See [general] config section for default options 1593 | RemoteNickFormat="[{PROTOCOL}] <{NICK}> " 1594 | 1595 | #Enable to show users joins/parts from other bridges 1596 | #Currently works for messages from the following bridges: irc, mattermost, slack, discord 1597 | #OPTIONAL (default false) 1598 | ShowJoinPart=false 1599 | 1600 | #StripNick only allows alphanumerical nicks. See https://github.com/42wim/matterbridge/issues/285 1601 | #It will strip other characters from the nick 1602 | #OPTIONAL (default false) 1603 | StripNick=false 1604 | 1605 | #Enable to show topic changes from other bridges 1606 | #Only works hiding/show topic changes from slack bridge for now 1607 | #OPTIONAL (default false) 1608 | ShowTopicChange=false 1609 | 1610 | ################################################################### 1611 | #API 1612 | ################################################################### 1613 | [api] 1614 | #You can configure multiple API hooks 1615 | #In this example we use [api.local] 1616 | #REQUIRED 1617 | 1618 | [api.local] 1619 | #Address to listen on for API 1620 | #REQUIRED 1621 | BindAddress="127.0.0.1:4242" 1622 | 1623 | #Amount of messages to keep in memory 1624 | #OPTIONAL (library default 10) 1625 | Buffer=1000 1626 | 1627 | #Bearer token used for authentication 1628 | #curl -H "Authorization: Bearer token" http://localhost:4242/api/messages 1629 | # https://github.com/vi/websocat 1630 | # websocat -H="Authorization: Bearer token" ws://127.0.0.1:4242/api/websocket 1631 | #OPTIONAL (no authorization if token is empty) 1632 | Token="mytoken" 1633 | 1634 | #extra label that can be used in the RemoteNickFormat 1635 | #optional (default empty) 1636 | Label="" 1637 | 1638 | #RemoteNickFormat defines how remote users appear on this bridge 1639 | #See [general] config section for default options 1640 | RemoteNickFormat="{NICK}" 1641 | 1642 | 1643 | 1644 | ################################################################### 1645 | #General configuration 1646 | ################################################################### 1647 | # Settings here are defaults that each protocol can override 1648 | [general] 1649 | 1650 | ## RELOADABLE SETTINGS 1651 | ## Settings below can be reloaded by editing the file 1652 | 1653 | #RemoteNickFormat defines how remote users appear on this bridge 1654 | #The string "{NICK}" (case sensitive) will be replaced by the actual nick. 1655 | #The string "{USERID}" (case sensitive) will be replaced by the user ID. 1656 | #The string "{BRIDGE}" (case sensitive) will be replaced by the sending bridge 1657 | #The string "{LABEL}" (case sensitive) will be replaced by label= field of the sending bridge 1658 | #The string "{PROTOCOL}" (case sensitive) will be replaced by the protocol used by the bridge 1659 | #The string "{GATEWAY}" (case sensitive) will be replaced by the origin gateway name that is replicating the message. 1660 | #The string "{CHANNEL}" (case sensitive) will be replaced by the origin channel name used by the bridge 1661 | #The string "{TENGO}" (case sensitive) will be replaced by the output of the RemoteNickFormat script under [tengo] 1662 | #OPTIONAL (default empty) 1663 | RemoteNickFormat="[{PROTOCOL}] <{NICK}> " 1664 | 1665 | #StripNick only allows alphanumerical nicks. See https://github.com/42wim/matterbridge/issues/285 1666 | #It will strip other characters from the nick 1667 | #OPTIONAL (default false) 1668 | StripNick=false 1669 | 1670 | 1671 | #MediaServerUpload (or MediaDownloadPath) and MediaServerDownload are used for uploading 1672 | #images/files/video to a remote "mediaserver" (a webserver like caddy for example). 1673 | #When configured images/files uploaded on bridges like mattermost, slack, telegram will be 1674 | #downloaded and uploaded again to MediaServerUpload URL 1675 | #MediaDownloadPath is the filesystem path where the media file will be placed, instead of uploaded, 1676 | #for if Matterbridge has write access to the directory your webserver is serving. 1677 | #It is an alternative to MediaServerUpload. 1678 | #The MediaServerDownload will be used so that bridges without native uploading support: 1679 | #gitter, irc and xmpp will be shown links to the files on MediaServerDownload 1680 | # 1681 | #More information https://github.com/42wim/matterbridge/wiki/Mediaserver-setup-%5Badvanced%5D 1682 | #OPTIONAL (default empty) 1683 | MediaServerUpload="https://user:pass@yourserver.com/upload" 1684 | #OPTIONAL (default empty) 1685 | MediaDownloadPath="/srv/http/yourserver.com/public/download" 1686 | #OPTIONAL (default empty) 1687 | MediaServerDownload="https://youserver.com/download" 1688 | 1689 | #MediaDownloadSize is the maximum size of attachments, videos, images 1690 | #matterbridge will download and upload this file to bridges that also support uploading files. 1691 | #eg downloading from slack to upload it to mattermost 1692 | # 1693 | #It will only download from bridges that don't have public links available, which are for the moment 1694 | #slack, telegram, matrix and mattermost 1695 | # 1696 | #OPTIONAL (default 1000000 (1 megabyte)) 1697 | MediaDownloadSize=1000000 1698 | 1699 | #MediaDownloadBlacklist allows you to blacklist specific files from being downloaded. 1700 | #Filenames matching these regexp will not be download/uploaded to the mediaserver 1701 | #You can use regex for this, see https://regex-golang.appspot.com/assets/html/index.html for more regex info 1702 | #OPTIONAL (default empty) 1703 | MediaDownloadBlacklist=[".html$",".htm$"] 1704 | 1705 | #IgnoreFailureOnStart allows you to ignore failing bridges on startup. 1706 | #Matterbridge will disable the failed bridge and continue with the other ones. 1707 | #Context: https://github.com/42wim/matterbridge/issues/455 1708 | #OPTIONAL (default false) 1709 | IgnoreFailureOnStart=false 1710 | 1711 | #LogFile defines the location of a file to write logs into, rather 1712 | #than stdout. 1713 | #Logging will still happen on stdout if the file cannot be open for 1714 | #writing, or if the value is empty. Note that the log won't roll, so 1715 | #you might want to use logrotate(8) with this feature. 1716 | #OPTIONAL (default empty) 1717 | LogFile="/var/log/matterbridge.log" 1718 | 1719 | ################################################################### 1720 | #Tengo configuration 1721 | ################################################################### 1722 | #More information about tengo on: https://github.com/d5/tengo/blob/master/docs/tutorial.md and 1723 | #https://github.com/d5/tengo/blob/master/docs/stdlib.md 1724 | 1725 | [tengo] 1726 | #InMessage allows you to specify the location of a tengo (https://github.com/d5/tengo/) script. 1727 | #This script will receive every incoming message and can be used to modify the Username and the Text of that message. 1728 | #The script will have the following global variables: 1729 | #to modify: msgUsername and msgText 1730 | #to read: msgUserID, msgChannel, msgAccount 1731 | # 1732 | #The script is reloaded on every message, so you can modify the script on the fly. 1733 | # 1734 | #Example script can be found in https://github.com/42wim/matterbridge/tree/master/gateway/bench.tengo 1735 | #and https://github.com/42wim/matterbridge/tree/master/contrib/example.tengo 1736 | # 1737 | #The example below will check if the text contains blah and if so, it'll replace the text and the username of that message. 1738 | #text := import("text") 1739 | #if text.re_match("blah",msgText) { 1740 | # msgText="replaced by this" 1741 | # msgUsername="fakeuser" 1742 | #} 1743 | #OPTIONAL (default empty) 1744 | InMessage="example.tengo" 1745 | 1746 | #OutMessage allows you to specify the location of the script that 1747 | #will be invoked on each message being sent to a bridge and can be used to modify the Username 1748 | #and the Text of that message. 1749 | # 1750 | #The script will have the following global variables: 1751 | #read-only: 1752 | #inAccount, inProtocol, inChannel, inGateway, inEvent 1753 | #outAccount, outProtocol, outChannel, outGateway, outEvent 1754 | #msgUserID 1755 | # 1756 | #read-write: 1757 | #msgText, msgUsername, msgDrop 1758 | # 1759 | #msgDrop is a bool which is default false, when set true this message will be dropped 1760 | # 1761 | #The script is reloaded on every message, so you can modify the script on the fly. 1762 | # 1763 | #The default script in https://github.com/42wim/matterbridge/tree/master/internal/tengo/outmessage.tengo 1764 | #is compiled in and will be executed if no script is specified. 1765 | #OPTIONAL (default empty) 1766 | OutMessage="example.tengo" 1767 | 1768 | 1769 | #RemoteNickFormat allows you to specify the location of a tengo (https://github.com/d5/tengo/) script. 1770 | #The script will have the following global variables: 1771 | #to modify: result 1772 | #to read: channel, bridge, gateway, protocol, nick, msgUserID 1773 | # 1774 | #The result will be set in {TENGO} in the RemoteNickFormat key of every bridge where {TENGO} is specified 1775 | # 1776 | #The script is reloaded on every message, so you can modify the script on the fly. 1777 | # 1778 | #Example script can be found in https://github.com/42wim/matterbridge/tree/master/contrib/remotenickformat.tengo 1779 | # 1780 | #OPTIONAL (default empty) 1781 | RemoteNickFormat="remotenickformat.tengo" 1782 | 1783 | ################################################################### 1784 | #Gateway configuration 1785 | ################################################################### 1786 | 1787 | #You can specify multiple gateways using [[gateway]] 1788 | #Each gateway has a [[gateway.in]] and a [[gateway.out]] 1789 | #[[gateway.in]] specifies the account and channels we will receive messages from. 1790 | #[[gateway.out]] specifies the account and channels we will send the messages 1791 | #from [[gateway.in]] to. 1792 | # 1793 | #Most of the time [[gateway.in]] and [[gateway.out]] are the same if you 1794 | #want bidirectional bridging. You can then use [[gateway.inout]] 1795 | # 1796 | 1797 | [[gateway]] 1798 | #REQUIRED and UNIQUE 1799 | name="gateway1" 1800 | #Enable enables this gateway 1801 | ##OPTIONAL (default false) 1802 | enable=true 1803 | 1804 | # [[gateway.in]] specifies the account and channels we will receive messages from. 1805 | # The following example bridges between mattermost and irc 1806 | [[gateway.in]] 1807 | 1808 | # account specified above 1809 | # REQUIRED 1810 | account="irc.freenode" 1811 | 1812 | # The channel key in each gateway is mapped to a similar group chat ID on the chat platform 1813 | # To find the group chat ID for different platforms, refer to the table below 1814 | # 1815 | # Platform | Identifier name | Example | Description 1816 | # ------------------------------------------------------------------------------------------------------------------------------------- 1817 | # | channel | general | Do not include the # symbol 1818 | # discord | channel id | ID:123456789 | See https://github.com/42wim/matterbridge/issues/57 1819 | # | category/channel | Media/gaming | Without # symbol. If you're using discord categories to group your channels 1820 | # ------------------------------------------------------------------------------------------------------------------------------------- 1821 | # gitter | username/room | general | As seen in the gitter.im URL 1822 | # ------------------------------------------------------------------------------------------------------------------------------------- 1823 | # hipchat | id_channel | example needed | See https://www.hipchat.com/account/xmpp for the correct channel 1824 | # ------------------------------------------------------------------------------------------------------------------------------------- 1825 | # irc | channel | #general | The # symbol is required and should be lowercase! 1826 | # ------------------------------------------------------------------------------------------------------------------------------------- 1827 | # mattermost | channel | general | This is the channel name as seen in the URL, not the display name 1828 | # ------------------------------------------------------------------------------------------------------------------------------------- 1829 | # matrix | #channel:server | #yourchannel:matrix.org | Encrypted rooms are not supported in matrix 1830 | # ------------------------------------------------------------------------------------------------------------------------------------- 1831 | # msteams | threadId | 19:82abcxx@thread.skype | You'll find the threadId in the URL 1832 | # ------------------------------------------------------------------------------------------------------------------------------------- 1833 | # mumble | channel id | 42 | The channel ID, as shown in the channel's "Edit" window 1834 | # ------------------------------------------------------------------------------------------------------------------------------------- 1835 | # rocketchat | channel | #channel | # is required for private channels too 1836 | # ------------------------------------------------------------------------------------------------------------------------------------- 1837 | # slack | channel name | general | Do not include the # symbol 1838 | # | channel id | ID:C123456 | The underlying ID of a channel. This doesn't work with 1839 | # ------------------------------------------------------------------------------------------------------------------------------------- 1840 | # steam | chatid | example needed | The number in the URL when you click "enter chat room" in the browser 1841 | # ------------------------------------------------------------------------------------------------------------------------------------- 1842 | # nctalk | token | xs25tz5y | The token in the URL when you are in a chat. It will be the last part of the URL. 1843 | # ------------------------------------------------------------------------------------------------------------------------------------- 1844 | # telegram | chatid | -123456789 | A large negative number. see https://www.linkedin.com/pulse/telegram-bots-beginners-marco-frau 1845 | # ------------------------------------------------------------------------------------------------------------------------------------- 1846 | # whatsapp | group JID | 48111222333-123455678999@g.us | A unique group JID. If you specify an empty string, bridge will list all the possibilities 1847 | # | "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. 1848 | # ------------------------------------------------------------------------------------------------------------------------------------- 1849 | # xmpp | channel | general | The room name 1850 | # ------------------------------------------------------------------------------------------------------------------------------------- 1851 | # zulip | stream/topic:topic | general/off-topic:food | Do not use the # when specifying a topic 1852 | # ------------------------------------------------------------------------------------------------------------------------------------- 1853 | 1854 | # 1855 | # REQUIRED 1856 | channel="#testing" 1857 | 1858 | #OPTIONAL - only used for IRC and XMPP protocols at the moment 1859 | [gateway.in.options] 1860 | #OPTIONAL - your irc / xmpp channel key 1861 | key="yourkey" 1862 | 1863 | 1864 | #[[gateway.out]] specifies the account and channels we will sent messages to. 1865 | [[gateway.out]] 1866 | account="irc.freenode" 1867 | channel="#testing" 1868 | 1869 | #OPTIONAL - only used for IRC and XMPP protocols at the moment 1870 | [gateway.out.options] 1871 | #OPTIONAL - your irc / xmpp channel key 1872 | key="yourkey" 1873 | 1874 | #[[gateway.inout]] can be used when then channel will be used to receive from 1875 | #and send messages to 1876 | [[gateway.inout]] 1877 | account="mattermost.work" 1878 | channel="off-topic" 1879 | 1880 | #OPTIONAL - only used for IRC and XMPP protocols at the moment 1881 | [gateway.inout.options] 1882 | #OPTIONAL - your irc / xmpp channel key 1883 | key="yourkey" 1884 | 1885 | # Discord specific gateway options 1886 | [[gateway.inout]] 1887 | account="discord.game" 1888 | channel="mygreatgame" 1889 | 1890 | [gateway.inout.options] 1891 | # WebhookURL sends messages in the style of "puppets". You must configure a webhook URL for each channel you want to bridge. 1892 | # If you have more than one channel and don't wnat to configure each channel manually, see the "AutoWebhooks" option in the gateway config. 1893 | # Example: "https://discord.com/api/webhooks/1234/abcd_xyzw" 1894 | WebhookURL="" 1895 | 1896 | [[gateway.inout]] 1897 | account="zulip.streamchat" 1898 | channel="general/topic:mytopic" 1899 | 1900 | #API example 1901 | #[[gateway.inout]] 1902 | #account="api.local" 1903 | #channel="api" 1904 | #To send data to the api: 1905 | #curl -XPOST -H 'Content-Type: application/json' -d '{"text":"test","username":"randomuser","gateway":"gateway1"}' http://localhost:4242/api/message 1906 | #To read from the api: 1907 | #curl http://localhost:4242/api/messages 1908 | 1909 | #If you want to do a 1:1 mapping between protocols where the channelnames are the same 1910 | #e.g. slack and mattermost you can use the samechannelgateway configuration 1911 | #the example configuration below send messages from channel testing on mattermost to 1912 | #channel testing on slack and vice versa. (and for the channel testing2 and testing3) 1913 | 1914 | [[samechannelgateway]] 1915 | name="samechannel1" 1916 | enable = false 1917 | accounts = [ "mattermost.work","slack.hobby" ] 1918 | channels = [ "testing","testing2","testing3"] 1919 | -------------------------------------------------------------------------------- /conf/systemd.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Matterbridge: Multi-protocols bridge 3 | After=network.target 4 | 5 | [Service] 6 | Type=simple 7 | User=__APP__ 8 | Group=__APP__ 9 | WorkingDirectory=__INSTALL_DIR__/ 10 | UMask=000 11 | ExecStart=__INSTALL_DIR__/matterbridge -conf __INSTALL_DIR__/matterbridge.toml 12 | RestartSec=30 13 | Restart=always 14 | 15 | # Sandboxing options to harden security 16 | # Depending on specificities of your service/app, you may need to tweak these 17 | # .. but this should be a good baseline 18 | # Details for these options: https://www.freedesktop.org/software/systemd/man/systemd.exec.html 19 | NoNewPrivileges=yes 20 | PrivateTmp=yes 21 | PrivateDevices=yes 22 | RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6 23 | RestrictNamespaces=yes 24 | RestrictRealtime=yes 25 | DevicePolicy=closed 26 | ProtectSystem=full 27 | ProtectControlGroups=yes 28 | ProtectKernelModules=yes 29 | ProtectKernelTunables=yes 30 | LockPersonality=yes 31 | SystemCallFilter=~@clock @debug @module @mount @obsolete @reboot @setuid @swap 32 | 33 | # Denying access to capabilities that should not be relevant for webapps 34 | # Doc: https://man7.org/linux/man-pages/man7/capabilities.7.html 35 | CapabilityBoundingSet=~CAP_RAWIO CAP_MKNOD 36 | CapabilityBoundingSet=~CAP_AUDIT_CONTROL CAP_AUDIT_READ CAP_AUDIT_WRITE 37 | CapabilityBoundingSet=~CAP_SYS_BOOT CAP_SYS_TIME CAP_SYS_MODULE CAP_SYS_PACCT 38 | CapabilityBoundingSet=~CAP_LEASE CAP_LINUX_IMMUTABLE CAP_IPC_LOCK 39 | CapabilityBoundingSet=~CAP_BLOCK_SUSPEND CAP_WAKE_ALARM 40 | CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG 41 | CapabilityBoundingSet=~CAP_MAC_ADMIN CAP_MAC_OVERRIDE 42 | CapabilityBoundingSet=~CAP_NET_ADMIN CAP_NET_BROADCAST CAP_NET_RAW 43 | CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG 44 | 45 | [Install] 46 | WantedBy=multi-user.target 47 | -------------------------------------------------------------------------------- /doc/ADMIN.md: -------------------------------------------------------------------------------- 1 | ## Configuration 2 | 3 | How to configure this app: a plain file with SSH `/opt/yunohost/matterbridge/matterbridge.toml`. You can follow this [doc](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) on how to create your config. 4 | -------------------------------------------------------------------------------- /doc/ADMIN_fr.md: -------------------------------------------------------------------------------- 1 | ## Configuration 2 | 3 | Comment configurer cette application : un fichier brut en SSH `/opt/yunohost/matterbridge/matterbridge.toml`. Vous pouvez suivre cette [documentation](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) sur la façon de créer votre config. 4 | -------------------------------------------------------------------------------- /doc/DESCRIPTION.md: -------------------------------------------------------------------------------- 1 | A simple chat bridge between a growing number of protocols: 2 | 3 | Discord, Gitter, IRC, Keybase, Matrix, Mattermost, MSTeams, Rocket.Chat, Slack, Telegram, Twitch, WhatsApp, XMPP, Zulip, And more... 4 | -------------------------------------------------------------------------------- /doc/DESCRIPTION_fr.md: -------------------------------------------------------------------------------- 1 | Un connecteur de messagerie simple entre un nombre croissant de protocoles : 2 | 3 | Discord, Gitter, IRC, Keybase, Matrix, Mattermost, MSTeams, Rocket.Chat, Slack, Telegram, Twitch, WhatsApp, XMPP, Zulip, Et plus... 4 | -------------------------------------------------------------------------------- /manifest.toml: -------------------------------------------------------------------------------- 1 | #:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json 2 | 3 | packaging_format = 2 4 | 5 | id = "matterbridge" 6 | name = "Matterbridge" 7 | description.en = "Multi-protocols bridge for online communications" 8 | description.fr = "Connecteur entre une série de protocoles de discussion" 9 | 10 | version = "1.26.0~ynh2" 11 | 12 | maintainers = [] 13 | 14 | [upstream] 15 | license = "Apache-2.0" 16 | admindoc = "https://github.com/42wim/matterbridge/wiki" 17 | code = "https://github.com/42wim/matterbridge" 18 | 19 | [integration] 20 | yunohost = ">= 11.1.21" 21 | architectures = ["amd64", "arm64", "armhf"] 22 | multi_instance = false 23 | ldap = "not_relevant" 24 | sso = "not_relevant" 25 | disk = "60M" 26 | ram.build = "50M" 27 | ram.runtime = "50M" 28 | 29 | [install] 30 | 31 | [resources] 32 | [resources.sources.main] 33 | in_subdir = false 34 | amd64.url = "https://github.com/42wim/matterbridge/releases/download/v1.26.0/matterbridge-1.26.0-linux-64bit" 35 | amd64.sha256 = "7f5a74b9b7cbf395b8873f3f3f418d90c61197e3cc677882e70b7faeef4c35b0" 36 | arm64.url = "https://github.com/42wim/matterbridge/releases/download/v1.26.0/matterbridge-1.26.0-linux-arm64" 37 | arm64.sha256 = "3d922187ce3e792f9cf896e209c828d3466e3b2453f3a133f7f610f9d6937587" 38 | armhf.url = "https://github.com/42wim/matterbridge/releases/download/v1.26.0/matterbridge-1.26.0-linux-armv6" 39 | armhf.sha256 = "fee25dc50c96508147c88c0da05c6143681f8c88bdbef1c42a91bf9388aa13f9" 40 | 41 | extract = false 42 | rename = "matterbridge" 43 | 44 | autoupdate.strategy = "latest_github_release" 45 | autoupdate.asset.amd64 = "matterbridge-.*-linux-64bit" 46 | autoupdate.asset.arm64 = "matterbridge-.*-linux-arm64" 47 | autoupdate.asset.armhf = "matterbridge-.*-linux-armv6" 48 | 49 | [resources.system_user] 50 | 51 | [resources.install_dir] 52 | -------------------------------------------------------------------------------- /scripts/_common.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # COMMON VARIABLES 5 | #================================================= 6 | 7 | #================================================= 8 | # PERSONAL HELPERS 9 | #================================================= 10 | 11 | #================================================= 12 | # EXPERIMENTAL HELPERS 13 | #================================================= 14 | 15 | #================================================= 16 | # FUTURE OFFICIAL HELPERS 17 | #================================================= 18 | -------------------------------------------------------------------------------- /scripts/backup: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # GENERIC START 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts 10 | source ../settings/scripts/_common.sh 11 | source /usr/share/yunohost/helpers 12 | 13 | #================================================= 14 | # DECLARE DATA AND CONF FILES TO BACKUP 15 | #================================================= 16 | ynh_print_info --message="Declaring files to be backed up..." 17 | 18 | #================================================= 19 | # BACKUP THE APP MAIN DIR 20 | #================================================= 21 | 22 | ynh_backup --src_path="$install_dir" 23 | 24 | #================================================= 25 | # BACKUP SYSTEMD 26 | #================================================= 27 | 28 | ynh_backup --src_path="/etc/systemd/system/$app.service" 29 | 30 | #================================================= 31 | # END OF SCRIPT 32 | #================================================= 33 | 34 | ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." 35 | -------------------------------------------------------------------------------- /scripts/install: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # GENERIC START 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | source _common.sh 10 | source /usr/share/yunohost/helpers 11 | 12 | #================================================= 13 | # DOWNLOAD, CHECK AND UNPACK SOURCE 14 | #================================================= 15 | ynh_script_progression --message="Setting up source files..." --weight=1 16 | 17 | # Download, check integrity, uncompress and patch the source from app.src 18 | ynh_setup_source --dest_dir="$install_dir" 19 | chmod +x "$install_dir/matterbridge" 20 | 21 | chmod -R o-rwX "$install_dir" 22 | chown -R "$app:www-data" "$install_dir" 23 | 24 | #================================================= 25 | # MODIFY A CONFIG FILE 26 | #================================================= 27 | ynh_script_progression --message="Adding a configuration file..." --weight=1 28 | 29 | ynh_add_config --template="matterbridge.toml" --destination="$install_dir/matterbridge.toml" 30 | 31 | #================================================= 32 | # SYSTEM CONFIGURATION 33 | #================================================= 34 | ynh_script_progression --message="Adding system configurations related to $app..." --weight=1 35 | 36 | # Create a dedicated systemd config 37 | ynh_add_systemd_config 38 | yunohost service add "$app" --description="Multi-protocols bridge for online communications" --log="/var/log/$app/$app.log" 39 | 40 | #================================================= 41 | # START SYSTEMD SERVICE 42 | #================================================= 43 | ynh_script_progression --message="Starting a systemd service..." --weight=1 44 | 45 | ynh_systemd_action --service_name="$app" --action=start --log_path="/var/log/$app/$app.log" 46 | 47 | #================================================= 48 | # END OF SCRIPT 49 | #================================================= 50 | 51 | ynh_script_progression --message="Installation of $app completed" --last 52 | -------------------------------------------------------------------------------- /scripts/remove: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # GENERIC START 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | source _common.sh 10 | source /usr/share/yunohost/helpers 11 | 12 | #================================================= 13 | # REMOVE SYSTEM CONFIGURATIONS 14 | #================================================= 15 | ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 16 | 17 | # Remove the service from the list of services known by YunoHost (added from `yunohost service add`) 18 | if ynh_exec_warn_less yunohost service status "$app" >/dev/null; then 19 | yunohost service remove "$app" 20 | fi 21 | 22 | # Remove the dedicated systemd config 23 | ynh_remove_systemd_config 24 | 25 | #================================================= 26 | # END OF SCRIPT 27 | #================================================= 28 | 29 | ynh_script_progression --message="Removal of $app completed" --last 30 | -------------------------------------------------------------------------------- /scripts/restore: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # GENERIC START 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | source ../settings/scripts/_common.sh 10 | source /usr/share/yunohost/helpers 11 | 12 | #================================================= 13 | # RESTORE THE APP MAIN DIR 14 | #================================================= 15 | ynh_script_progression --message="Restoring the app main directory..." --weight=1 16 | 17 | ynh_restore_file --origin_path="$install_dir" 18 | 19 | # Restore permissions on app files 20 | chmod -R o-rwX "$install_dir" 21 | chown -R "$app:www-data" "$install_dir" 22 | 23 | #================================================= 24 | # RESTORE SYSTEM CONFIGURATIONS 25 | #================================================= 26 | ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1 27 | 28 | ynh_restore_file --origin_path="/etc/systemd/system/$app.service" 29 | systemctl enable "$app.service" --quiet 30 | yunohost service add "$app" --description="Multi-protocols bridge for online communications" --log="/var/log/$app/$app.log" 31 | 32 | #================================================= 33 | # START SYSTEMD SERVICE 34 | #================================================= 35 | ynh_script_progression --message="Starting a systemd service..." --weight=1 36 | 37 | ynh_systemd_action --service_name="$app" --action=start --log_path="/var/log/$app/$app.log" 38 | 39 | #================================================= 40 | # END OF SCRIPT 41 | #================================================= 42 | 43 | ynh_script_progression --message="Restoration completed for $app" --last 44 | -------------------------------------------------------------------------------- /scripts/upgrade: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #================================================= 4 | # GENERIC START 5 | #================================================= 6 | # IMPORT GENERIC HELPERS 7 | #================================================= 8 | 9 | source _common.sh 10 | source /usr/share/yunohost/helpers 11 | 12 | #================================================= 13 | # STANDARD UPGRADE STEPS 14 | #================================================= 15 | # STOP SYSTEMD SERVICE 16 | #================================================= 17 | ynh_script_progression --message="Stopping a systemd service..." --weight=1 18 | 19 | ynh_systemd_action --service_name="$app" --action=stop --log_path="/var/log/$app/$app.log" 20 | 21 | #================================================= 22 | # DOWNLOAD, CHECK AND UNPACK SOURCE 23 | #================================================= 24 | ynh_script_progression --message="Upgrading source files..." --weight=2 25 | 26 | # Download, check integrity, uncompress and patch the source from app.src 27 | ynh_setup_source --dest_dir="$install_dir" --full_replace=1 --keep="matterbridge.toml" 28 | chmod +x "$install_dir/matterbridge" 29 | 30 | chmod -R o-rwX "$install_dir" 31 | chown -R "$app:www-data" "$install_dir" 32 | 33 | #================================================= 34 | # REAPPLY SYSTEM CONFIGURATIONS 35 | #================================================= 36 | ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1 37 | 38 | # Create a dedicated systemd config 39 | ynh_add_systemd_config 40 | yunohost service add "$app" --description="Multi-protocols bridge for online communications" --log="/var/log/$app/$app.log" 41 | 42 | #================================================= 43 | # START SYSTEMD SERVICE 44 | #================================================= 45 | ynh_script_progression --message="Starting a systemd service..." --weight=2 46 | 47 | ynh_systemd_action --service_name="$app" --action=start --log_path="/var/log/$app/$app.log" 48 | 49 | #================================================= 50 | # END OF SCRIPT 51 | #================================================= 52 | 53 | ynh_script_progression --message="Upgrade of $app completed" --last 54 | -------------------------------------------------------------------------------- /tests.toml: -------------------------------------------------------------------------------- 1 | #:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json 2 | 3 | test_format = 1.0 4 | 5 | [default] 6 | 7 | # ------------ 8 | # Tests to run 9 | # ------------ 10 | 11 | test_upgrade_from.58cf8e614d7b4396816b4073f58af75c5c4b075f.name = "Merge pull request #5 from YunoHost-Apps/testing" 12 | --------------------------------------------------------------------------------