Synapse v1.107.0

Signed-off-by: Tommy <contact@tommytran.io>

.github/workflows/build.yml

@@ -27,23 +27,23 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v2
 
       - name: Extract version for tags
         run: |
-          echo "FULL_VERSION=$(grep -oP '(?<=SYNAPSE_VERSION=).*' Dockerfile)" >> $GITHUB_ENV
+          echo "FULL_VERSION=$(grep -oP '(?<=SYNAPSE_VERSION=).*' Dockerfile | head -c6)" >> $GITHUB_ENV
-          echo "MAJOR_VERSION=$(grep -oP '(?<=SYNAPSE_VERSION=).*' Dockerfile | head -c5)" >> $GITHUB_ENV
+          echo "MAJOR_VERSION=$(grep -oP '(?<=SYNAPSE_VERSION=).*' Dockerfile | head -c4)" >> $GITHUB_ENV
 
       - name: Install cosign
         if: github.event_name != 'pull_request'
-        uses: sigstore/cosign-installer@v3
+        uses: sigstore/cosign-installer@main
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
+        uses: docker/setup-buildx-action@v2
 
       - name: Login to registry
         if: github.event_name != 'pull_request'
-        uses: docker/login-action@v3
+        uses: docker/login-action@v2
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.repository_owner }}
@@ -51,7 +51,7 @@ jobs:
 
       - name: Set Docker metadata
         id: meta
-        uses: docker/metadata-action@v5
+        uses: docker/metadata-action@v4
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
           tags: |
@@ -61,7 +61,7 @@ jobs:
 
       - name: Build and push Docker image
         id: build-and-push
-        uses: docker/build-push-action@v5
+        uses: docker/build-push-action@v3
         with:
           context: .
           push: ${{ github.event_name != 'pull_request' }}
@@ -72,6 +72,7 @@ jobs:
         if: ${{ github.event_name != 'pull_request' }}
         run: cosign sign ${TAGS} -y
         env:
+          COSIGN_EXPERIMENTAL: "true"
           TAGS: ${{ steps.meta.outputs.tags }}
 
   scan:

Dockerfile

@@ -1,53 +1,59 @@
+# Copyright (C) 2023-2024 Thien Tran, Wonderfall
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
 ARG SYNAPSE_VERSION=1.107.0
-ARG PYTHON_VERSION=3.12
+ARG PYTHON_VERSION=3.11
-ARG HARDENED_MALLOC_VERSION=2024052100
+ARG HARDENED_MALLOC_VERSION=11
 ARG UID=991
 ARG GID=991
 
 
 ### Build Hardened Malloc
-FROM alpine:latest as hmalloc-builder
+FROM alpine:latest as build-malloc
 
 ARG HARDENED_MALLOC_VERSION
 ARG CONFIG_NATIVE=false
 ARG VARIANT=default
 
 RUN apk -U upgrade \
-    && apk --no-cache add build-base git gnupg openssh-keygen
+ && apk --no-cache add build-base git gnupg && cd /tmp \
-    
+ && wget -q https://github.com/thestinger.gpg && gpg --import thestinger.gpg \
-RUN cd /tmp \
+ && git clone --depth 1 --branch ${HARDENED_MALLOC_VERSION} https://github.com/GrapheneOS/hardened_malloc \
-    && git clone --depth 1 --branch ${HARDENED_MALLOC_VERSION} https://github.com/GrapheneOS/hardened_malloc \
+ && cd hardened_malloc && git verify-tag $(git describe --tags) \
-    && cd hardened_malloc \
+ && make CONFIG_NATIVE=${CONFIG_NATIVE} VARIANT=${VARIANT}
-    && wget -q https://grapheneos.org/allowed_signers -O grapheneos_allowed_signers \
-    && git config gpg.ssh.allowedSignersFile grapheneos_allowed_signers \
-    && git verify-tag $(git describe --tags) \
-    && make CONFIG_NATIVE=${CONFIG_NATIVE} VARIANT=${VARIANT}
 
 
 ### Build Synapse
-FROM python:${PYTHON_VERSION}-alpine as synapse-builder
+FROM python:${PYTHON_VERSION}-alpine as builder
 
 ARG SYNAPSE_VERSION
 
 RUN apk -U upgrade \
-    && apk --no-cache add -t build-deps build-base libffi-dev libjpeg-turbo-dev libxslt-dev linux-headers openssl-dev postgresql-dev rustup zlib-dev
+ && apk --no-cache add -t build-deps \
-    
+        build-base \
-RUN rustup-init -y && source $HOME/.cargo/env \
+        libffi-dev \
-    && pip install --upgrade pip \
+        libjpeg-turbo-dev \
-    && pip install --prefix="/install" --no-warn-script-location \
+        libxslt-dev \
-    matrix-synapse[all]==${SYNAPSE_VERSION}
+        linux-headers \
-
+        openssl-dev \
-
+        postgresql-dev \
-### Get RootFS Files
+        rustup \
-FROM alpine:latest as rootfs
+        zlib-dev \
-
+ && rustup-init -y && source $HOME/.cargo/env \
-ARG SYNAPSE_VERSION
+ && pip install --upgrade pip \
-
+ && pip install --prefix="/install" --no-warn-script-location \
-RUN apk -U upgrade \
+        matrix-synapse[all]==${SYNAPSE_VERSION}
-    && apk --no-cache add git
-
-RUN cd /tmp \
-    && git clone --depth 1 --branch v${SYNAPSE_VERSION} https://github.com/element-hq/synapse
 
 
 ### Build Production
