summary refs log tree commit diff
path: root/docs/server_notices.md
diff options
context:
space:
mode:
authorRichard van der Hoff <1389908+richvdh@users.noreply.github.com>2018-05-24 10:31:43 +0100
committerGitHub <noreply@github.com>2018-05-24 10:31:43 +0100
commit6abcb5d22d6f0580f6a0da40761750c4d643e5aa (patch)
treedc14eca4295bac6480da9d30cb95b40917bb6674 /docs/server_notices.md
parentMerge pull request #3272 from matrix-org/rav/localpart_in_consent_uri (diff)
parentAllow overriding the server_notices user's avatar (diff)
downloadsynapse-6abcb5d22d6f0580f6a0da40761750c4d643e5aa.tar.xz
Merge pull request #3273 from matrix-org/rav/server_notices_avatar_url
Allow overriding the server_notices user's avatar
Diffstat (limited to 'docs/server_notices.md')
-rw-r--r--docs/server_notices.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/server_notices.md b/docs/server_notices.md
index 8e18e3d95d..221553b24d 100644
--- a/docs/server_notices.md
+++ b/docs/server_notices.md
@@ -44,13 +44,16 @@ section, which should look like this:
 server_notices:
    system_mxid_localpart: server
    system_mxid_display_name: "Server Notices"
+   system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ"
    room_name: "Server Notices"
 ```
 
 The only compulsory setting is `system_mxid_localpart`, which defines the user
-id of the server notices user, as above. `system_mxid_display_name` and
-`room_name` define the displayname of the system notices user, and of
-the notices room, respectively.
+id of the Server Notices user, as above. `room_name` defines the name of the
+room which will be created.
+
+`system_mxid_display_name` and `system_mxid_avatar_url` can be used to set the
+displayname and avatar of the Server Notices user.
 
 Sending notices
 ---------------