├── .dockerignore ├── .gitignore ├── Dockerfile ├── Example.configs.md ├── LICENSE ├── adds └── start.sh └── readme.md /.dockerignore: -------------------------------------------------------------------------------- 1 | .git 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM debian:buster-slim 2 | 3 | # Maintainer 4 | MAINTAINER Andreas Peters 5 | 6 | # install homerserver template 7 | COPY adds/start.sh /start.sh 8 | 9 | # startup configuration 10 | ENTRYPOINT ["/start.sh"] 11 | CMD ["autostart"] 12 | EXPOSE 8448 13 | VOLUME ["/data"] 14 | 15 | # Git branch to build from 16 | ARG BV_SYN=master 17 | ARG BV_TUR=master 18 | ARG TAG_SYN=v1.3.1 19 | 20 | # user configuration 21 | ENV MATRIX_UID=991 MATRIX_GID=991 22 | 23 | # use --build-arg REBUILD=$(date) to invalidate the cache and upgrade all 24 | # packages 25 | ARG REBUILD=1 26 | RUN set -ex \ 27 | && mkdir /uploads \ 28 | && export DEBIAN_FRONTEND=noninteractive \ 29 | && mkdir -p /var/cache/apt/archives \ 30 | && touch /var/cache/apt/archives/lock \ 31 | && apt-get clean \ 32 | && apt-get update -y -q --fix-missing\ 33 | && apt-get upgrade -y \ 34 | && buildDeps=' \ 35 | file \ 36 | gcc \ 37 | git \ 38 | libevent-dev \ 39 | libffi-dev \ 40 | libgnutls28-dev \ 41 | libjpeg62-turbo-dev \ 42 | libldap2-dev \ 43 | libsasl2-dev \ 44 | libsqlite3-dev \ 45 | libssl-dev \ 46 | libtool \ 47 | libxml2-dev \ 48 | libxslt1-dev \ 49 | linux-headers-amd64 \ 50 | make \ 51 | zlib1g-dev \ 52 | python3-dev \ 53 | python3-setuptools \ 54 | libpq-dev \ 55 | ' \ 56 | && apt-get install -y --no-install-recommends \ 57 | $buildDeps \ 58 | bash \ 59 | coreutils \ 60 | coturn \ 61 | libffi6 \ 62 | libjpeg62-turbo \ 63 | libssl1.1 \ 64 | libtool \ 65 | libxml2 \ 66 | libxslt1.1 \ 67 | pwgen \ 68 | python3 \ 69 | python3-pip \ 70 | python3-jinja2 \ 71 | sqlite \ 72 | libjemalloc2 \ 73 | zlib1g \ 74 | ; \ 75 | pip3 install --upgrade wheel ;\ 76 | pip3 install --upgrade psycopg2;\ 77 | pip3 install --upgrade python-ldap ;\ 78 | pip3 install --upgrade lxml \ 79 | ; \ 80 | groupadd -r -g $MATRIX_GID matrix \ 81 | && useradd -r -d /data -M -u $MATRIX_UID -g matrix matrix \ 82 | && chown -R $MATRIX_UID:$MATRIX_GID /data \ 83 | && chown -R $MATRIX_UID:$MATRIX_GID /uploads \ 84 | && git clone --branch $BV_SYN --depth 1 https://github.com/matrix-org/synapse.git \ 85 | && cd /synapse \ 86 | && git checkout -b tags/$TAG_SYN \ 87 | && pip3 install --upgrade .[all] \ 88 | && GIT_SYN=$(git ls-remote https://github.com/matrix-org/synapse $BV_SYN | cut -f 1) \ 89 | && echo "synapse: $BV_SYN ($GIT_SYN)" >> /synapse.version \ 90 | && cd / \ 91 | && rm -rf /synapse 92 | 93 | USER matrix 94 | ENV LD_PRELOAD="/usr/lib/x86_64-linux-gnu/libjemalloc.so.2" 95 | -------------------------------------------------------------------------------- /Example.configs.md: -------------------------------------------------------------------------------- 1 | ## Setup examples 2 | 3 | These are example setups that can be used as a guide if you happen to use the same setup, or as a reference if your situation differs a bit. 4 | It is still highly recommended to read the [synapse readme](https://github.com/matrix-org/synapse/blob/master/README.rst) which goes in to much more detail. 5 | 6 | ### Server at home behind NAT 7 | 8 | The first thing we need is a DNS A record to your home IP (perferably a static IP, if you don't have that a dynamic dns service could work as well). 9 | If you host more services at home a subdomain can work, such as matrix.example.com. 10 | In this example we're going to host the matrix server on the matrix.example.com subdomain and we're going to assume this runs on the same host as where the main domain is pointing to.
11 | We're going to use version v0.26.0, be sure to use the docker image tag for the version you want to use. 12 | Add the matrix.example.com DNS A record pointing to the same IP as the example.com domain. 13 | When using a subdomain it is recommended to make an SRV record pointing to matrix subdomain:   14 |     `_matrix._tcp.example.com 3600 IN SRV 10 0 8448 matrix.example.com`   15 | 16 | The DNS record should then look something like: 17 | 18 |     `$ dig -t srv _matrix._tcp.example.com` 19 |     `_matrix._tcp.example.com. 3600    IN      SRV     10 0 8448 matrix.example.com.` 20 | 21 | Once that's done we can generate the config files and self signed certificate: 22 | 23 |    ` docker run -v /opt/synapse:/data --rm -e SERVER_NAME=example.com -e REPORT_STATS=no avhost/docker-matrix:v0.26.0 generate` 24 | 25 | At this point it's possible to edit the configuration file homeserver.yaml and turnserver.conf, located in this example in `/opt/synapse` 26 | In homeserver.yaml we may want to enable registration and [recaptcha](https://github.com/matrix-org/synapse/blob/master/docs/CAPTCHA_SETUP.rst) 27 | In turnserver.conf we have to set the external ip and we can change the TURN portrange. The default TURN port range is `49152-65535` but because docker doesn't like publishing large port ranges we'll decrease the portrange here. If you want to keep using the default port range more information can be found [here](https://success.docker.com/article/docker-compose-and-docker-run-hang-when-binding-a-large-port-range). 28 | 29 |     `external-ip=203.0.113.0` 30 |     `min-port=49152` 31 |     `max-port=49300` 32 | 33 | The next step is to forward the relevant ports in the router to the server (note that docker by default writes iptables rules to open the ports needed): 34 | 35 | `443, 8448` TCP for the matrix server (443 for clients 8448 for federation) 36 | `3478, 5349` TCP/UDP for STUN 37 | `49152-49300` TCP/UDP for TURN 38 | 39 | We now need to configure the webserver reverse proxy. This is done to allow clients to connect on the default 443 port and to use a valid certificate (for instance [letsencrypt](https://letsencrypt.org/docs/)). 40 | For more details on reverse proxy look at the documentation for the webserver of choice. Here we give an example config for apache2: 41 | First we need to enable mod_proxy and mod_proxy_http and mod_ssl, if you haven't already: 42 | `# a2enmod proxy proxy_http ssl` 43 | Then we can create the apache config for the subdomain using a reverse proxy by making /etc/apache2/sites-available/matrix.example.com-ssl.conf. 44 | This is an example of a resulting config. Note that letsencrypt should write part of the config using certbot. 45 | 46 | ```apache 47 | 48 | 49 |    ServerName matrix.example.com 50 |    ServerAdmin webmaster@localhost 51 |    DocumentRoot /var/www/html 52 | 53 |    ErrorLog ${APACHE_LOG_DIR}/error.log 54 |    CustomLog ${APACHE_LOG_DIR}/access.log combined 55 | 56 |    RewriteEngine on 57 |    SSLCertificateFile /etc/letsencrypt/live/example.com/fullchain.pem 58 |    SSLCertificateKeyFile /etc/letsencrypt/live/example.com/privkey.pem 59 |    Include /etc/letsencrypt/options-ssl-apache.conf 60 |     61 |       ProxyPass  http://127.0.0.1:8008/ 62 |       ProxyPassReverse  / 63 |     64 |    ProxyVia On 65 |    ProxyPreserveHost On 66 |    RequestHeader set X-Forwarded-Proto 'https' env=HTTPS 67 |    68 |    # vim: syntax=apache ts=4 sw=4 sts=4 sr noet 69 | 70 | ``` 71 | 72 | Once the config is created we'll need to enable the site: 73 | `a2ensite matrix.example.com` 74 | 75 | At this point we're ready to start the server: 76 | `docker run --name=matrix -d --restart=always -p 8448:8448 -p 8008:8008 -p 3478:3478 -p 3478:3478/udp -p 5349:5349/udp -p 5349:5349 -p 49152-49300:49152-49300/udp -p 49152-49300:49152-49300 -v /opt/synapse:/data avhost/docker-matrix:v0.26.0 start` 77 | 78 | After the container successfully started and the reverse proxy is configured we should be able to connect to the server using a matrix client and register a user (if that was enabled in the config). 79 | 80 | If the client connected successfully we should check whether the federation works properly by going to: 81 | 82 | `https://matrix.org/federationtester/api/report?server_name=example.com` 83 | 84 | If everything checks out this means the synapse server is up and running. 85 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | Copyright (C) 2018 AVENTER UG (haftungsbeschraenkt) 294 | 295 | This program is free software; you can redistribute it and/or modify 296 | it under the terms of the GNU General Public License as published by 297 | the Free Software Foundation; either version 2 of the License, or 298 | (at your option) any later version. 299 | 300 | This program is distributed in the hope that it will be useful, 301 | but WITHOUT ANY WARRANTY; without even the implied warranty of 302 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 303 | GNU General Public License for more details. 304 | 305 | You should have received a copy of the GNU General Public License along 306 | with this program; if not, write to the Free Software Foundation, Inc., 307 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 308 | 309 | Also add information on how to contact you by electronic and paper mail. 310 | 311 | If the program is interactive, make it output a short notice like this 312 | when it starts in an interactive mode: 313 | 314 | docker-matrix Copyright (C) 2018 AVENTER UG (haftungsbeschraenkt) 315 | docker-matrix Copyright (C) 2017 Silvio Fricke 316 | docker-matrix comes with ABSOLUTELY NO WARRANTY; 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; 319 | 320 | 321 | Andreas Peters, 7 March 2018 322 | CEO of AVENTER UG 323 | 324 | This General Public License does not permit incorporating your program into 325 | proprietary programs. If your program is a subroutine library, you may 326 | consider it more useful to permit linking proprietary applications with the 327 | library. If this is what you want to do, use the GNU Lesser General 328 | Public License instead of this License. 329 | -------------------------------------------------------------------------------- /adds/start.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | OPTION="${1}" 4 | 5 | if [ ! -z "${ROOTPATH}" ]; then 6 | echo ":: We have changed the semantic and doesn't need the ROOTPATH" 7 | echo ":: variable anymore" 8 | fi 9 | 10 | generate_turn_key() { 11 | local turnkey="${1}" 12 | local filepath="${2}" 13 | 14 | echo "lt-cred-mech" > "${filepath}" 15 | echo "use-auth-secret" >> "${filepath}" 16 | echo "static-auth-secret=${turnkey}" >> "${filepath}" 17 | echo "realm=turn.${SERVER_NAME}" >> "${filepath}" 18 | echo "cert=/data/${SERVER_NAME}.tls.crt" >> "${filepath}" 19 | echo "pkey=/data/${SERVER_NAME}.tls.key" >> "${filepath}" 20 | echo "dh-file=/data/${SERVER_NAME}.tls.dh" >> "${filepath}" 21 | echo "cipher-list=\"HIGH\"" >> "${filepath}" 22 | } 23 | 24 | generate_synapse_file() { 25 | local filepath="${1}" 26 | 27 | python3 -m synapse.app.homeserver \ 28 | --config-path "${filepath}" \ 29 | --generate-config \ 30 | --report-stats ${REPORT_STATS} \ 31 | --server-name ${SERVER_NAME} 32 | } 33 | 34 | configure_homeserver_yaml() { 35 | local turnkey="${1}" 36 | local filepath="${2}" 37 | 38 | local ymltemp="$(mktemp)" 39 | 40 | awk -v TURNURIES="turn_uris: [\"turn:${SERVER_NAME}:3478?transport=udp\", \"turn:${SERVER_NAME}:3478?transport=tcp\"]" \ 41 | -v TURNSHAREDSECRET="turn_shared_secret: \"${turnkey}\"" \ 42 | -v PIDFILE="pid_file: /data/homeserver.pid" \ 43 | -v DATABASE="database: \"/data/homeserver.db\"" \ 44 | -v LOGFILE="log_file: \"/data/homeserver.log\"" \ 45 | -v MEDIASTORE="media_store_path: \"/data/media_store\"" \ 46 | '{ 47 | sub(/turn_shared_secret: "YOUR_SHARED_SECRET"/, TURNSHAREDSECRET); 48 | sub(/turn_uris: \[\]/, TURNURIES); 49 | sub(/pid_file: \/homeserver.pid/, PIDFILE); 50 | sub(/database: "\/homeserver.db"/, DATABASE); 51 | sub(/log_file: "\/homeserver.log"/, LOGFILE); 52 | sub(/media_store_path: "\/media_store"/, MEDIASTORE); 53 | print; 54 | }' "${filepath}" > "${ymltemp}" 55 | 56 | mv ${ymltemp} "${filepath}" 57 | } 58 | 59 | # ${SERVER_NAME}.log.config is autogenerated via --generate-config 60 | configure_log_config() { 61 | sed -i "s|.*filename:\s/homeserver.log| filename: /data/homeserver.log|g" "/data/${SERVER_NAME}.log.config" 62 | } 63 | 64 | case $OPTION in 65 | "start") 66 | if [ -f /data/turnserver.conf ]; then 67 | echo "-=> start turn" 68 | if [ -f /conf/supervisord-turnserver.conf.deactivated ]; then 69 | mv -f /conf/supervisord-turnserver.conf.deactivated /conf/supervisord-turnserver.conf 70 | fi 71 | else 72 | if [ -f /conf/supervisord-turnserver.conf ]; then 73 | mv -f /conf/supervisord-turnserver.conf /conf/supervisord-turnserver.conf.deactivated 74 | fi 75 | fi 76 | 77 | ( 78 | if [ -f /data/vector.im.conf ] || [ -f /data/riot.im.conf ] ; then 79 | echo "The riot web client is now handled via silvio/matrix-riot-docker" 80 | fi 81 | ) 82 | 83 | echo "-=> start matrix" 84 | if (( $EUID == 0 )); then 85 | groupadd -r -g $MATRIX_GID matrix \ 86 | && useradd -r -d /data -M -u $MATRIX_UID -g matrix matrix \ 87 | && chown $MATRIX_UID:$MATRIX_GID /data/* \ 88 | && chown -R $MATRIX_UID:$MATRIX_GID /data \ 89 | && chown -R $MATRIX_UID:$MATRIX_GID /uploads \ 90 | && chmod a+rwx /run 91 | su matrix -c "python3 -m synapse.app.homeserver --config-path /data/homeserver.yaml" & su matrix -c "/usr/bin/turnserver -c /data/turnserver.conf" 92 | else 93 | exec python3 -m synapse.app.homeserver --config-path /data/homeserver.yaml & /usr/bin/turnserver -c /data/turnserver.conf 94 | fi 95 | ;; 96 | 97 | "autostart") 98 | if [ -f /data/homeserver.yaml ]; then 99 | if [ -f /data/turnserver.conf ]; then 100 | echo "-=> start turn" 101 | fi 102 | ( 103 | if [ -f /data/vector.im.conf ] || [ -f /data/riot.im.conf ] ; then 104 | echo "The riot web client is now handled via silvio/matrix-riot-docker" 105 | fi 106 | ) 107 | echo "-=> start matrix" 108 | if (( $EUID == 0 )); then 109 | groupadd -r -g $MATRIX_GID matrix \ 110 | && useradd -r -d /data -M -u $MATRIX_UID -g matrix matrix \ 111 | && chown $MATRIX_UID:$MATRIX_GID /data/* \ 112 | && chown -R $MATRIX_UID:$MATRIX_GID /data \ 113 | && chown -R $MATRIX_UID:$MATRIX_GID /uploads \ 114 | && chmod a+rwx /run 115 | su matrix -c "python3 -m synapse.app.homeserver --config-path /data/homeserver.yaml" & su matrix -c "/usr/bin/turnserver -c /data/turnserver.conf" 116 | else 117 | exec python3 -m synapse.app.homeserver --config-path /data/homeserver.yaml & /usr/bin/turnserver -c /data/turnserver.conf 118 | fi 119 | else 120 | breakup="0" 121 | [[ -z "${SERVER_NAME}" ]] && echo "STOP! environment variable SERVER_NAME must be set" && breakup="1" 122 | [[ -z "${REPORT_STATS}" ]] && echo "STOP! environment variable REPORT_STATS must be set to 'no' or 'yes'" && breakup="1" 123 | [[ "${REPORT_STATS}" != "yes" ]] && [[ "${REPORT_STATS}" != "no" ]] && \ 124 | echo "STOP! REPORT_STATS needs to be 'no' or 'yes'" && breakup="1" 125 | 126 | [[ "${breakup}" == "1" ]] && exit 1 127 | 128 | echo "-=> generate turn config" 129 | turnkey=$(pwgen -s 64 1) 130 | generate_turn_key $turnkey /data/turnserver.conf 131 | 132 | echo "-=> generate synapse config" 133 | generate_synapse_file /data/homeserver.tmp 134 | echo "-=> configure some settings in homeserver.yaml" 135 | configure_homeserver_yaml $turnkey /data/homeserver.tmp 136 | 137 | mv /data/homeserver.tmp /data/homeserver.yaml 138 | 139 | echo "-=> configure some settings in ${SERVER_NAME}.log.config" 140 | configure_log_config 141 | 142 | echo "" 143 | echo "-=> you have to review the generated configuration file homeserver.yaml" 144 | fi 145 | ;; 146 | 147 | "stop") 148 | echo "-=> stop matrix" 149 | echo "-=> via docker stop ..." 150 | ;; 151 | 152 | "version") 153 | echo "-=> Matrix Version" 154 | cat /synapse.version 155 | ;; 156 | 157 | "diff") 158 | echo "-=> Diff between local configfile and a fresh generated config file" 159 | echo "-=> some values are different in technical point of view, like" 160 | echo "-=> autogenerated secret keys etc..." 161 | 162 | DIFFPARAMS="${DIFFPARAMS:-Naur}" 163 | SERVER_NAME="${SERVER_NAME:-demo_server_name}" 164 | REPORT_STATS="${REPORT_STATS:-no_or_yes}" 165 | export SERVER_NAME REPORT_STATS 166 | 167 | generate_synapse_file /tmp/homeserver.synapse.yaml 168 | diff -${DIFFPARAMS} /tmp/homeserver.synapse.yaml /data/homeserver.yaml 169 | ;; 170 | 171 | "generate") 172 | breakup="0" 173 | [[ -z "${SERVER_NAME}" ]] && echo "STOP! environment variable SERVER_NAME must be set" && breakup="1" 174 | [[ -z "${REPORT_STATS}" ]] && echo "STOP! environment variable REPORT_STATS must be set to 'no' or 'yes'" && breakup="1" 175 | [[ "${REPORT_STATS}" != "yes" ]] && [[ "${REPORT_STATS}" != "no" ]] && \ 176 | echo "STOP! REPORT_STATS needs to be 'no' or 'yes'" && breakup="1" 177 | 178 | [[ "${breakup}" == "1" ]] && exit 1 179 | 180 | echo "-=> generate turn config" 181 | turnkey=$(pwgen -s 64 1) 182 | generate_turn_key $turnkey /data/turnserver.conf 183 | 184 | echo "-=> generate synapse config" 185 | generate_synapse_file /data/homeserver.tmp 186 | echo "-=> configure some settings in homeserver.yaml" 187 | configure_homeserver_yaml $turnkey /data/homeserver.tmp 188 | 189 | mv /data/homeserver.tmp /data/homeserver.yaml 190 | 191 | echo "-=> configure some settings in ${SERVER_NAME}.log.config" 192 | configure_log_config 193 | 194 | echo "" 195 | echo "-=> you have to review the generated configuration file homeserver.yaml" 196 | ;; 197 | 198 | *) 199 | echo "-=> unknown \'$OPTION\'" 200 | ;; 201 | esac 202 | 203 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # Docker image for Matrix 2 | 3 | - [Matrix Chat](https://riot.im/app/#/room/#dockermatrix:matrix.aventer.biz) 4 | - [Docker Hub](https://hub.docker.com/r/avhost/docker-matrix/tags) 5 | - [Donation](https://liberapay.com/docker-matrix/) 6 | 7 | ## Notice 8 | 9 | With v0.99.5 we publish some changes that can breake the backward compatibility. 10 | 11 | We change to python3. We could not test everything. Please come into our chat and/or open a issue on github. 12 | 13 | Please make sure to use our tagged docker images and not the latest one. Specifically in a production environment you should never use :latest as that the version can be broken. 14 | 15 | ## Creating Issues and Pull request 16 | 17 | We are working with the repository at "https://github.com/AVENTER-UG/docker-matrix". If you want to open issues or create pull request, please use that repository. 18 | 19 | ## Security 20 | 21 | We verify the docker layers of our image automaticly with clair. Matrix is not a part of the vulnerability scan, which means clair will only find vulnerabilities that are part of the OS (operating system). 22 | 23 | ## Introduction 24 | 25 | Dockerfile for installation of [matrix] open federated Instant Messaging and 26 | VoIP communication server. 27 | 28 | The riot.im web client has now his own docker file at [github]. 29 | 30 | [matrix]: https://matrix.org 31 | [github]: https://github.com/AVENTER-UG/matrix-riot-docker 32 | 33 | ## Contribution 34 | 35 | If you want contribute to this project feel free to fork this project, do your 36 | work in a branch and create a pull request. 37 | 38 | To support this Dockerimage please pledge via [liberapay]. 39 | 40 | [liberapay]: https://liberapay.com/docker-matrix/ 41 | 42 | ## Configuration 43 | 44 | To configure run the image with "generate" as argument. You have to setup the 45 | server domain and a `/data`-directory. After this you have to edit the 46 | generated homeserver.yaml file. 47 | 48 | Please read the synapse [readme file] about configuration settings, 49 | there is also an [example setup] available to read. 50 | 51 | [readme file]: https://github.com/matrix-org/synapse/blob/master/README.rst 52 | [example setup]: https://github.com/AVENTER-UG/docker-matrix/blob/master/Example.configs.md 53 | 54 | To get the things done, "generate" will create a self-signed certificate, which should be replaced with a valid certificate if used in production, either by giving synapse access to the valid certificate, or by using a reverse proxy. 55 | 56 | It is recommended to run the container with a --user : flag, to prevent the container from running as root. However, the synapse process will not run as root if the user flag is not supplied. 57 | 58 | Example: 59 | 60 | $ docker run -v /tmp/data:/data --rm --user 991:991 -e SERVER_NAME=localhost -e REPORT_STATS=no avhost/docker-matrix: generate 61 | 62 | ## Start 63 | 64 | For starting you need the port bindings and a mapping for the 65 | `/data`-directory. 66 | 67 | $ docker run -d --user 991:991 -p 8448:8448 -p 8008:8008 -p 3478:3478 -v /tmp/data:/data avhost/docker-matrix: start 68 | 69 | ## Port configurations 70 | 71 | ### Matrix Homeserver 72 | 73 | The following ports are used in the container for the Matrix server. You can use `-p`-option on 74 | `docker run` to configure this part (eg.: `-p 443:8448`): 75 | `8008,8448 tcp` 76 | 77 | ### Coturn server 78 | 79 | If you only need STUN to work you need the following ports: 80 | `3478, 5349 udp/tcp` 81 | The server has the following as alt-ports: `3479, 5350 udp/tcp` 82 | 83 | For TURN (using the server as a relay) you also need to forward this portrange: 84 | `49152-65535/udp` 85 | 86 | You may also have to set the external ip of the server in turnserver.conf which is located in the `/data` volume: 87 | `external-ip=XX.XX.XX.XX` 88 | 89 | In case you don't want to expose the whole port range on udp you can change the portrange in turnserver.conf: 90 | `min-port=XXXXX` 91 | `max-port=XXXXX` 92 | 93 | ## Version information 94 | 95 | To get the installed synapse version you can run the image with `version` as 96 | argument or look at the container via cat. 97 | 98 | $ docker run -ti --rm avhost/docker-matrix: version 99 | -=> Matrix Version 100 | synapse: master (7e0a1683e639c18bd973f825b91c908966179c15) 101 | coturn: master (88bd6268d8f4cdfdfaffe4f5029d489564270dd6) 102 | 103 | # docker exec -it CONTAINERID cat /synapse.version 104 | synapse: master (7e0a1683e639c18bd973f825b91c908966179c15) 105 | coturn: master (88bd6268d8f4cdfdfaffe4f5029d489564270dd6) 106 | 107 | 108 | ## Environment variables 109 | 110 | * `SERVER_NAME`: Server and domain name, mandatory, needed only for `generate` 111 | * `REPORT_STATS`: statistic report, mandatory, values: `yes` or `no`, needed 112 | only for `generate` 113 | * `MATRIX_UID`/`MATRIX_GID`: UserID and GroupID of user within container which 114 | runs the synapse server, if the --user flag is not supplied. The files mounted under /data are `chown`ed to this 115 | ownership. Default is `MATRIX_UID=991` and `MATRIX_GID=991`. It can overriden 116 | via `-e MATRIX_UID=...` and `-e MATRIX_GID=...` at start time. 117 | * `LD_PRELOAD` This is set by default to use jemalloc as memory allocator, as 118 | that has been shown to greatly reduce the memory useage of synapse. To use the default malloc 119 | the environmental variable has to be emptied, by adding `-e LD_PRELOAD` when running the container. 120 | 121 | ## build specific arguments 122 | 123 | * `BV_SYN`: synapse version, optional, defaults to `master` 124 | * `BV_TUR`: coturn turnserver version, optional, defaults to `master` 125 | 126 | For building of synapse version v0.11.0-rc2 and coturn with commit a9fc47e add 127 | `--build-arg BV_SYN=v0.11.0-rc2 --build-arg BV_TUR=a9fc47efd77` to the `docker 128 | build` command. 129 | 130 | ## diff between system and fresh generated config file 131 | 132 | To get a hint about new options etc you can do a diff between your configured 133 | homeserver.yaml and a newly created config file. Call your image with `diff` as 134 | argument. 135 | 136 | 137 | ``` 138 | $ docker run --rm -ti -v /tmp/data:/data avhost/docker-matrix: diff 139 | [...] 140 | +# ldap_config: 141 | +# enabled: true 142 | +# server: "ldap://localhost" 143 | +# port: 389 144 | +# tls: false 145 | +# search_base: "ou=Users,dc=example,dc=com" 146 | +# search_property: "cn" 147 | +# email_property: "email" 148 | +# full_name_property: "givenName" 149 | [...] 150 | ``` 151 | 152 | For generating of this output its `diff` from `busybox` used. The used diff 153 | parameters can be changed through `DIFFPARAMS` environment variable. The 154 | default is `Naur`. 155 | 156 | 157 | ## Exported volumes 158 | 159 | * `/data`: data-container 160 | 161 | --------------------------------------------------------------------------------