@@ -60,18 +66,29 @@ ARG UID
 ARG GID
 
 RUN apk -U upgrade \
-    && apk --no-cache add -t run-deps libffi libgcc libjpeg-turbo libstdc++ libxslt libpq openssl zlib tzdata xmlsec git curl icu-libs \
+ && apk --no-cache add -t run-deps \
-    && rm -rf /var/cache/apk/*
+        libffi \
-
+        libgcc \
-RUN adduser -g ${GID} -u ${UID} --disabled-password --gecos "" synapse
+        libjpeg-turbo \
+        libstdc++ \
+        libxslt \
+        libpq \
+        openssl \
+        zlib \
+        tzdata \
+        xmlsec \
+        git \
+        curl \
+        icu-libs \
+ && adduser -g ${GID} -u ${UID} --disabled-password --gecos "" synapse \
+ && rm -rf /var/cache/apk/*
 
 RUN pip install --upgrade pip \
-    && pip install -e "git+https://github.com/matrix-org/mjolnir.git#egg=mjolnir&subdirectory=synapse_antispam"
+ && pip install -e "git+https://github.com/matrix-org/mjolnir.git#egg=mjolnir&subdirectory=synapse_antispam"
 
-COPY --from=hmalloc-builder /tmp/hardened_malloc/out/libhardened_malloc.so /usr/local/lib/
+COPY --from=build-malloc /tmp/hardened_malloc/out/libhardened_malloc.so /usr/local/lib/
-COPY --from=synapse-builder /install /usr/local
+COPY --from=builder /install /usr/local
-COPY --from=rootfs --chown=synapse:synapse /tmp/synapse/docker/start.py /start.py
+COPY --chown=synapse:synapse rootfs /
-COPY --from=rootfs --chown=synapse:synapse /tmp/synapse/docker/conf /conf
 
 ENV LD_PRELOAD="/usr/local/lib/libhardened_malloc.so"
 

LICENSE

@@ -1,661 +1,201 @@
-                    GNU AFFERO GENERAL PUBLIC LICENSE
+                                 Apache License
-                       Version 3, 19 November 2007
+                           Version 2.0, January 2004
-
+                        http://www.apache.org/licenses/
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+
- Everyone is permitted to copy and distribute verbatim copies
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
- of this license document, but changing it is not allowed.
+
-
+   1. Definitions.
-                            Preamble
+
-
+      "License" shall mean the terms and conditions for use, reproduction,
-  The GNU Affero General Public License is a free, copyleft license for
+      and distribution as defined by Sections 1 through 9 of this document.
-software and other kinds of works, specifically designed to ensure
+
-cooperation with the community in the case of network server software.
+      "Licensor" shall mean the copyright owner or entity authorized by
-
+      the copyright owner that is granting the License.
-  The licenses for most software and other practical works are designed
+
-to take away your freedom to share and change the works.  By contrast,
+      "Legal Entity" shall mean the union of the acting entity and all
-our General Public Licenses are intended to guarantee your freedom to
+      other entities that control, are controlled by, or are under common
-share and change all versions of a program--to make sure it remains free
+      control with that entity. For the purposes of this definition,
-software for all its users.
+      "control" means (i) the power, direct or indirect, to cause the
-
+      direction or management of such entity, whether by contract or
-  When we speak of free software, we are referring to freedom, not
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-price.  Our General Public Licenses are designed to make sure that you
+      outstanding shares, or (iii) beneficial ownership of such entity.
-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
+      "You" (or "Your") shall mean an individual or Legal Entity
-want it, that you can change the software or use pieces of it in new
+      exercising permissions granted by this License.
-free programs, and that you know you can do these things.
+
-
+      "Source" form shall mean the preferred form for making modifications,
-  Developers that use our General Public Licenses protect your rights
+      including but not limited to software source code, documentation
-with two steps: (1) assert copyright on the software, and (2) offer
+      source, and configuration files.
-you this License which gives you legal permission to copy, distribute
+
-and/or modify the software.
+      "Object" form shall mean any form resulting from mechanical
-
+      transformation or translation of a Source form, including but
-  A secondary benefit of defending all users' freedom is that
+      not limited to compiled object code, generated documentation,
-improvements made in alternate versions of the program, if they
+      and conversions to other media types.
-receive widespread use, become available for other developers to
+
-incorporate.  Many developers of free software are heartened and
+      "Work" shall mean the work of authorship, whether in Source or
-encouraged by the resulting cooperation.  However, in the case of
+      Object form, made available under the License, as indicated by a
-software used on network servers, this result may fail to come about.
+      copyright notice that is included in or attached to the work
-The GNU General Public License permits making a modified version and
+      (an example is provided in the Appendix below).
-letting the public access it on a server without ever releasing its
+
-source code to the public.
+      "Derivative Works" shall mean any work, whether in Source or Object
-
+      form, that is based on (or derived from) the Work and for which the
-  The GNU Affero General Public License is designed specifically to
+      editorial revisions, annotations, elaborations, or other modifications
-ensure that, in such cases, the modified source code becomes available
+      represent, as a whole, an original work of authorship. For the purposes
-to the community.  It requires the operator of a network server to
+      of this License, Derivative Works shall not include works that remain
-provide the source code of the modified version running there to the
+      separable from, or merely link (or bind by name) to the interfaces of,
-users of that server.  Therefore, public use of a modified version, on
+      the Work and Derivative Works thereof.
-a publicly accessible server, gives the public access to the source
+
-code of the modified version.
+      "Contribution" shall mean any work of authorship, including
-
+      the original version of the Work and any modifications or additions
-  An older license, called the Affero General Public License and
+      to that Work or Derivative Works thereof, that is intentionally
-published by Affero, was designed to accomplish similar goals.  This is
+      submitted to Licensor for inclusion in the Work by the copyright owner
-a different license, not a version of the Affero GPL, but Affero has
+      or by an individual or Legal Entity authorized to submit on behalf of
-released a new version of the Affero GPL which permits relicensing under
+      the copyright owner. For the purposes of this definition, "submitted"
-this license.
+      means any form of electronic, verbal, or written communication sent
-
+      to the Licensor or its representatives, including but not limited to
-  The precise terms and conditions for copying, distribution and
+      communication on electronic mailing lists, source code control systems,
-modification follow.
+      and issue tracking systems that are managed by, or on behalf of, the
-
+      Licensor for the purpose of discussing and improving the Work, but
-                       TERMS AND CONDITIONS
+      excluding communication that is conspicuously marked or otherwise
-
+      designated in writing by the copyright owner as "Not a Contribution."
-  0. Definitions.
+
-
+      "Contributor" shall mean Licensor and any individual or Legal Entity
-  "This License" refers to version 3 of the GNU Affero General Public License.
+      on behalf of whom a Contribution has been received by Licensor and
-
+      subsequently incorporated within the Work.
-  "Copyright" also means copyright-like laws that apply to other kinds of
+
-works, such as semiconductor masks.
+   2. Grant of Copyright License. Subject to the terms and conditions of
-
+      this License, each Contributor hereby grants to You a perpetual,
-  "The Program" refers to any copyrightable work licensed under this
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-License.  Each licensee is addressed as "you".  "Licensees" and
+      copyright license to reproduce, prepare Derivative Works of,
-"recipients" may be individuals or organizations.
+      publicly display, publicly perform, sublicense, and distribute the
-
+      Work and such Derivative Works in Source or Object form.
-  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
+   3. Grant of Patent License. Subject to the terms and conditions of
-exact copy.  The resulting work is called a "modified version" of the
+      this License, each Contributor hereby grants to You a perpetual,
-earlier work or a work "based on" the earlier work.
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-
+      (except as stated in this section) patent license to make, have made,
-  A "covered work" means either the unmodified Program or a work based
+      use, offer to sell, sell, import, and otherwise transfer the Work,
-on the Program.
+      where such license applies only to those patent claims licensable
-
+      by such Contributor that are necessarily infringed by their
-  To "propagate" a work means to do anything with it that, without
+      Contribution(s) alone or by combination of their Contribution(s)
-permission, would make you directly or secondarily liable for
+      with the Work to which such Contribution(s) was submitted. If You
-infringement under applicable copyright law, except executing it on a
+      institute patent litigation against any entity (including a
-computer or modifying a private copy.  Propagation includes copying,
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
-distribution (with or without modification), making available to the
+      or a Contribution incorporated within the Work constitutes direct
-public, and in some countries other activities as well.
+      or contributory patent infringement, then any patent licenses
-
+      granted to You under this License for that Work shall terminate
-  To "convey" a work means any kind of propagation that enables other
+      as of the date such litigation is filed.
-parties to make or receive copies.  Mere interaction with a user through
+
-a computer network, with no transfer of a copy, is not conveying.
+   4. Redistribution. You may reproduce and distribute copies of the
-
+      Work or Derivative Works thereof in any medium, with or without
-  An interactive user interface displays "Appropriate Legal Notices"
+      modifications, and in Source or Object form, provided that You
-to the extent that it includes a convenient and prominently visible
+      meet the following conditions:
-feature that (1) displays an appropriate copyright notice, and (2)
+
-tells the user that there is no warranty for the work (except to the
+      (a) You must give any other recipients of the Work or
-extent that warranties are provided), that licensees may convey the
+          Derivative Works a copy of this License; and
-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
+      (b) You must cause any modified files to carry prominent notices
-menu, a prominent item in the list meets this criterion.
+          stating that You changed the files; and
-
+
-  1. Source Code.
+      (c) You must retain, in the Source form of any Derivative Works
-
+          that You distribute, all copyright, patent, trademark, and
-  The "source code" for a work means the preferred form of the work
+          attribution notices from the Source form of the Work,
-for making modifications to it.  "Object code" means any non-source
+          excluding those notices that do not pertain to any part of
-form of a work.
+          the Derivative Works; and
-
+
-  A "Standard Interface" means an interface that either is an official
+      (d) If the Work includes a "NOTICE" text file as part of its
-standard defined by a recognized standards body, or, in the case of
+          distribution, then any Derivative Works that You distribute must
-interfaces specified for a particular programming language, one that
+          include a readable copy of the attribution notices contained
-is widely used among developers working in that language.
+          within such NOTICE file, excluding those notices that do not
-
+          pertain to any part of the Derivative Works, in at least one
-  The "System Libraries" of an executable work include anything, other
+          of the following places: within a NOTICE text file distributed
-than the work as a whole, that (a) is included in the normal form of
+          as part of the Derivative Works; within the Source form or
-packaging a Major Component, but which is not part of that Major
+          documentation, if provided along with the Derivative Works; or,
-Component, and (b) serves only to enable use of the work with that
+          within a display generated by the Derivative Works, if and
-Major Component, or to implement a Standard Interface for which an
+          wherever such third-party notices normally appear. The contents
-implementation is available to the public in source code form.  A
+          of the NOTICE file are for informational purposes only and
-"Major Component", in this context, means a major essential component
+          do not modify the License. You may add Your own attribution
-(kernel, window system, and so on) of the specific operating system
+          notices within Derivative Works that You distribute, alongside
-(if any) on which the executable work runs, or a compiler used to
+          or as an addendum to the NOTICE text from the Work, provided
-produce the work, or an object code interpreter used to run it.
+          that such additional attribution notices cannot be construed
-
+          as modifying the License.
-  The "Corresponding Source" for a work in object code form means all
+
-the source code needed to generate, install, and (for an executable
+      You may add Your own copyright statement to Your modifications and
-work) run the object code and to modify the work, including scripts to
+      may provide additional or different license terms and conditions
-control those activities.  However, it does not include the work's
+      for use, reproduction, or distribution of Your modifications, or
-System Libraries, or general-purpose tools or generally available free
+      for any such Derivative Works as a whole, provided Your use,
-programs which are used unmodified in performing those activities but
+      reproduction, and distribution of the Work otherwise complies with
-which are not part of the work.  For example, Corresponding Source
+      the conditions stated in this License.
-includes interface definition files associated with source files for
+
-the work, and the source code for shared libraries and dynamically
+   5. Submission of Contributions. Unless You explicitly state otherwise,
-linked subprograms that the work is specifically designed to require,
+      any Contribution intentionally submitted for inclusion in the Work
-such as by intimate data communication or control flow between those
+      by You to the Licensor shall be under the terms and conditions of
-subprograms and other parts of the work.
+      this License, without any additional terms or conditions.
-
+      Notwithstanding the above, nothing herein shall supersede or modify
-  The Corresponding Source need not include anything that users
+      the terms of any separate license agreement you may have executed
-can regenerate automatically from other parts of the Corresponding
+      with Licensor regarding such Contributions.
-Source.
+
-
+   6. Trademarks. This License does not grant permission to use the trade
-  The Corresponding Source for a work in source code form is that
+      names, trademarks, service marks, or product names of the Licensor,
-same work.
+      except as required for reasonable and customary use in describing the
-
+      origin of the Work and reproducing the content of the NOTICE file.
-  2. Basic Permissions.
+
-
+   7. Disclaimer of Warranty. Unless required by applicable law or
-  All rights granted under this License are granted for the term of
+      agreed to in writing, Licensor provides the Work (and each
-copyright on the Program, and are irrevocable provided the stated
+      Contributor provides its Contributions) on an "AS IS" BASIS,
-conditions are met.  This License explicitly affirms your unlimited
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-permission to run the unmodified Program.  The output from running a
+      implied, including, without limitation, any warranties or conditions
-covered work is covered by this License only if the output, given its
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-content, constitutes a covered work.  This License acknowledges your
+      PARTICULAR PURPOSE. You are solely responsible for determining the
-rights of fair use or other equivalent, as provided by copyright law.
+      appropriateness of using or redistributing the Work and assume any
-
+      risks associated with Your exercise of permissions under this License.
-  You may make, run and propagate covered works that you do not
+
-convey, without conditions so long as your license otherwise remains
+   8. Limitation of Liability. In no event and under no legal theory,
-in force.  You may convey covered works to others for the sole purpose
+      whether in tort (including negligence), contract, or otherwise,
-of having them make modifications exclusively for you, or provide you
+      unless required by applicable law (such as deliberate and grossly
-with facilities for running those works, provided that you comply with
+      negligent acts) or agreed to in writing, shall any Contributor be
-the terms of this License in conveying all material for which you do
+      liable to You for damages, including any direct, indirect, special,
-not control copyright.  Those thus making or running the covered works
+      incidental, or consequential damages of any character arising as a
-for you must do so exclusively on your behalf, under your direction
+      result of this License or out of the use or inability to use the
-and control, on terms that prohibit them from making any copies of
+      Work (including but not limited to damages for loss of goodwill,
-your copyrighted material outside their relationship with you.
+      work stoppage, computer failure or malfunction, or any and all
-
+      other commercial damages or losses), even if such Contributor
-  Conveying under any other circumstances is permitted solely under
+      has been advised of the possibility of such damages.
-the conditions stated below.  Sublicensing is not allowed; section 10
+
-makes it unnecessary.
+   9. Accepting Warranty or Additional Liability. While redistributing
-
+      the Work or Derivative Works thereof, You may choose to offer,
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+      and charge a fee for, acceptance of support, warranty, indemnity,
-
+      or other liability obligations and/or rights consistent with this
-  No covered work shall be deemed part of an effective technological
+      License. However, in accepting such obligations, You may act only
-measure under any applicable law fulfilling obligations under article
+      on Your own behalf and on Your sole responsibility, not on behalf
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
+      of any other Contributor, and only if You agree to indemnify,
-similar laws prohibiting or restricting circumvention of such
+      defend, and hold each Contributor harmless for any liability
-measures.
+      incurred by, or claims asserted against, such Contributor by reason
-
+      of your accepting any such warranty or additional liability.
-  When you convey a covered work, you waive any legal power to forbid
+
-circumvention of technological measures to the extent such circumvention
+   END OF TERMS AND CONDITIONS
-is effected by exercising rights under this License with respect to
+
-the covered work, and you disclaim any intention to limit operation or
+   APPENDIX: How to apply the Apache License to your work.
-modification of the work as a means of enforcing, against the work's
+
-users, your or third parties' legal rights to forbid circumvention of
+      To apply the Apache License to your work, attach the following
-technological measures.
+      boilerplate notice, with the fields enclosed by brackets "[]"
-
+      replaced with your own identifying information. (Don't include
-  4. Conveying Verbatim Copies.
+      the brackets!)  The text should be enclosed in the appropriate
-
+      comment syntax for the file format. We also recommend that a
-  You may convey verbatim copies of the Program's source code as you
+      file or class name and description of purpose be included on the
-receive it, in any medium, provided that you conspicuously and
+      same "printed page" as the copyright notice for easier
-appropriately publish on each copy an appropriate copyright notice;
+      identification within third-party archives.
-keep intact all notices stating that this License and any
+
-non-permissive terms added in accord with section 7 apply to the code;
+   Copyright [yyyy] [name of copyright owner]
-keep intact all notices of the absence of any warranty; and give all
+
-recipients a copy of this License along with the Program.
+   Licensed under the Apache License, Version 2.0 (the "License");
-
+   you may not use this file except in compliance with the License.
-  You may charge any price or no price for each copy that you convey,
+   You may obtain a copy of the License at
-and you may offer support or warranty protection for a fee.
+
-
+       http://www.apache.org/licenses/LICENSE-2.0
-  5. Conveying Modified Source Versions.
+
-
+   Unless required by applicable law or agreed to in writing, software
-  You may convey a work based on the Program, or the modifications to
+   distributed under the License is distributed on an "AS IS" BASIS,
-produce it from the Program, in the form of source code under the
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-terms of section 4, provided that you also meet all of these conditions:
+   See the License for the specific language governing permissions and
-
+   limitations under the License.
-    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. Remote Network Interaction; Use with the GNU General Public License.
-
-  Notwithstanding any other provision of this License, if you modify the
-Program, your modified version must prominently offer all users
-interacting with it remotely through a computer network (if your version
-supports such interaction) an opportunity to receive the Corresponding
-Source of your version by providing access to the Corresponding Source
-from a network server at no charge, through some standard or customary
-means of facilitating copying of software.  This Corresponding Source
-shall include the Corresponding Source for any work covered by version 3
-of the GNU General Public License that is incorporated pursuant to the
-following paragraph.
-
-  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 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 work with which it is combined will remain governed by version
-3 of the GNU General Public License.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU Affero 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 Affero 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 Affero 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 Affero 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.
-
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU Affero 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 Affero General Public License for more details.
-
-    You should have received a copy of the GNU Affero General Public License
-    along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If your software can interact with users remotely through a computer
-network, you should also make sure that it provides a way for users to
-get its source.  For example, if your program is a web application, its
-interface could display a "Source" link that leads users to an archive
-of the code.  There are many ways you could offer source, and different
-solutions will be better for different programs; see section 13 for the
-specific requirements.
-
-  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 AGPL, see
-<https://www.gnu.org/licenses/>.

README.md

@@ -14,10 +14,6 @@
 ### Features & usage
 - Drop-in replacement for the [official image](https://github.com/matrix-org/synapse/tree/develop/docker).
 - Unprivileged image: you should check your volumes permissions (eg `/data`), default UID/GID is 991.
-- Based on the latest [Alpine](https://alpinelinux.org/) containers which provide more recent packages while having less attack surface.
+- Based on [Alpine](https://alpinelinux.org/), which provides more recent packages while having less attack surface.
-- Comes with the [hardened memory allocator](https://github.com/GrapheneOS/hardened_malloc) built from the latest tag, protecting against some heap-based buffer overflows.
+- Comes with a [hardened memory allocator](https://github.com/GrapheneOS/hardened_malloc), protecting against some heap-based buffer overflows.
-- [Mjolnir module](https://github.com/matrix-org/mjolnir/blob/main/docs/synapse_module.md) support.
+- [Mjolnir module](https://github.com/matrix-org/mjolnir/blob/main/docs/synapse_module.md) support.
-
-### Licensing
-- v1.98.0 and prior are under the [Apache License](https://www.apache.org/licenses/LICENSE-2.0). 😇
-- Versions after v1.98.0 are under AGPL 3 🤮 to comply with licensing changes by Element.

rootfs/conf/homeserver.yaml

@@ -0,0 +1,200 @@
+# vim:ft=yaml
+
+## TLS ##
+
+{% if not SYNAPSE_NO_TLS %}
+
+tls_certificate_path: "/data/{{ SYNAPSE_SERVER_NAME }}.tls.crt"
+tls_private_key_path: "/data/{{ SYNAPSE_SERVER_NAME }}.tls.key"
+
+{% if SYNAPSE_ACME %}
+acme:
+    enabled: true
+    port: 8009
+{% endif %}
+
+{% endif %}
+
+## Server ##
+
+server_name: "{{ SYNAPSE_SERVER_NAME }}"
+pid_file: /homeserver.pid
+web_client: False
+soft_file_limit: 0
+log_config: "{{ SYNAPSE_LOG_CONFIG }}"
+
+## Ports ##
+
+listeners:
+  {% if not SYNAPSE_NO_TLS %}
+  -
+    port: 8448
+    bind_addresses: ['::']
+    type: http
+    tls: true
+    x_forwarded: false
+    resources:
+      - names: [client]
+        compress: true
+      - names: [federation]  # Federation APIs
+        compress: false
+  {% endif %}
+
+  # Allow configuring in case we want to reverse proxy 8008
+  # using another process in the same container
+  - port: {{ SYNAPSE_HTTP_PORT or 8008 }}
+    tls: false
+    bind_addresses: ['::']
+    type: http
+    x_forwarded: false
+
+    resources:
+      - names: [client]
+        compress: true
+      - names: [federation]
+        compress: false
+
+## Database ##
+
+{% if POSTGRES_PASSWORD %}
+database:
+  name: "psycopg2"
+  args:
+    user: "{{ POSTGRES_USER or "synapse" }}"
+    password: "{{ POSTGRES_PASSWORD }}"
+    database: "{{ POSTGRES_DB or "synapse" }}"
+    host: "{{ POSTGRES_HOST or "db" }}"
+    port: "{{ POSTGRES_PORT or "5432" }}"
+    cp_min: 5
+    cp_max: 10
+{% else %}
+database:
+  name: "sqlite3"
+  args:
+    database: "/data/homeserver.db"
+{% endif %}
+
+## Performance ##
+
+event_cache_size: "{{ SYNAPSE_EVENT_CACHE_SIZE or "10K" }}"
+
+## Ratelimiting ##
+
+rc_messages_per_second: 0.2
+rc_message_burst_count: 10.0
+federation_rc_window_size: 1000
+federation_rc_sleep_limit: 10
+federation_rc_sleep_delay: 500
+federation_rc_reject_limit: 50
+federation_rc_concurrent: 3
+
+## Files ##
+
+media_store_path: "/data/media"
+max_upload_size: "{{ SYNAPSE_MAX_UPLOAD_SIZE or "50M" }}"
+max_image_pixels: "32M"
+dynamic_thumbnails: false
+
+# List of thumbnail to precalculate when an image is uploaded.
+thumbnail_sizes:
+- width: 32
+  height: 32
+  method: crop
+- width: 96
+  height: 96
+  method: crop
+- width: 320
+  height: 240
+  method: scale
+- width: 640
+  height: 480
+  method: scale
+- width: 800
+  height: 600
+  method: scale
+
+url_preview_enabled: False
+max_spider_size: "10M"
+
+## Captcha ##
+
+{% if SYNAPSE_RECAPTCHA_PUBLIC_KEY %}
+recaptcha_public_key: "{{ SYNAPSE_RECAPTCHA_PUBLIC_KEY }}"
+recaptcha_private_key: "{{ SYNAPSE_RECAPTCHA_PRIVATE_KEY }}"
+enable_registration_captcha: True
+recaptcha_siteverify_api: "https://www.google.com/recaptcha/api/siteverify"
+{% else %}
+recaptcha_public_key: "YOUR_PUBLIC_KEY"
+recaptcha_private_key: "YOUR_PRIVATE_KEY"
+enable_registration_captcha: False
+recaptcha_siteverify_api: "https://www.google.com/recaptcha/api/siteverify"
+{% endif %}
+
+## Turn ##
+
+{% if SYNAPSE_TURN_URIS %}
+turn_uris:
+{% for uri in SYNAPSE_TURN_URIS.split(',') %}    - "{{ uri }}"
+{% endfor %}
+turn_shared_secret: "{{ SYNAPSE_TURN_SECRET }}"
+turn_user_lifetime: "1h"
+turn_allow_guests: True
+{% else %}
+turn_uris: []
+turn_shared_secret: "YOUR_SHARED_SECRET"
+turn_user_lifetime: "1h"
+turn_allow_guests: True
+{% endif %}
+
+## Registration ##
+
+enable_registration: {{ "True" if SYNAPSE_ENABLE_REGISTRATION else "False" }}
+registration_shared_secret: "{{ SYNAPSE_REGISTRATION_SHARED_SECRET }}"
+bcrypt_rounds: 12
+allow_guest_access: {{ "True" if SYNAPSE_ALLOW_GUEST else "False" }}
+enable_group_creation: true
+
+# The list of identity servers trusted to verify third party
+# identifiers by this server.
+#
+# Also defines the ID server which will be called when an account is
+# deactivated (one will be picked arbitrarily).
+trusted_third_party_id_servers:
+    - matrix.org
+    - vector.im
+
+## Metrics ###
+
+{% if SYNAPSE_REPORT_STATS.lower() == "yes" %}
+enable_metrics: True
+report_stats: True
+{% else %}
+enable_metrics: False
+report_stats: False
+{% endif %}
+
+## API Configuration ##
+
+{% if SYNAPSE_APPSERVICES %}
+app_service_config_files:
+{% for appservice in SYNAPSE_APPSERVICES %}    - "{{ appservice }}"
+{% endfor %}
+{% endif %}
+
+macaroon_secret_key: "{{ SYNAPSE_MACAROON_SECRET_KEY }}"
+expire_access_token: False
+
+## Signing Keys ##
+
+signing_key_path: "/data/{{ SYNAPSE_SERVER_NAME }}.signing.key"
+old_signing_keys: {}
+key_refresh_interval: "1d" # 1 Day.
+
+# The trusted servers to download signing keys from.
+trusted_key_servers:
+  - server_name: matrix.org
+    verify_keys:
+      "ed25519:auto": "Noi6WqcDj0QmPxCNQqgezwTlBKrfqehY1u2FyWP9uYw"
+
+password_config:
+   enabled: true

rootfs/conf/log.config

@@ -0,0 +1,54 @@
+version: 1
+
+formatters:
+  precise:
+{% if worker_name %}
+    format: '%(asctime)s - worker:{{ worker_name }} - %(name)s - %(lineno)d - %(levelname)s - %(request)s - %(message)s'
+{% else %}
+    format: '%(asctime)s - %(name)s - %(lineno)d - %(levelname)s - %(request)s - %(message)s'
+{% endif %}
+
+handlers:
+{% if LOG_FILE_PATH %}
+  file:
+    class: logging.handlers.TimedRotatingFileHandler
+    formatter: precise
+    filename: {{ LOG_FILE_PATH }}
+    when: "midnight"
+    backupCount: 6  # Does not include the current log file.
+    encoding: utf8
+
+  # Default to buffering writes to log file for efficiency. This means that
+  # there will be a delay for INFO/DEBUG logs to get written, but WARNING/ERROR
+  # logs will still be flushed immediately.
+  buffer:
+    class: logging.handlers.MemoryHandler
+    target: file
+    # The capacity is the number of log lines that are buffered before
+    # being written to disk. Increasing this will lead to better
+    # performance, at the expensive of it taking longer for log lines to
+    # be written to disk.
+    capacity: 10
+    flushLevel: 30  # Flush for WARNING logs as well
+{% endif %}
+
+  console:
+    class: logging.StreamHandler
+    formatter: precise
+
+loggers:
+    synapse.storage.SQL:
+        # beware: increasing this to DEBUG will make synapse log sensitive
+        # information such as access tokens.
+        level: INFO
+
+root:
+    level: {{ SYNAPSE_LOG_LEVEL or "INFO" }}
+
+{% if LOG_FILE_PATH %}
+    handlers: [console, buffer]
+{% else %}
+    handlers: [console]
+{% endif %}
+
+disable_existing_loggers: false

rootfs/start.py

@@ -0,0 +1,219 @@
+#!/usr/local/bin/python
+
+import codecs
+import glob
+import os
+import subprocess
+import sys
+
+import jinja2
+
+
+# Utility functions
+def log(txt):
+    print(txt, file=sys.stderr)
+
+
+def error(txt):
+    log(txt)
+    sys.exit(2)
+
+
+def convert(src, dst, environ):
+    """Generate a file from a template
+
+    Args:
+        src (str): path to input file
+        dst (str): path to file to write
+        environ (dict): environment dictionary, for replacement mappings.
+    """
+    with open(src) as infile:
+        template = infile.read()
+    rendered = jinja2.Template(template).render(**environ)
+    with open(dst, "w") as outfile:
+        outfile.write(rendered)
+
+
+def generate_config_from_template(config_dir, config_path, environ):
+    """Generate a homeserver.yaml from environment variables
+
+    Args:
+        config_dir (str): where to put generated config files
+        config_path (str): where to put the main config file
+        environ (dict): environment dictionary
+    """
+    for v in ("SYNAPSE_SERVER_NAME", "SYNAPSE_REPORT_STATS"):
+        if v not in environ:
+            error(
+                "Environment variable '%s' is mandatory when generating a config file."
+                % (v,)
+            )
+
+    # populate some params from data files (if they exist, else create new ones)
+    environ = environ.copy()
+    secrets = {
+        "registration": "SYNAPSE_REGISTRATION_SHARED_SECRET",
+        "macaroon": "SYNAPSE_MACAROON_SECRET_KEY",
+    }
+
+    for name, secret in secrets.items():
+        if secret not in environ:
+            filename = "/data/%s.%s.key" % (environ["SYNAPSE_SERVER_NAME"], name)
+
+            # if the file already exists, load in the existing value; otherwise,
+            # generate a new secret and write it to a file
+
+            if os.path.exists(filename):
+                log("Reading %s from %s" % (secret, filename))
+                with open(filename) as handle:
+                    value = handle.read()
+            else:
+                log("Generating a random secret for {}".format(secret))
+                value = codecs.encode(os.urandom(32), "hex").decode()
+                with open(filename, "w") as handle:
+                    handle.write(value)
+            environ[secret] = value
+
+    environ["SYNAPSE_APPSERVICES"] = glob.glob("/data/appservices/*.yaml")
+    if not os.path.exists(config_dir):
+        os.mkdir(config_dir)
+
+    # Convert SYNAPSE_NO_TLS to boolean if exists
+    if "SYNAPSE_NO_TLS" in environ:
+        tlsanswerstring = str.lower(environ["SYNAPSE_NO_TLS"])
+        if tlsanswerstring in ("true", "on", "1", "yes"):
+            environ["SYNAPSE_NO_TLS"] = True
+        else:
+            if tlsanswerstring in ("false", "off", "0", "no"):
+                environ["SYNAPSE_NO_TLS"] = False
+            else:
+                error(
+                    'Environment variable "SYNAPSE_NO_TLS" found but value "'
+                    + tlsanswerstring
+                    + '" unrecognized; exiting.'
+                )
+
+    if "SYNAPSE_LOG_CONFIG" not in environ:
+        environ["SYNAPSE_LOG_CONFIG"] = config_dir + "/log.config"
+
+    log("Generating synapse config file " + config_path)
+    convert("/conf/homeserver.yaml", config_path, environ)
+
+    log_config_file = environ["SYNAPSE_LOG_CONFIG"]
+    log("Generating log config file " + log_config_file)
+    convert("/conf/log.config", log_config_file, environ)
+
+    # Hopefully we already have a signing key, but generate one if not.
+    args = [
+        "python",
+        "-m",
+        "synapse.app.homeserver",
+        "--config-path",
+        config_path,
+        # tell synapse to put generated keys in /data rather than /compiled
+        "--keys-directory",
+        config_dir,
+        "--generate-keys",
+    ]
+
+    subprocess.check_output(args)
+
+
+def run_generate_config(environ):
+    """Run synapse with a --generate-config param to generate a template config file
+
+    Args:
+        environ (dict): env var dict
+
+    Never returns.
+    """
+    for v in ("SYNAPSE_SERVER_NAME", "SYNAPSE_REPORT_STATS"):
+        if v not in environ:
+            error("Environment variable '%s' is mandatory in `generate` mode." % (v,))
+
+    server_name = environ["SYNAPSE_SERVER_NAME"]
+    config_dir = environ.get("SYNAPSE_CONFIG_DIR", "/data")
+    config_path = environ.get("SYNAPSE_CONFIG_PATH", config_dir + "/homeserver.yaml")
+    data_dir = environ.get("SYNAPSE_DATA_DIR", "/data")
+
+    # create a suitable log config from our template
+    log_config_file = "%s/%s.log.config" % (config_dir, server_name)
+    if not os.path.exists(log_config_file):
+        log("Creating log config %s" % (log_config_file,))
+        convert("/conf/log.config", log_config_file, environ)
+
+    args = [
+        "python",
+        "-m",
+        "synapse.app.homeserver",
+        "--server-name",
+        server_name,
+        "--report-stats",
+        environ["SYNAPSE_REPORT_STATS"],
+        "--config-path",
+        config_path,
+        "--config-directory",
+        config_dir,
+        "--data-directory",
+        data_dir,
+        "--generate-config",
+        "--open-private-ports",
+    ]
+    # log("running %s" % (args, ))
+
+    os.execv("/usr/local/bin/python", args)
+
+
+def main(args, environ):
+    mode = args[1] if len(args) > 1 else None
+    synapse_worker = environ.get("SYNAPSE_WORKER", "synapse.app.homeserver")
+
+    # In generate mode, generate a configuration and missing keys, then exit
+    if mode == "generate":
+        return run_generate_config(environ)
+
+    if mode == "migrate_config":
+        # generate a config based on environment vars.
+        config_dir = environ.get("SYNAPSE_CONFIG_DIR", "/data")
+        config_path = environ.get(
+            "SYNAPSE_CONFIG_PATH", config_dir + "/homeserver.yaml"
+        )
+        return generate_config_from_template(
+            config_dir, config_path, environ
+        )
+
+    if mode is not None:
+        error("Unknown execution mode '%s'" % (mode,))
+
+    config_dir = environ.get("SYNAPSE_CONFIG_DIR", "/data")
+    config_path = environ.get("SYNAPSE_CONFIG_PATH", config_dir + "/homeserver.yaml")
+
+    if not os.path.exists(config_path):
+        if "SYNAPSE_SERVER_NAME" in environ:
+            error(
+                """\
+Config file '%s' does not exist.
+
+The synapse docker image no longer supports generating a config file on-the-fly
+based on environment variables. You can migrate to a static config file by
+running with 'migrate_config'. See the README for more details.
+"""
+                % (config_path,)
+            )
+
+        error(
+            "Config file '%s' does not exist. You should either create a new "
+            "config file by running with the `generate` argument (and then edit "
+            "the resulting file before restarting) or specify the path to an "
+            "existing config file with the SYNAPSE_CONFIG_PATH variable."
+            % (config_path,)
+        )
+
+    log("Starting synapse with config file " + config_path)
+
+    args = ["python", "-m", synapse_worker, "--config-path", config_path]
+    os.execv("/usr/local/bin/python", args)
+
+
+if __name__ == "__main__":
+    main(sys.argv, os.environ)