Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Add note to UPGRADE.rst about changes in account validity templates
Browse files Browse the repository at this point in the history
  • Loading branch information
anoadragon453 committed Apr 16, 2021
1 parent 69e4a35 commit 7ce453f
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions UPGRADE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,29 @@ for example:
wget https://packages.matrix.org/debian/pool/main/m/matrix-synapse-py3/matrix-synapse-py3_1.3.0+stretch1_amd64.deb
dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
Upgrading to v1.33.0
====================

Account Validity HTML templates can now display a user's expiration date
------------------------------------------------------------------------

This may affect you if you have enabled the account validity feature, and have made use of a
custom HTML template specified by the ``account_validity.template_dir`` and ``account_validity.account_renewed_html_path``
Synapse config options.

The template can now accept an ``expiration_ts`` variable, which represents the unix timestamp in milliseconds for the
future date of which their account has been renewed until. See the
`default template <https://github.com/matrix-org/synapse/blob/release-v1.33.0/synapse/res/templates/account_renewed.html>`
for an example of usage.

Relatedly, note that in this update a new HTML template has been added which is shown to users when they
attempt to renew their account with a valid renewal token that has already been used before. The default template
contents can been found
`here <https://github.com/matrix-org/synapse/blob/release-v1.33.0/synapse/res/templates/account_previously_renewed.html>`, and
can also accept an ``expiration_ts`` variable. This template replaces the error message users would previously see upon
attempting to use a token more than once.


Upgrading to v1.32.0
====================

Expand Down

0 comments on commit 7ce453f

Please sign in to comment.