commit 91dfafcbd3a3dfb538c006adff8f604b4987f67e Author: A Date: Wed Jul 3 11:37:16 2024 -0700 Initial commit diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..f1c588b --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +*.apk filter=lfs diff=lfs merge=lfs -text diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3c27a8a --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +conf/element/* +!conf/element/config.json +!conf/element/nginx.conf +conf/synapse/* +conf/caddy/* +conf/caddy/certs/* +!conf/caddy/certs/.gitkeep +!conf/caddy/Caddyfile.tmpl +conf/mastodon/*.env.production +!conf/mastodon/example.env.production +conf/mau/* + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..117908b --- /dev/null +++ b/README.md @@ -0,0 +1,96 @@ +# THIS PROJECT HAS MOVED +https://github.com/equalitie/dcomms-docker-compose + +# dcomms + +Decentralized communications that work with or without the Internet + +# Prerequisites +* `docker` using the docker guide (https://docs.docker.com/engine/install/) +* `curl`, `aria2`, `tor` +* A directory named `/var/www/dcomms` created on the host for the website document root. +* A subdomain with the A record pointed to the IP address of a node for automatic issuance of a Let's Encrypt SSL certificate. +* A subdomain with the MX record pointed to the A record of a node for DeltaChat mail delivery. +* (Optional) A Tor hidden service [configured](https://community.torproject.org/onion-services/setup/), and listening on port 80 and 8448. + +# Introduction + +`dcomms` is a bundle of decentralized communication software running as services in the form of a docker swarm stack. + +It is used to rapidly deploy a server hosting a variety of decentralized, encrypted, and federated communications platforms such as [Matrix](https://matrix.org/) and [DeltaChat](https://delta.chat) across multiple hosts. + +Let's Encrypt TLS certificates are automatically issued and managed by the Caddy container across all services. + +## Service containers + +The dcomms stack leverages single node, non-replicated containers of the following services built from the latest images below: + +* [CENO client](https://hub.docker.com/r/equalitie/ceno-client) courtesy of censorship.no +* [Synapse Docker](https://hub.docker.com/r/matrixdotorg/synapse/) courtesy of matrix.org +* [Element](https://hub.docker.com/r/vectorim/element-web/) courtesy of vector-im +* [Mau](https://mau.dev/maubot/maubot) courtesy of the maubot dev team +* [Caddy](https://hub.docker.com/_/caddy) courtesy of the Caddy Docker Maintainers +* [docker-mailadm](https://github.com/deltachat/docker-mailadm), includes dovecot and postfix, courtesy of DeltaChat +* [Mastodon](https://hub.docker.com/r/aphick/mastodon-sendmail), a modified version of the original Mastodon [container](https://hub.docker.com/r/tootsuite/mastodon) that includes sendmail. + +## Ports + +CENO client: 28729/udp \ +Caddy (webserver): 443/tcp, 80/tcp, 8448/tcp \ +DeltaChat (postfix/dovecot): 587/tcp 143/tcp + +* Note: `dcomms` leverages docker host networking and therefore we recommend denying access to all other unnecessary ports at the host level. + +# Installation + +Point the following A records to the docker worker you wish to use for deployment: +``` +matrix.server1.example.org -> IP of your server +chat.server1.example.org -> IP of your server +server1.example.org -> IP of your server +``` + +Point the following MX record to the A record: +``` +server1.example.org -> server1.example.org +``` + +Clone or download this repository. Review `./install.sh` and make any that may be required for your environment. + + +## Install + +Once your server meets the prerequisites, installation simply involves running `./install.sh` and responding to any prompts. Configs will be automatically placed in your `DCOMMS_DIR` and a `run.sh` script will be generated. + +* Note: If you wish to reinstall dcomms you will need to delete all docker volumes, and the `conf` directory in `DCOMMS_DIR` before running `install.sh` again. + +## Redeploy + +In the future, if you need to start the dcomms containers again simply run the `./run.sh` program in your `DCOMMS_DIR`. + +# Tor + +If you wish to provide users with a Tor hidden service address by which they can access your services, you must first install and [configure Tor](https://community.torproject.org/onion-services/setup/). +The script will detect if you have Tor installed and prompt you for a hidden service address. You can find this in the `hostname` file in your `HiddenServiceDir`. + +Example: +``` +cat /var/lib/tor/onion_service/hostname +``` + +# Post installation + +* Copy a pre-existing website into `/var/www/dcomms/` across all docker nodes or checkout all files from either the [dcomms-web repo (UA)](https://github.com/censorship-no/dcomms-web) or the [chatv3 repo (RU)](https://github.com/censorship-no/chatv3-web) into the same location. +* Optionally visit `https://server1.example.org` to view the website. +* Optionally visit `https://chat.server1.example.org` to view the Element service. +* Optionally configure a Matrix client to use `https://matrix.server1.example.org` as the homeserver. + + +# Troubleshooting + +## Log review + +## Altering configs + +## Specific issues with services + diff --git a/conf/caddy/Caddyfile.tmpl b/conf/caddy/Caddyfile.tmpl new file mode 100644 index 0000000..3a37354 --- /dev/null +++ b/conf/caddy/Caddyfile.tmpl @@ -0,0 +1,79 @@ +# The Caddyfile is an easy way to configure your Caddy web server. +# +# Unless the file starts with a global options block, the first +# uncommented line is always the address of your site. +# +# To use your own domain name (with automatic HTTPS), first make +# sure your domain's A/AAAA DNS records are properly pointed to +# this machine's public IP, then replace ":80" below with your +# domain name. + +{ + acme_ca https://acme-v02.api.letsencrypt.org/directory +} + +#{ +# local_certs +#} + +{$DWEB_DOMAIN}, http://{$DWEB_DOMAIN} { + handle_path /new_email* { + rewrite * /{path} + reverse_proxy http://mailadm:3691 + } + root * /www + file_server browse + header Onion-Location http://{$DWEB_ONION} +} + +chat.{$DWEB_DOMAIN}, http://chat.{$DWEB_ONION} { + reverse_proxy http://element:8001 + header Onion-Location http://chat.{$DWEB_ONION} +} + +matrix.{$DWEB_DOMAIN}, http://matrix.{$DWEB_ONION} { + reverse_proxy /_matrix/* http://synapse:8008 + reverse_proxy /_synapse/client/* http://synapse:8008 + header Onion-Location http://matrix.{$DWEB_ONION} +} + +matrix.{$DWEB_DOMAIN}:8448 { + reverse_proxy http://synapse:8008 +} + +social.{$DWEB_DOMAIN}, http://social.{$DWEB_ONION} { + + root * /srv/mastodon/public + encode gzip + @static file + handle @static { + file_server + } + handle /api/v1/streaming* { + reverse_proxy http://mastodon-streaming:4000 + } + handle /api/v2/streaming* { + reverse_proxy http://mastodon-streaming:4000 + } + handle { + reverse_proxy http://mastodon-web:3000 + } + header { + Strict-Transport-Security "max-age=31536000;" + } + header Onion-Location http://mastodon.{$DWEB_ONION} + header /sw.js Cache-Control "public, max-age=0"; + header /emoji* Cache-Control "public, max-age=31536000, immutable" + header /packs* Cache-Control "public, max-age=31536000, immutable" + header /system/accounts/avatars* Cache-Control "public, max-age=31536000, immutable" + header /system/media_attachments/files* Cache-Control "public, max-age=31536000, immutable" + handle_errors { + @5xx expression `{http.error.status_code} >= 500 && {http.error.status_code} < 600` + rewrite @5xx /500.html + file_server + } +} + + +# Refer to the Caddy docs for more information: +# https://caddyserver.com/docs/caddyfile diff --git a/conf/compose/bridge.docker-compose.yml b/conf/compose/bridge.docker-compose.yml new file mode 100644 index 0000000..8343b2b --- /dev/null +++ b/conf/compose/bridge.docker-compose.yml @@ -0,0 +1,18 @@ +version: '3.8' + +networks: + cenobridge: +volumes: + bridge_storage: +services: +### BRIDGE + # ceno-client "bridge" service is below + bridge: + image: equalitie/ceno-client:v0.21.2 + #networks: + #- cenobridge + ports: + - "28729:28729" + volumes: + - bridge_storage:/var/opt/ouinet + restart: always diff --git a/conf/compose/delta.docker-compose.yml b/conf/compose/delta.docker-compose.yml new file mode 100644 index 0000000..a3f3b40 --- /dev/null +++ b/conf/compose/delta.docker-compose.yml @@ -0,0 +1,62 @@ +version: '3.8' + +networks: + back: +volumes: + mailadm_db: +services: +### DELTA + # postfix is running as a part of the delta chat service + postfix: + image: keith/deltachat-mailadm-postfix:v0.0.3 + entrypoint: + - sh + - -c + - "postconf -M submission/inet=\"submission inet n - n - - smtpd\" && postconf -P submission/inet/syslog_name=postfix/submission && postconf -P submission/inet/smtpd_tls_security_level=encrypt && postconf -P submission/inet/smtpd_sasl_type=dovecot && postconf -P submission/inet/smtpd_sasl_path=inet:localhost:12345 && postconf -P submission/inet/smtpd_sasl_auth_enable=yes && postconf \"myhostname=${DWEB_DOMAIN}\" && postconf \"mydestination=\" && postconf \"virtual_mailbox_domains=${DWEB_DOMAIN}\" && postconf \"virtual_transport=lmtp:localhost:24\" && postconf \"virtual_mailbox_base=/home/vmail\" && postconf \"virtual_mailbox_maps=texthash:/var/lib/mailadm/virtual_mailboxes\" && postconf \"maillog_file=/dev/stdout\" && postconf \"smtpd_tls_cert_file=/certs/fullchain.pem\" && postconf \"smtpd_tls_key_file=/certs/privkey.pem\" && postfix start-fg" + volumes: + - mailadm_db:/var/lib/mailadm/ + - ../caddy/certs/${DWEB_DOMAIN}.crt:/certs/fullchain.pem + - ../caddy/certs/${DWEB_DOMAIN}.key:/certs/privkey.pem + environment: + MAIL_DOMAIN: "${DWEB_DOMAIN}" + networks: + - back + depends_on: + - caddy + restart: always + + # dovecot is running as a part of the delta chat service + dovecot: + image: keith/deltachat-mailadm-dovecot:v0.0.1 + volumes: + - mailadm_db:/var/lib/mailadm/ + - ../caddy/certs/${DWEB_DOMAIN}.crt:/certs/fullchain.pem + - ../caddy/certs/${DWEB_DOMAIN}.key:/certs/privkey.pem + environment: + VMAIL_UID: "${VMAIL_UID}" + VMAIL_GID: "${VMAIL_GID}" + networks: + - back + depends_on: + - caddy + restart: always + + # mailadm is running as a part of the delta chat service + mailadm: + image: keith/deltachat-mailadm:v0.0.1 + entrypoint: + - sh + - -c + - mailadm init --web-endpoint="https://${DWEB_DOMAIN}/new_email" --mail-domain=${DWEB_DOMAIN} --vmail-user=vmail ; mailadm add-token ZMqbnG8P --maxuse 100000 --expiry 999d --token ZMqbnG8P ; gunicorn -b :3691 -w 1 mailadm.app:app + volumes: + - mailadm_db:/var/lib/mailadm/ + environment: + MAIL_DOMAIN: "${DWEB_DOMAIN}" + VMAIL_UID: "${VMAIL_UID}" + VMAIL_GID: "${VMAIL_GID}" + WEB_ENDPOINT: "https://${DWEB_DOMAIN}/new_email" + networks: + - back + depends_on: + - caddy + restart: always diff --git a/conf/compose/docker-compose.yml b/conf/compose/docker-compose.yml new file mode 100644 index 0000000..45a585b --- /dev/null +++ b/conf/compose/docker-compose.yml @@ -0,0 +1,45 @@ +version: '3.8' + +networks: + back: +volumes: + caddy_data: + caddy_config: +services: + + # caddy acts as a reverse proxy for synapse (matrix) + caddy: + image: caddy:2.6.4 + volumes: + - caddy_data:/data + - caddy_config:/config + - type: bind + source: /var/www + target: /www + - type: bind + source: ../caddy/certs + target: /data/caddy/certificates/acme-v02.api.letsencrypt.org-directory/${DWEB_DOMAIN} + networks: + - back + ports: + - target: 80 + published: 80 + protocol: tcp + mode: host + - target: 443 + published: 443 + protocol: tcp + mode: host + environment: + DWEB_DOMAIN: "${DWEB_DOMAIN}" + DWEB_ONION: "${DWEB_ONION}" + configs: + - source: caddy-caddyfile-config + target: /etc/caddy/Caddyfile + restart: always + +configs: + caddy-caddyfile-config: + template_driver: golang + file: ../caddy/Caddyfile.tmpl + external: false diff --git a/conf/compose/element.docker-compose.yml b/conf/compose/element.docker-compose.yml new file mode 100644 index 0000000..3f67245 --- /dev/null +++ b/conf/compose/element.docker-compose.yml @@ -0,0 +1,107 @@ +version: '3.8' + +networks: + back: +volumes: + synapse_data: + synapse_db: +services: +### ELEMENT + # synapse is a matrix homeserver running as a service + synapse: + image: matrixdotorg/synapse:v1.110.0 + entrypoint: + - sh + - -c + - chown -R 991:991 /data ; /start.py + volumes: + - synapse_data:/data + networks: + - back + ports: + - "127.0.0.1:8008:8008" + environment: + SYNAPSE_CONFIG_DIR: "/data" + SYNAPSE_DATA_DIR: "/data" + TZ: "UA" + depends_on: + - caddy + configs: + - source: synapse-homeserver-config + target: /data/homeserver.yaml + uid: '991' + gid: '991' + mode: 0644 + - source: synapse-signingkey-config + target: /data/matrix.${DWEB_DOMAIN}.signing.key + uid: '991' + gid: '991' + mode: 0644 + - source: synapse-logconfig-config + target: /data/matrix.${DWEB_DOMAIN}.log.config + uid: '991' + gid: '991' + mode: 0644 + restart: always + + synapse-pg: + restart: always + image: postgres:14-alpine + healthcheck: + test: ['CMD', 'pg_isready', '-U', 'postgres'] + environment: + - 'POSTGRES_HOST_AUTH_METHOD=trust' + - 'POSTGRES_INITDB_ARGS=--encoding="UTF8" --lc-collate="C" --lc-ctype="C"' + volumes: + - synapse_db:/var/lib/postgresql/data + depends_on: + - caddy + networks: + - back + deploy: + mode: replicated + replicas: 1 + placement: + constraints: + - node.labels.dwebstackdomain == ${DWEB_DOMAIN} + max_replicas_per_node: 1 + resources: + limits: + memory: 512M + + # element is a matrix web GUI running as a service + element: + image: vectorim/element-web:v1.11.69 + networks: + - back + ports: + - "127.0.0.1:8001:8001" + depends_on: + - caddy + - synapse + configs: + - source: element-json-config + target: /app/config.json + - source: element-nginx-config + target: /etc/nginx/conf.d/default.conf + restart: always + +configs: + synapse-homeserver-config: + file: ../synapse/homeserver.yaml + external: false + synapse-signingkey-config: + file: ../synapse/matrix.${DWEB_DOMAIN}.signing.key + external: false + synapse-logconfig-config: + file: ../synapse/matrix.${DWEB_DOMAIN}.log.config + external: false + element-json-config: + template_driver: golang + file: ../element/config.json + external: false + element-nginx-config: + template_driver: golang + file: ../element/nginx.conf + external: false + diff --git a/conf/compose/mastodon.docker-compose.yml b/conf/compose/mastodon.docker-compose.yml new file mode 100644 index 0000000..78d6197 --- /dev/null +++ b/conf/compose/mastodon.docker-compose.yml @@ -0,0 +1,115 @@ +version: '3.8' + +networks: + back: + mast-int: +volumes: + mastodon_public: + mastodon_redis: + mastodon_lockfile: + mastodon_db: +services: +### MASTODON + caddy: + image: caddy:2.6.4 + volumes: + - mastodon_public:/srv/mastodon/public:ro + + mastodon-redis: + restart: always + image: redis:7.0-alpine + healthcheck: + test: ['CMD', 'redis-cli', 'ping'] + env_file: ../mastodon/env.production + volumes: + - mastodon_redis:/data + networks: + - mast-int + restart: always + + mastodon-web: + restart: always + image: tootsuite/mastodon:v4.2.9 + #healthcheck: + #test: ['CMD-SHELL', 'wget -q --spider --proxy=off localhost:3000/health || exit 1'] + #entrypoint: + # - bash + # - -c + # #- "bundle exec rake db:prepare && cd /opt/mastodon && /usr/bin/tini -- bundle exec rails server" + # - "[[ -e /mastodon/public/db.lock ]] && touch /mastodon/public/db.lock || touch /mastodon/public/db.lock && bundle exec rake db:prepare; /usr/bin/tini -- bundle exec rails server" + env_file: ../mastodon/env.production + ports: + - "127.0.0.1:3000:3000" + environment: + LOCAL_DOMAIN: "mastodon.${DWEB_DOMAIN}" + SMTP_FROM_ADDRESS: "notifications${DWEB_DOMAIN}" + command: bash -c "rm -f /mastodon/tmp/pids/server.pid; bundle exec rails s -p 3000" + depends_on: + - mastodon-db + - mastodon-redis + - mastodon-streaming + volumes: + # https://www.digitalocean.com/community/tutorials/how-to-share-data-between-docker-containers + - mastodon_public:/mastodon/public/ # map static files in volume for caddy + networks: + - mast-int + - back + restart: always + + mastodon-streaming: + restart: always + image: tootsuite/mastodon:v4.2.9 + healthcheck: + test: wget -q --spider --proxy=off localhost:4000/api/v1/streaming/health || exit 1 + ] + env_file: ../mastodon/env.production + ports: + - "127.0.0.1:4000:4000" + environment: + LOCAL_DOMAIN: "mastodon.${DWEB_DOMAIN}" + SMTP_FROM_ADDRESS: "notifications@${DWEB_DOMAIN}" + command: node ./streaming + depends_on: + - mastodon-db + - mastodon-redis + networks: + - mast-int + - back + restart: always + + mastodon-sidekiq: + restart: always + image: tootsuite/mastodon:v4.2.9 + #entrypoint: + # - sh + # - -c + # - "service sendmail start && /usr/bin/tini -- bundle exec sidekiq" + healthcheck: + test: ps aux | grep '[s]idekiq\ 6' || false + env_file: ../mastodon/env.production + environment: + LOCAL_DOMAIN: "mastodon.${DWEB_DOMAIN}" + SMTP_FROM_ADDRESS: "notifications@${DWEB_DOMAIN}" + command: bundle exec sidekiq + depends_on: + - mastodon-db + - mastodon-redis + volumes: + - mastodon_public:/mastodon/public/ + networks: + - mast-int + restart: always + + mastodon-db: + restart: always + image: postgres:14-alpine + healthcheck: + test: ['CMD', 'pg_isready', '-U', 'postgres'] + environment: + - 'POSTGRES_HOST_AUTH_METHOD=trust' + volumes: + - mastodon_db:/var/lib/postgresql/data + networks: + - mast-int + restart: always + diff --git a/conf/compose/mau.docker-compose.yml b/conf/compose/mau.docker-compose.yml new file mode 100644 index 0000000..d98cafb --- /dev/null +++ b/conf/compose/mau.docker-compose.yml @@ -0,0 +1,27 @@ +version: '3.8' + +volumes: + mau_data: +services: +### MAU + # mau is a synapse bot we run for news and other things + mau: + image: dock.mau.dev/maubot/maubot:v0.3.1 + configs: + - source: mau-config + target: /data/config.yaml + ports: + - "127.0.0.1:29316:29316" + volumes: + - mau_data:/data/ + networks: + - back + depends_on: + - caddy + - synapse + - element +configs: + mau-config: + file: ../mau/config.yaml + external: false + diff --git a/conf/element/config.json b/conf/element/config.json new file mode 100644 index 0000000..e755771 --- /dev/null +++ b/conf/element/config.json @@ -0,0 +1,37 @@ +{ + "default_server_config": { + "m.homeserver": { + "base_url": "https://matrix.TEMPLATE", + "server_name": "matrix.TEMPLATE" + } + }, + "disable_custom_urls": false, + "disable_guests": false, + "disable_login_language_selector": false, + "disable_3pid_login": true, + "brand": "Element", + "defaultCountryCode": "UA", + "showLabsSettings": false, + "features": { }, + "default_federate": true, + "default_theme": "light", + "roomDirectory": { + "servers": [ + "matrix.kharkiv.dcomm.net.ua", + "matrix.kyiv.dcomm.net.ua", + "matrix.odessa.dcomm.net.ua", + "matrix.lviv.dcomm.net.ua", + "matrix.lviv2.dcomm.net.ua", + "matrix.kherson.dcomm.net.ua", + "matrix.mykolayiv.dcomm.net.ua", + "matrix.rivne.dcomm.net.ua" + ] + }, + "enable_presence_by_hs_url": { + "https://matrix.org": false, + "https://matrix-client.matrix.org": false + }, + "settingDefaults": { + "breadcrumbs": true + } +} diff --git a/conf/element/nginx.conf b/conf/element/nginx.conf new file mode 100644 index 0000000..817a909 --- /dev/null +++ b/conf/element/nginx.conf @@ -0,0 +1,26 @@ +server { + listen 8001; + listen [::]:8001; + server_name localhost; + + root /usr/share/nginx/html; + index index.html; + + # Set no-cache for the version, config and index.html + # so that browsers always check for a new copy of Element Web. + # NB http://your-domain/ and http://your-domain/? are also covered by this + + location = /index.html { + add_header Cache-Control "no-cache"; + } + location = /version { + add_header Cache-Control "no-cache"; + } + # covers config.json and config.hostname.json requests as it is prefix. + location /config { + add_header Cache-Control "no-cache"; + } + # redirect server error pages to the static page /50x.html + # + error_page 500 502 503 504 /50x.html; +} diff --git a/conf/mastodon/example.env.production b/conf/mastodon/example.env.production new file mode 100644 index 0000000..50cd314 --- /dev/null +++ b/conf/mastodon/example.env.production @@ -0,0 +1,20 @@ +# Some variables in this file will be interpreted differently whether you are +# using docker-compose or not. + +LOCAL_DOMAIN=social.REPLACEME +ALTERNATE_DOMAINS=social. +SINGLE_USER_MODE=false +SECRET_KEY_BASE= +OTP_SECRET= +VAPID_KEYS= +DB_HOST=mastodon-db +DB_PORT=5432 +DB_NAME=mastodon +DB_USER=postgres +DB_PASS= +REDIS_HOST=mastodon-redis +REDIS_PORT=6379 +REDIS_PASSWORD= +SMTP_DELIVERY_METHOD= +SMTP_AUTH_METHOD=none +SMTP_OPENSSL_VERIFY_MODE=none diff --git a/install.sh b/install.sh new file mode 100755 index 0000000..374ace3 --- /dev/null +++ b/install.sh @@ -0,0 +1,424 @@ +#!/bin/bash + +RED='\033[0;31m' +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +NC='\033[0m' + +set -e +# Directory to save dcomms config files in +DCOMMS_DIR=$PWD + +COMPOSE_FILES="-f ./conf/compose/docker-compose.yml " + +# Docker saved file names +FILES=( + "dcomms_conf_v2.tar" # If we can grab the install script we can likely grab the configs. + "caddy_2.6.4.tar" +) + +D_IMAGES=("caddy:2.6.4") + + +DCOMMS_INSTANCES=( + "kyiv.dcomm.net.ua" + "odessa.dcomm.net.ua" + "kharkiv.dcomm.net.ua" + "lviv.dcomm.net.ua" + "lviv2.dcomm.net.ua" + "rivne.dcomm.net.ua" + "kherson.dcomm.net.ua" + "mykolayiv.dcomm.net.ua" +) + +IPFS_GATEWAYS=( + "ipfs.io/ipfs" + "cf-ipfs.com/ipfs" + "gateway.ipfs.io/ipfs" + "cloudflare-ipfs.com/ipfs" + "ipfs.best-practice.se/ipfs" + "ipfs.2read.net/ipfs" +) + +IPFS_DIR="QmbCFPd8ACTicxQsuDyUfm1C1jMwveocdVDn2K3nruaaVF" + +#List of trackers for generating the magnet link, only use this once to save on space +MAG_TRACKERS="&tr=udp%3A%2F%2Ftracker.opentrackr.org%3A1337%2Fannounce&tr=udp%3A%2F%2F9.rarbg.com%3A2810%2Fannounce&tr=udp%3A%2F%2Fopen.tracker.cl%3A1337%2Fannounce&tr=udp%3A%2F%2Ftracker.openbittorrent.com%3A6969%2Fannounce&tr=http%3A%2F%2Ftracker.openbittorrent.com%3A80%2Fannounce&tr=udp%3A%2F%2Fopentracker.i2p.rocks%3A6969%2Fannounce&tr=https%3A%2F%2Fopentracker.i2p.rocks%3A443%2Fannounce&tr=udp%3A%2F%2Fwww.torrent.eu.org%3A451%2Fannounce&tr=udp%3A%2F%2Ftracker.torrent.eu.org%3A451%2Fannounce&tr=udp%3A%2F%2Fopen.stealth.si%3A80%2Fannounce&tr=udp%3A%2F%2Fexodus.desync.com%3A6969%2Fannounce&tr=udp%3A%2F%2Ftracker.tiny-vps.com%3A6969%2Fannounce&tr=udp%3A%2F%2Ftracker.dler.org%3A6969%2Fannounce&tr=udp%3A%2F%2Ftr.cili001.com%3A8070%2Fannounce&tr=udp%3A%2F%2Fipv4.tracker.harry.lu%3A80%2Fannounce&tr=udp%3A%2F%2Fexplodie.org%3A6969%2Fannounce&tr=udp%3A%2F%2Fbt.oiyo.tk%3A6969%2Fannounce&tr=https%3A%2F%2Ftracker.nanoha.org%3A443%2Fannounce&tr=https%3A%2F%2Ftracker.logirl.moe%3A443%2Fannounce&tr=https%3A%2F%2Ftracker.lilithraws.org%3A443%2Fannounce" + +#Big ugly blob of links. Yikes +MAGNET_LINKS=( + "magnet:?xt=urn:btih:806E6EA23B5098BB112B1C1EA6ACF1D4E374C1D8&dn=dcomms_conf_v2.tar" + #"magnet:?xt=urn:btih:F1A024E0878324F3749193A28DE6C4C33252E670&dn=caddy_2.6.2.tar" + "magnet:?xt=urn:btih:9F004AEF55ECE1DF2908F6FA33C7FC7CDD5EEE43&dn=ceno-client_latest.tar" + "magnet:?xt=urn:btih:A8865661D17C7C1669738DE3892A245CBFE0B384&dn=deltachat-mailadm-dovecot_v0.0.1.tar" + "magnet:?xt=urn:btih:15DC00304F12941B9DC03103ABE70FA27D4FDB1A&dn=deltachat-mailadm-postfix_v0.0.3.tar" + "magnet:?xt=urn:btih:0DB1E810B538AE6B73C12F20461D8D90ADAE4372&dn=deltachat-mailadm_v0.0.1.tar" + #"magnet:?xt=urn:btih:DD660DDCE77DBEBB3CBCDDE45600203DAD5FE488&dn=element-web_v1.11.17.tar" + #"magnet:?xt=urn:btih:63C98AC0E0F799AEC65D6C6B4005E3748068A339&dn=mastodon_v4.1.0.tar" + "magnet:?xt=urn:btih:5D74122C024622B2E02DE5D852A17D5C22C2C28F&dn=maubot_v0.3.1.tar" + "magnet:?xt=urn:btih:824829D5F526A82C7209160C3E709B4BA6624442&dn=postgres_14-alpine.tar" + "magnet:?xt=urn:btih:4EEDD83F3DD76489F3AB70F07035CDE5B87C0A65&dn=redis_7.0-alpine.tar" + #"magnet:?xt=urn:btih:24116174AF54EC4DD47015E634F3DB1B6B2A9DA3&dn=synapse_v1.74.0.tar" +) + + +FILE_MAGNETS=( + "${MAGNET_LINKS[0]}$MAG_TRACKERS" + "${MAGNET_LINKS[1]}$MAG_TRACKERS" +) + +CONF_MAGNET="" +#CONF_MAGNET="$MAG_TRACKERS" + +export HUB_REACHABLE=false +export DCOMM_REACHABLE=false +export IPFS_REACHABLE=false +export TOR_AVAIL=false +i=0 + +echo "This script requires root access to interact with Docker. Please enter your password if prompted." +sudo echo "" + +#This funciton uses which to discover what packages are installed on this system. +#Should investigate which command has the most interoperability +check_requirements () { + if ! which curl docker >/dev/null; then + printf "${RED}## This script depends on curl and docker.\n" + printf "Please install 'curl' and/or install docker.\n" + printf "https://docs.docker.com/engine/install/${NC}\n" + exit 1 + fi + if ! which aria2c>/dev/null; then + printf "${YELLOW}## This script requires aria2 to download torrents in " + printf "the event that Docker Hub or the dComms servers are unreachable.\n" + printf "If you require this functionality please install 'aria2'${NC}\n" + TORRENT_AVAIL=false + ((i=i+=1)) + else + TORRENT_AVAIL=true + fi + if which tor >/dev/null; then + TOR_AVAIL=true + else + printf "${YELLOW}## This script can take advantage of Tor to route around " + printf "blockages and allow users to connect anonymously to your server.\n" + printf "If you would like this functionality enabled please install 'tor'" + printf "from your package manager and re-run the script.${NC}\n" + fi +} + +detect_connectivity () { + # This function tests all available means to retrieve the dComms repository. + if sudo docker pull hello-world >/dev/null 2>&1; then + sudo docker rmi hello-world >/dev/null 2>&1 + printf "${GREEN}## Successfully connected to Docker Hub${NC}\n" + HUB_REACHABLE=true + else + printf "${RED}## Unable to connect to Docker Hub${NC}\n" + ((i=i+=1)) + fi + + for site in ${DCOMMS_INSTANCES[@]}; do + #this function should be more complex + if curl -s -m 3 https://$site/dcomms/hashes.txt -o /tmp/dcomms; then + if (( $(stat -c %s /tmp/dcomms) > 3 )); then + DCOMM_URL=https://$site/dcomms + printf "${GREEN}## Successfully connected to $site${NC}\n" + DCOMM_REACHABLE=true + rm /tmp/dcomms + break + fi + rm /tmp/dcomms + fi + done + + if [[ "${DCOMM_REACHABLE}" == false ]]; then + printf "${RED}## Unable to connect to dComms instance${NC}\n" + ((i=i+=1)) + fi + + for site in ${IPFS_GATEWAYS[@]}; do + #this function should be more complex + if curl -s -m 30 https://$site/$IPFS_DIR/hashes.txt -o /tmp/dcomms; then + if (( $(stat -c %s /tmp/dcomms) > 3 )); then + IPFS_URL=https://$site/$IPFS_DIR + printf "${GREEN}## Successfully connected to $site${NC}\n" + IPFS_REACHABLE=true + rm /tmp/dcomms + break + fi + rm /tmp/dcomms + fi + done + + if [[ "${IPFS_REACHABLE}" == false ]]; then + printf "${RED}## Unable to connect to IPFS gateway${NC}\n" + ((i=i+=1)) + fi + + # 'i' is the number of failed methods. Change as needed + if (( i == 4 )); then + printf "\n\n${RED}## All methods of retrieving dComms docker images have failed\n" + printf "## Don't despair!\n" + printf "## If you manage to retrieve tarfiles of the images listed below\n" + printf "## place them in the $DCOMMS_DIR folder and re-run this script.\n" + for i in ${D_IMAGES[@]}; do + printf "$i\n" + done + printf "${NC}" + exit 1 + fi + +} + +#Spins up a temporary docker container to generate synapse config files and keys +matrix_config () { + printf "${YELLOW}## Generating synapse config${NC}\n" + sudo docker run -it --rm \ + --mount type=bind,src=$(readlink -f $DCOMMS_DIR/conf/synapse),dst=/data \ + -e SYNAPSE_SERVER_NAME=matrix.$DWEB_DOMAIN \ + -e SYNAPSE_REPORT_STATS=no \ + -e SYNAPSE_DATA_DIR=/data \ + matrixdotorg/synapse:v1.80.0 generate 2>/dev/null + sudo chown -R $USER:$USER $DCOMMS_DIR/conf/synapse/ + + sed -i -z "s/database.*homeserver.db//" $DCOMMS_DIR/conf/element/config.json + sed -i "s/# vim:ft=yaml//" $DCOMMS_DIR/conf/element/config.json + + printf "enable_registration: true\n" >> $DCOMMS_DIR/conf/element/config.json + printf "registration_requires_token: true\n" >> $DCOMMS_DIR/conf/element/config.json + printf "encryption_enabled_by_default_for_room_type: all\n" >> $DCOMMS_DIR/conf/element/config.json + printf "rc_registration:\n per_second: 0.1 \n burst_count: 2\n" >> $DCOMMS_DIR/conf/element/config.json + printf "presence:\n enabled: false\n" >> $DCOMMS_DIR/conf/element/config.json + printf "database:\n name: psycopg2\n txn_limit: 10000\n args:\n" >> $DCOMMS_DIR/conf/element/config.json + printf " user: synapse\n password: null\n database: synapse\n host: localhost\n" >> $DCOMMS_DIR/conf/element/config.json + printf " port: 5432\n cp_min: 5\n cp_max: 10\n" >> $DCOMMS_DIR/conf/element/config.json + + sed -i "s/TEMPLATE/$DWEB_DOMAIN/" $DCOMMS_DIR/conf/element/config.json +} + +#Mastodon's config file requires a number of keys to be generated. We spin up a temporary container to do this. +#Volume must be removed before running +mastodon_config () { + sudo docker volume rm masto_data_tmp 2> /dev/null || true + printf "${YELLOW}## Generating mastodon config${NC}\n" + sudo cp -a $DCOMMS_DIR/conf/mastodon/example.env.production $DCOMMS_DIR/conf/mastodon/env.production + SECRET_KEY_BASE=`sudo docker run -it --rm \ + --mount type=volume,src=masto_data_tmp,dst=/opt/mastodon \ + -e RUBYOPT=-W0 tootsuite/mastodon:v4.2.9 \ + bundle exec rake secret` >/dev/null + + OTP_SECRET=$(sudo docker run -it --rm \ + --mount type=volume,src=masto_data_tmp,dst=/opt/mastodon \ + -e RUBYOPT=-W0 tootsuite/mastodon:v4.2.9 \ + bundle exec rake secret) >/dev/null + + VAPID_KEYS=$(sudo docker run -it --rm \ + --mount type=volume,src=masto_data_tmp,dst=/opt/mastodon \ + -e RUBYOPT=-W0 tootsuite/mastodon:v4.2.9 \ + bundle exec rake mastodon:webpush:generate_vapid_key)>/dev/null + VAPID_FRIENDLY_KEYS=${VAPID_KEYS//$'\n'/\\$'\n'} + + #REDIS_PW=$(openssl rand -base64 12) + + sed -i "s/REPLACEME/$DWEB_DOMAIN/" $DCOMMS_DIR/conf/mastodon/env.production + sed -i "s/SECRET_KEY_BASE=/&$SECRET_KEY_BASE/" $DCOMMS_DIR/conf/mastodon/env.production + sed -i "s/OTP_SECRET=/&$OTP_SECRET/" $DCOMMS_DIR/conf/mastodon/env.production + sed -i "s/VAPID_KEYS=/$VAPID_FRIENDLY_KEYS/" $DCOMMS_DIR/conf/mastodon/env.production + sed -i 's/\r$//g' $DCOMMS_DIR/conf/mastodon/env.production + sed -i "s/ALTERNATE_DOMAINS=social./&$DWEB_ONION/" $DCOMMS_DIR/conf/mastodon/env.production + sed -i "s/SMTP_SERVER=/&$DWEB_DOMAIN/" $DCOMMS_DIR/conf/mastodon/env.production + #sed -i "s/REDIS_PASSWORD=/&$REDIS_PW/" $DCOMMS_DIR/conf/mastodon/env.production + + printf "${YELLOW}## Initializing mastodon database${NC}\n" + + docker compose -f ./conf/compose/mastodon.docker-compose.yml run --rm mastodon-web bundle exec rake db:prepare + docker compose -f ./conf/compose/mastodon.docker-compose.yml run --rm mastodon-web bundle exec rake db:migrate + + docker volume rm -f masto_data_tmp +} + +mau_config () { + printf "${YELLOW}## Generating mau bot config${NC}\n" + sudo docker run --rm --mount type=bind,src=$(readlink -f $DCOMMS_DIR/conf/mau),dst=/data dock.mau.dev/maubot/maubot:v0.3.1 1>&2 >/dev/null + sudo chown -R $USER:$USER $DCOMMS_DIR/conf/mau + MAU_PW=$(tr -dc 'A-Za-z0-9' < /dev/urandom | head -c 18) + printf "${RED}## Mau credentials = admin:$MAU_PW${NC}\n" + MAU_CREDS="admin:$MAU_PW" + sed -i "s/admins:/&\n admin: $MAU_PW/" $DCOMMS_DIR/conf/mau/config.yaml +} + +grab_files () { + j=0 + for file in ${FILES[@]}; do + if [ -f $DCOMMS_DIR/images/$file ]; then + printf "${GREEN}$file found on disk.${NC}\n" + elif [[ "${DCOMM_REACHABLE}" == true ]]; then + printf "${GREEN}Downloading $file using Dcomm mirror.${NC}\n" + curl $DCOMM_URL/$file -o $TMP_DIR_F/$file + elif [[ "${IPFS_REACHABLE}" == true ]]; then + printf "${GREEN}Downloading $file using IPFS.${NC}\n" + curl $IPFS_URL/$file -o $TMP_DIR_F/$file + elif [[ "${TORRENT_AVAIL}" == true ]]; then + printf "${GREEN}Downloading $file using torrent.${NC}\n" + aria2c -d $TMP_DIR_F/$file --seed-time=0 "${FILE_MAGNETS[$j]}" >/dev/null + fi + if (( j == 0 )); then + echo "" + tar -xvf $TMP_DIR_F/$file -C $DCOMMS_DIR >/dev/null + else + mv $TMP_DIR_F/$file $DCOMMS_DIR/images/$file + fi + ((j=j+=1)) + done +} + +#The main function does most of the configuration +main() { + if [ -z $DCOMMS_DIR ]; then + printf "${RED}No directory set for dcomms files.\nPlease edit the " + printf "'DCOMMS_DIR' variable at the top of this script and run again.${NC}\n" + exit 1 + elif [ -f $DCOMMS_DIR/run.sh ]; then # || [ -d $DCOMMS_DIR/conf/ ]; then + printf "${RED}A previous installation of dcomms was found on this system.\n" + printf "To start your services please use 'run.sh' in '$DCOMMS_DIR'.${NC}\n" + exit 1 + fi + + export NEWT_COLORS=' + root=,black + checkbox=,black + entry=,black + ' + export DELTA=false + export MATRIX=false + export CENO=false + export MAU=false + export MASTO=false + check_requirements + + DWEB_DOMAIN=$(whiptail --inputbox "What domain would you like to use?" 8 39 --title "Domain Name" 3>&1 1>&2 2>&3) + exitstatus=$? + if [ $exitstatus = 1 ]; then + printf "${RED}Exiting${NC}\n" + exit 1 + elif [[ -z "${DWEB_DOMAIN}" ]]; then + printf "${RED}This script requires a domain name to function.\n" + printf "${RED}Exiting${NC}\n" + exit 1 + fi + + export DWEB_DOMAIN=$DWEB_DOMAIN + # Replace dots with dashes + export DWEB_FRIENDLY_DOMAIN="${DWEB_DOMAIN//./_}" + + CHOICES=$(whiptail --separate-output --checklist "Which services would you like?" 10 35 5 \ + "1" "Delta Chat" ON \ + "2" "Element & Synapse" ON \ + "3" "Ceno Bridge" ON \ + "4" "Maubot" OFF \ + "5" "Mastodon" OFF 3>&1 1>&2 2>&3) + + if [ -z "$CHOICES" ]; then + echo "No option was selected (user hit Cancel or unselected all options)" + exit + else + for CHOICE in $CHOICES; do + case "$CHOICE" in + "1") + D_IMAGES+=("keith/deltachat-mailadm-postfix:v0.0.3" "keith/deltachat-mailadm-dovecot:v0.0.1" "keith/deltachat-mailadm:v0.0.1") + FILES+=("deltachat-mailadm-dovecot_v0.0.1.tar" "deltachat-mailadm_v0.0.1.tar" "deltachat-mailadm-postfix_v0.0.3.tar") + FILE_MAGNETS+=("${MAGNET_LINKS[3]}$MAG_TRACKERS" "${MAGNET_LINKS[5]}$MAG_TRACKERS" "${MAGNET_LINKS[4]}$MAG_TRACKERS") + COMPOSE_FILES+="-f ./conf/compose/delta.docker-compose.yml " + DELTA=true + ;; + "2") + D_IMAGES+=("vectorim/element-web:v1.11.40" "matrixdotorg/synapse:v1.110.0") + FILES+=("synapse_v1.80.0.tar" "element-web_v1.11.26.tar") + FILE_MAGNETS+=("${MAGNET_LINKS[11]}$MAG_TRACKERS" "${MAGNET_LINKS[6]}$MAG_TRACKERS") + COMPOSE_FILES+="-f ./conf/compose/element.docker-compose.yml " + MATRIX=true + ;; + "3") + D_IMAGES+=("equalitie/ceno-client:v0.21.2") + FILES+=("ceno-client_v0.21.2.tar") + FILE_MAGNETS+=("${MAGNET_LINKS[2]}$MAG_TRACKERS") + COMPOSE_FILES+="-f ./conf/compose/bridge.docker-compose.yml " + CENO=true + ;; + "4") + D_IMAGES+=("dock.mau.dev/maubot/maubot:v0.3.1") + FILES+=("maubot_v0.3.1.tar") + FILE_MAGNETS+=("${MAGNET_LINKS[8]}$MAG_TRACKERS") + COMPOSE_FILES+="-f ./conf/compose/mau.docker-compose.yml " + MAU=true + ;; + "5") + D_IMAGES+=("tootsuite/mastodon:v4.2.9" "redis:7.0-alpine" "postgres:14-alpine") + FILES+=("mastodon_4.1.2.tar" "postgres_14.tar" "redis_7.0.tar") + FILE_MAGNETS+=("${MAGNET_LINKS[7]}$MAG_TRACKERS" "${MAGNET_LINKS[9]}$MAG_TRACKERS" "${MAGNET_LINKS[10]}$MAG_TRACKERS") + COMPOSE_FILES+="-f ./conf/compose/mastodon.docker-compose.yml " + MASTO=true + ;; + *) + echo "Unsupported item $CHOICE!" >&2 + exit 1 + ;; + esac + done + fi + + TMP_DIR_F=$(mktemp -d) + + trap 'rm -rf "$TMP_DIR_C"' EXIT + + if [[ "${MAU}" == true ]] && [[ "${MATRIX}" == false ]]; then + print "${RED}##Mau is a Matrix bot. You must install Matrix as well.${NC}\n" + exit + fi + + if [[ "${TOR_AVAIL}" == true ]]; then + DWEB_ONION=$(whiptail --inputbox "Add a hidden service address (Optional)" 8 44 --title "HS Address" 3>&1 1>&2 2>&3) + export DWEB_ONION=$DWEB_ONION + fi + + detect_connectivity + + mkdir -p $DCOMMS_DIR/images + if [[ "${HUB_REACHABLE}" == true ]]; then + di=1 + printf "${GREEN}### Grabbing images from Docker Hub.${NC}\n" + for img in ${D_IMAGES[@]}; do + echo "dimg = $img" + if sudo docker pull $img; then + unset 'FILES[$di]' + ((di=di+=1)) + fi + + done + fi + grab_files + + #Might be wise to bring this out of this function so that we can validate before loading +# for f in $DCOMMS_DIR/images/*.tar; do +# echo "" +# cat $f | sudo docker load +# done + + echo "#!/bin/bash" > $DCOMMS_DIR/run.sh + if [[ "${MATRIX}" == true ]]; then + matrix_config + fi + if [[ "${MAU}" == true ]]; then + mau_config + echo 'echo "Mau credentials = '${MAU_CREDS}'"' >> $DCOMMS_DIR/run.sh + fi + if [[ "${MASTO}" == true ]]; then + mastodon_config + fi + echo "sudo DWEB_ONION=$DWEB_ONION DWEB_DOMAIN=$DWEB_DOMAIN DWEB_FRIENDLY_DOMAIN=$DWEB_FRIENDLY_DOMAIN docker compose $COMPOSE_FILES up -d" >> $DCOMMS_DIR/run.sh + chmod +x $DCOMMS_DIR/run.sh + printf "${GREEN} dComms succesfully installed! Start your services by running 'run.sh' in $DCOMMS_DIR.${NC}\n" +} + +main