diff --git a/latest/development/contributing_guide.html b/latest/development/contributing_guide.html index 8a4fb5b6e9..766f722109 100644 --- a/latest/development/contributing_guide.html +++ b/latest/development/contributing_guide.html @@ -362,7 +362,7 @@ Here is how to run your local Synapse checkout against your local Complement che

Prettier formatting with gotestfmt

If you want to format the output of the tests the same way as it looks in CI, -install gotestfmt.

+install gotestfmt.

You can then use this incantation to format the tests appropriately:

COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh -json | gotestfmt -hide successful-tests
@@ -405,7 +405,7 @@ in the format of PRnumber.type. The type can be one of the followin

This file will become part of our changelog at the next release, so the content of the file should be a short description of your change in the same style as the rest of the changelog. The file can contain Markdown -formatting, and should end with a full stop (.) or an exclamation mark (!) for +formatting, and must end with a full stop (.) or an exclamation mark (!) for consistency.

Adding credits to the changelog is encouraged, we value your contributions and would like to have you shouted out in the release notes!

diff --git a/latest/metrics-howto.html b/latest/metrics-howto.html index c5ec8269fb..ee0962d4ab 100644 --- a/latest/metrics-howto.html +++ b/latest/metrics-howto.html @@ -163,12 +163,19 @@ set to True.

collect data:

There are two methods of enabling the metrics endpoint in Synapse.

The first serves the metrics as a part of the usual web server and -can be enabled by adding the "metrics" resource to the existing -listener as such:

-
  resources:
-    - names:
-      - client
-      - metrics
+can be enabled by adding the metrics resource to the existing
+listener as such as in this example:

+
listeners:
+  - port: 8008
+    tls: false
+    type: http
+    x_forwarded: true
+    bind_addresses: ['::1', '127.0.0.1']
+
+    resources:
+      # added "metrics" in this line
+      - names: [client, federation, metrics]
+        compress: false
 

 
This provides a simple way of adding metrics to your Synapse
 installation, and serves under /_synapse/metrics. If you do not
@@ -179,12 +186,22 @@ different thread to Synapse. This can make it more resilient to
 heavy load meaning metrics cannot be retrieved, and can be exposed
 to just internal networks easier. The served metrics are available
 over HTTP only, and will be available at /_synapse/metrics.

-
Add a new listener to homeserver.yaml:

-
  listeners:
-    - type: metrics
-      port: 9000
-      bind_addresses:
-        - '0.0.0.0'
+
Add a new listener to homeserver.yaml as in this example:

+
listeners:
+  - port: 8008
+    tls: false
+    type: http
+    x_forwarded: true
+    bind_addresses: ['::1', '127.0.0.1']
+
+    resources:
+      - names: [client, federation]
+        compress: false
+
+  # beginning of the new metrics listener
+  - port: 9000
+    type: metrics
+    bind_addresses: ['::1', '127.0.0.1']
 

 
 
  • 
diff --git a/latest/openid.html b/latest/openid.html
index 8eacaa59c8..faa696d954 100644
--- a/latest/openid.html
+++ b/latest/openid.html
@@ -448,11 +448,12 @@ does not return a sub property, an alternative subject_claim<
     issuer: "https://accounts.google.com/"
     client_id: "your-client-id" # TO BE FILLED
     client_secret: "your-client-secret" # TO BE FILLED
-    scopes: ["openid", "profile"]
+    scopes: ["openid", "profile", "email"] # email is optional, read below
     user_mapping_provider:
       config:
         localpart_template: "{{ user.given_name|lower }}"
         display_name_template: "{{ user.name }}"
+        email_template: "{{ user.email }}" # needs "email" in scopes above
 
    • 
 
 
  • Back in the Google console, add this Authorized redirect URI: [synapse public baseurl]/_synapse/client/oidc/callback.
    • 
@@ -530,7 +531,7 @@ and "App Secret" for use below.
     user_mapping_provider:
       config:
         display_name_template: "{{ user.name }}"
-        email_template: "{{ '{{ user.email }}' }}"
+        email_template: "{{ user.email }}"

    Relevant documents: