upgrade.html 122 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783
  1. <!DOCTYPE HTML>
  2. <html lang="en" class="sidebar-visible no-js light">
  3. <head>
  4. <!-- Book generated using mdBook -->
  5. <meta charset="UTF-8">
  6. <title>Upgrading between Synapse Versions - Synapse</title>
  7. <!-- Custom HTML head -->
  8. <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
  9. <meta name="description" content="">
  10. <meta name="viewport" content="width=device-width, initial-scale=1">
  11. <meta name="theme-color" content="#ffffff" />
  12. <link rel="icon" href="favicon.svg">
  13. <link rel="shortcut icon" href="favicon.png">
  14. <link rel="stylesheet" href="css/variables.css">
  15. <link rel="stylesheet" href="css/general.css">
  16. <link rel="stylesheet" href="css/chrome.css">
  17. <link rel="stylesheet" href="css/print.css" media="print">
  18. <!-- Fonts -->
  19. <link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
  20. <link rel="stylesheet" href="fonts/fonts.css">
  21. <!-- Highlight.js Stylesheets -->
  22. <link rel="stylesheet" href="highlight.css">
  23. <link rel="stylesheet" href="tomorrow-night.css">
  24. <link rel="stylesheet" href="ayu-highlight.css">
  25. <!-- Custom theme stylesheets -->
  26. <link rel="stylesheet" href="docs/website_files/table-of-contents.css">
  27. <link rel="stylesheet" href="docs/website_files/remove-nav-buttons.css">
  28. <link rel="stylesheet" href="docs/website_files/indent-section-headers.css">
  29. <link rel="stylesheet" href="docs/website_files/version-picker.css">
  30. </head>
  31. <body>
  32. <!-- Provide site root to javascript -->
  33. <script type="text/javascript">
  34. var path_to_root = "";
  35. var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
  36. </script>
  37. <!-- Work around some values being stored in localStorage wrapped in quotes -->
  38. <script type="text/javascript">
  39. try {
  40. var theme = localStorage.getItem('mdbook-theme');
  41. var sidebar = localStorage.getItem('mdbook-sidebar');
  42. if (theme.startsWith('"') && theme.endsWith('"')) {
  43. localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
  44. }
  45. if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
  46. localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
  47. }
  48. } catch (e) { }
  49. </script>
  50. <!-- Set the theme before any content is loaded, prevents flash -->
  51. <script type="text/javascript">
  52. var theme;
  53. try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
  54. if (theme === null || theme === undefined) { theme = default_theme; }
  55. var html = document.querySelector('html');
  56. html.classList.remove('no-js')
  57. html.classList.remove('light')
  58. html.classList.add(theme);
  59. html.classList.add('js');
  60. </script>
  61. <!-- Hide / unhide sidebar before it is displayed -->
  62. <script type="text/javascript">
  63. var html = document.querySelector('html');
  64. var sidebar = 'hidden';
  65. if (document.body.clientWidth >= 1080) {
  66. try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
  67. sidebar = sidebar || 'visible';
  68. }
  69. html.classList.remove('sidebar-visible');
  70. html.classList.add("sidebar-" + sidebar);
  71. </script>
  72. <nav id="sidebar" class="sidebar" aria-label="Table of contents">
  73. <div class="sidebar-scrollbox">
  74. <ol class="chapter"><li class="chapter-item expanded affix "><li class="part-title">Introduction</li><li class="chapter-item expanded "><a href="welcome_and_overview.html">Welcome and Overview</a></li><li class="chapter-item expanded affix "><li class="part-title">Setup</li><li class="chapter-item expanded "><a href="setup/installation.html">Installation</a></li><li class="chapter-item expanded "><a href="postgres.html">Using Postgres</a></li><li class="chapter-item expanded "><a href="reverse_proxy.html">Configuring a Reverse Proxy</a></li><li class="chapter-item expanded "><a href="setup/forward_proxy.html">Configuring a Forward/Outbound Proxy</a></li><li class="chapter-item expanded "><a href="turn-howto.html">Configuring a Turn Server</a></li><li class="chapter-item expanded "><a href="delegate.html">Delegation</a></li><li class="chapter-item expanded affix "><li class="part-title">Upgrading</li><li class="chapter-item expanded "><a href="upgrade.html" class="active">Upgrading between Synapse Versions</a></li><li class="chapter-item expanded affix "><li class="part-title">Usage</li><li class="chapter-item expanded "><a href="federate.html">Federation</a></li><li class="chapter-item expanded "><a href="usage/configuration/index.html">Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="usage/configuration/config_documentation.html">Configuration Manual</a></li><li class="chapter-item expanded "><a href="usage/configuration/homeserver_sample_config.html">Homeserver Sample Config File</a></li><li class="chapter-item expanded "><a href="usage/configuration/logging_sample_config.html">Logging Sample Config File</a></li><li class="chapter-item expanded "><a href="structured_logging.html">Structured Logging</a></li><li class="chapter-item expanded "><a href="templates.html">Templates</a></li><li class="chapter-item expanded "><a href="usage/configuration/user_authentication/index.html">User Authentication</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="usage/configuration/user_authentication/single_sign_on/index.html">Single-Sign On</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="openid.html">OpenID Connect</a></li><li class="chapter-item expanded "><a href="usage/configuration/user_authentication/single_sign_on/saml.html">SAML</a></li><li class="chapter-item expanded "><a href="usage/configuration/user_authentication/single_sign_on/cas.html">CAS</a></li><li class="chapter-item expanded "><a href="sso_mapping_providers.html">SSO Mapping Providers</a></li></ol></li><li class="chapter-item expanded "><a href="password_auth_providers.html">Password Auth Providers</a></li><li class="chapter-item expanded "><a href="jwt.html">JSON Web Tokens</a></li><li class="chapter-item expanded "><a href="usage/configuration/user_authentication/refresh_tokens.html">Refresh Tokens</a></li></ol></li><li class="chapter-item expanded "><a href="CAPTCHA_SETUP.html">Registration Captcha</a></li><li class="chapter-item expanded "><a href="application_services.html">Application Services</a></li><li class="chapter-item expanded "><a href="server_notices.html">Server Notices</a></li><li class="chapter-item expanded "><a href="consent_tracking.html">Consent Tracking</a></li><li class="chapter-item expanded "><a href="user_directory.html">User Directory</a></li><li class="chapter-item expanded "><a href="message_retention_policies.html">Message Retention Policies</a></li><li class="chapter-item expanded "><a href="modules/index.html">Pluggable Modules</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="modules/writing_a_module.html">Writing a module</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="modules/spam_checker_callbacks.html">Spam checker callbacks</a></li><li class="chapter-item expanded "><a href="modules/third_party_rules_callbacks.html">Third-party rules callbacks</a></li><li class="chapter-item expanded "><a href="modules/presence_router_callbacks.html">Presence router callbacks</a></li><li class="chapter-item expanded "><a href="modules/account_validity_callbacks.html">Account validity callbacks</a></li><li class="chapter-item expanded "><a href="modules/password_auth_provider_callbacks.html">Password auth provider callbacks</a></li><li class="chapter-item expanded "><a href="modules/background_update_controller_callbacks.html">Background update controller callbacks</a></li><li class="chapter-item expanded "><a href="modules/account_data_callbacks.html">Account data callbacks</a></li><li class="chapter-item expanded "><a href="modules/porting_legacy_module.html">Porting a legacy module to the new interface</a></li></ol></li></ol></li><li class="chapter-item expanded "><a href="workers.html">Workers</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="synctl_workers.html">Using synctl with Workers</a></li><li class="chapter-item expanded "><a href="systemd-with-workers/index.html">Systemd</a></li></ol></li></ol></li><li class="chapter-item expanded "><a href="usage/administration/index.html">Administration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="usage/administration/admin_api/index.html">Admin API</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="admin_api/account_validity.html">Account Validity</a></li><li class="chapter-item expanded "><a href="usage/administration/admin_api/background_updates.html">Background Updates</a></li><li class="chapter-item expanded "><a href="admin_api/event_reports.html">Event Reports</a></li><li class="chapter-item expanded "><a href="admin_api/media_admin_api.html">Media</a></li><li class="chapter-item expanded "><a href="admin_api/purge_history_api.html">Purge History</a></li><li class="chapter-item expanded "><a href="admin_api/register_api.html">Register Users</a></li><li class="chapter-item expanded "><a href="usage/administration/admin_api/registration_tokens.html">Registration Tokens</a></li><li class="chapter-item expanded "><a href="admin_api/room_membership.html">Manipulate Room Membership</a></li><li class="chapter-item expanded "><a href="admin_api/rooms.html">Rooms</a></li><li class="chapter-item expanded "><a href="admin_api/server_notices.html">Server Notices</a></li><li class="chapter-item expanded "><a href="admin_api/statistics.html">Statistics</a></li><li class="chapter-item expanded "><a href="admin_api/user_admin_api.html">Users</a></li><li class="chapter-item expanded "><a href="admin_api/version_api.html">Server Version</a></li><li class="chapter-item expanded "><a href="usage/administration/admin_api/federation.html">Federation</a></li></ol></li><li class="chapter-item expanded "><a href="manhole.html">Manhole</a></li><li class="chapter-item expanded "><a href="metrics-howto.html">Monitoring</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="usage/administration/monitoring/reporting_homeserver_usage_statistics.html">Reporting Homeserver Usage Statistics</a></li></ol></li><li class="chapter-item expanded "><a href="usage/administration/understanding_synapse_through_grafana_graphs.html">Understanding Synapse Through Grafana Graphs</a></li><li class="chapter-item expanded "><a href="usage/administration/useful_sql_for_admins.html">Useful SQL for Admins</a></li><li class="chapter-item expanded "><a href="usage/administration/database_maintenance_tools.html">Database Maintenance Tools</a></li><li class="chapter-item expanded "><a href="usage/administration/state_groups.html">State Groups</a></li><li class="chapter-item expanded "><a href="usage/administration/request_log.html">Request log format</a></li><li class="chapter-item expanded "><a href="usage/administration/admin_faq.html">Admin FAQ</a></li><li class="chapter-item expanded "><div>Scripts</div></li></ol></li><li class="chapter-item expanded "><li class="part-title">Development</li><li class="chapter-item expanded "><a href="development/contributing_guide.html">Contributing Guide</a></li><li class="chapter-item expanded "><a href="code_style.html">Code Style</a></li><li class="chapter-item expanded "><a href="development/reviews.html">Reviewing Code</a></li><li class="chapter-item expanded "><a href="development/releases.html">Release Cycle</a></li><li class="chapter-item expanded "><a href="development/git.html">Git Usage</a></li><li class="chapter-item expanded "><div>Testing</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="development/demo.html">Demo scripts</a></li></ol></li><li class="chapter-item expanded "><a href="opentracing.html">OpenTracing</a></li><li class="chapter-item expanded "><a href="development/database_schema.html">Database Schemas</a></li><li class="chapter-item expanded "><a href="development/experimental_features.html">Experimental features</a></li><li class="chapter-item expanded "><a href="development/dependencies.html">Dependency management</a></li><li class="chapter-item expanded "><div>Synapse Architecture</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="development/synapse_architecture/cancellation.html">Cancellation</a></li><li class="chapter-item expanded "><a href="log_contexts.html">Log Contexts</a></li><li class="chapter-item expanded "><a href="replication.html">Replication</a></li><li class="chapter-item expanded "><a href="tcp_replication.html">TCP Replication</a></li></ol></li><li class="chapter-item expanded "><a href="development/internal_documentation/index.html">Internal Documentation</a></li><li><ol class="section"><li class="chapter-item expanded "><div>Single Sign-On</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="development/saml.html">SAML</a></li><li class="chapter-item expanded "><a href="development/cas.html">CAS</a></li></ol></li><li class="chapter-item expanded "><a href="development/room-dag-concepts.html">Room DAG concepts</a></li><li class="chapter-item expanded "><div>State Resolution</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="auth_chain_difference_algorithm.html">The Auth Chain Difference Algorithm</a></li></ol></li><li class="chapter-item expanded "><a href="media_repository.html">Media Repository</a></li><li class="chapter-item expanded "><a href="room_and_user_statistics.html">Room and User Statistics</a></li></ol></li><li class="chapter-item expanded "><div>Scripts</div></li><li class="chapter-item expanded affix "><li class="part-title">Other</li><li class="chapter-item expanded "><a href="deprecation_policy.html">Dependency Deprecation Policy</a></li><li class="chapter-item expanded "><a href="other/running_synapse_on_single_board_computers.html">Running Synapse on a Single-Board Computer</a></li></ol>
  75. </div>
  76. <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
  77. </nav>
  78. <div id="page-wrapper" class="page-wrapper">
  79. <div class="page">
  80. <div id="menu-bar-hover-placeholder"></div>
  81. <div id="menu-bar" class="menu-bar sticky bordered">
  82. <div class="left-buttons">
  83. <button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
  84. <i class="fa fa-bars"></i>
  85. </button>
  86. <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
  87. <i class="fa fa-paint-brush"></i>
  88. </button>
  89. <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
  90. <li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
  91. <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
  92. <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
  93. <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
  94. <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
  95. </ul>
  96. <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
  97. <i class="fa fa-search"></i>
  98. </button>
  99. <div class="version-picker">
  100. <div class="dropdown">
  101. <div class="select">
  102. <span></span>
  103. <i class="fa fa-chevron-down"></i>
  104. </div>
  105. <input type="hidden" name="version">
  106. <ul class="dropdown-menu">
  107. <!-- Versions will be added dynamically in version-picker.js -->
  108. </ul>
  109. </div>
  110. </div>
  111. </div>
  112. <h1 class="menu-title">Synapse</h1>
  113. <div class="right-buttons">
  114. <a href="print.html" title="Print this book" aria-label="Print this book">
  115. <i id="print-button" class="fa fa-print"></i>
  116. </a>
  117. <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository">
  118. <i id="git-repository-button" class="fa fa-github"></i>
  119. </a>
  120. <a href="https://github.com/matrix-org/synapse/edit/develop/docs/upgrade.md" title="Suggest an edit" aria-label="Suggest an edit">
  121. <i id="git-edit-button" class="fa fa-edit"></i>
  122. </a>
  123. </div>
  124. </div>
  125. <div id="search-wrapper" class="hidden">
  126. <form id="searchbar-outer" class="searchbar-outer">
  127. <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
  128. </form>
  129. <div id="searchresults-outer" class="searchresults-outer hidden">
  130. <div id="searchresults-header" class="searchresults-header"></div>
  131. <ul id="searchresults">
  132. </ul>
  133. </div>
  134. </div>
  135. <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
  136. <script type="text/javascript">
  137. document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
  138. document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
  139. Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
  140. link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
  141. });
  142. </script>
  143. <div id="content" class="content">
  144. <main>
  145. <!-- Page table of contents -->
  146. <div class="sidetoc">
  147. <nav class="pagetoc"></nav>
  148. </div>
  149. <h1 id="upgrading-synapse"><a class="header" href="#upgrading-synapse">Upgrading Synapse</a></h1>
  150. <p>Before upgrading check if any special steps are required to upgrade from
  151. the version you currently have installed to the current version of
  152. Synapse. The extra instructions that may be required are listed later in
  153. this document.</p>
  154. <ul>
  155. <li>
  156. <p>Check that your versions of Python and PostgreSQL are still
  157. supported.</p>
  158. <p>Synapse follows upstream lifecycles for <a href="https://endoflife.date/python">Python</a> and
  159. <a href="https://endoflife.date/postgresql">PostgreSQL</a>, and removes support for versions
  160. which are no longer maintained.</p>
  161. <p>The website <a href="https://endoflife.date">https://endoflife.date</a> also offers convenient
  162. summaries.</p>
  163. </li>
  164. <li>
  165. <p>If Synapse was installed using <a href="setup/installation.html#prebuilt-packages">prebuilt
  166. packages</a>, you will need to follow the
  167. normal process for upgrading those packages.</p>
  168. </li>
  169. <li>
  170. <p>If Synapse was installed using pip then upgrade to the latest
  171. version by running:</p>
  172. <pre><code class="language-bash">pip install --upgrade matrix-synapse
  173. </code></pre>
  174. </li>
  175. <li>
  176. <p>If Synapse was installed from source, then:</p>
  177. <ol>
  178. <li>
  179. <p>Obtain the latest version of the source code. Git users can run
  180. <code>git pull</code> to do this.</p>
  181. </li>
  182. <li>
  183. <p>If you're running Synapse in a virtualenv, make sure to activate it before
  184. upgrading. For example, if Synapse is installed in a virtualenv in <code>~/synapse/env</code> then
  185. run:</p>
  186. <pre><code class="language-bash">source ~/synapse/env/bin/activate
  187. pip install --upgrade .
  188. </code></pre>
  189. <p>Include any relevant extras between square brackets, e.g. <code>pip install --upgrade &quot;.[postgres,oidc]&quot;</code>.</p>
  190. </li>
  191. <li>
  192. <p>If you're using <code>poetry</code> to manage a Synapse installation, run:</p>
  193. <pre><code class="language-bash">poetry install
  194. </code></pre>
  195. <p>Include any relevant extras with <code>--extras</code>, e.g. <code>poetry install --extras postgres --extras oidc</code>.
  196. It's probably easiest to run <code>poetry install --extras all</code>.</p>
  197. </li>
  198. <li>
  199. <p>Restart Synapse:</p>
  200. <pre><code class="language-bash">synctl restart
  201. </code></pre>
  202. </li>
  203. </ol>
  204. </li>
  205. </ul>
  206. <p>To check whether your update was successful, you can check the running
  207. server version with:</p>
  208. <pre><code class="language-bash"># you may need to replace 'localhost:8008' if synapse is not configured
  209. # to listen on port 8008.
  210. curl http://localhost:8008/_synapse/admin/v1/server_version
  211. </code></pre>
  212. <h2 id="rolling-back-to-older-versions"><a class="header" href="#rolling-back-to-older-versions">Rolling back to older versions</a></h2>
  213. <p>Rolling back to previous releases can be difficult, due to database
  214. schema changes between releases. Where we have been able to test the
  215. rollback process, this will be noted below.</p>
  216. <p>In general, you will need to undo any changes made during the upgrade
  217. process, for example:</p>
  218. <ul>
  219. <li>
  220. <p>pip:</p>
  221. <pre><code class="language-bash">source env/bin/activate
  222. # replace `1.3.0` accordingly:
  223. pip install matrix-synapse==1.3.0
  224. </code></pre>
  225. </li>
  226. <li>
  227. <p>Debian:</p>
  228. <pre><code class="language-bash"># replace `1.3.0` and `stretch` accordingly:
  229. wget https://packages.matrix.org/debian/pool/main/m/matrix-synapse-py3/matrix-synapse-py3_1.3.0+stretch1_amd64.deb
  230. dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
  231. </code></pre>
  232. </li>
  233. </ul>
  234. <h1 id="upgrading-to-v1660"><a class="header" href="#upgrading-to-v1660">Upgrading to v1.66.0</a></h1>
  235. <h2 id="delegation-of-email-validation-no-longer-supported"><a class="header" href="#delegation-of-email-validation-no-longer-supported">Delegation of email validation no longer supported</a></h2>
  236. <p>As of this version, Synapse no longer allows the tasks of verifying email address
  237. ownership, and password reset confirmation, to be delegated to an identity server.
  238. This removal was previously planned for Synapse 1.64.0, but was
  239. <a href="https://github.com/matrix-org/synapse/issues/13421">delayed</a> until now to give
  240. homeserver administrators more notice of the change.</p>
  241. <p>To continue to allow users to add email addresses to their homeserver accounts,
  242. and perform password resets, make sure that Synapse is configured with a working
  243. email server in the <a href="https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#email"><code>email</code> configuration
  244. section</a>
  245. (including, at a minimum, a <code>notif_from</code> setting.)</p>
  246. <p>Specifying an <code>email</code> setting under <code>account_threepid_delegates</code> will now cause
  247. an error at startup.</p>
  248. <h1 id="upgrading-to-v1640"><a class="header" href="#upgrading-to-v1640">Upgrading to v1.64.0</a></h1>
  249. <h2 id="deprecation-of-the-ability-to-delegate-e-mail-verification-to-identity-servers"><a class="header" href="#deprecation-of-the-ability-to-delegate-e-mail-verification-to-identity-servers">Deprecation of the ability to delegate e-mail verification to identity servers</a></h2>
  250. <p>Synapse v1.66.0 will remove the ability to delegate the tasks of verifying email address ownership, and password reset confirmation, to an identity server.</p>
  251. <p>If you require your homeserver to verify e-mail addresses or to support password resets via e-mail, please configure your homeserver with SMTP access so that it can send e-mails on its own behalf.
  252. <a href="https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#email">Consult the configuration documentation for more information.</a></p>
  253. <p>The option that will be removed is <code>account_threepid_delegates.email</code>.</p>
  254. <h2 id="changes-to-the-event-replication-streams"><a class="header" href="#changes-to-the-event-replication-streams">Changes to the event replication streams</a></h2>
  255. <p>Synapse now includes a flag indicating if an event is an outlier when
  256. replicating it to other workers. This is a forwards- and backwards-incompatible
  257. change: v1.63 and workers cannot process events replicated by v1.64 workers, and
  258. vice versa.</p>
  259. <p>Once all workers are upgraded to v1.64 (or downgraded to v1.63), event
  260. replication will resume as normal.</p>
  261. <h2 id="frozendict-release"><a class="header" href="#frozendict-release">frozendict release</a></h2>
  262. <p><a href="https://github.com/Marco-Sulla/python-frozendict/releases/tag/v2.3.3">frozendict 2.3.3</a>
  263. has recently been released, which fixes a memory leak that occurs during <code>/sync</code>
  264. requests. We advise server administrators who installed Synapse via pip to upgrade
  265. frozendict with <code>pip install --upgrade frozendict</code>. The Docker image
  266. <code>matrixdotorg/synapse</code> and the Debian packages from <code>packages.matrix.org</code> already
  267. include the updated library.</p>
  268. <h1 id="upgrading-to-v1620"><a class="header" href="#upgrading-to-v1620">Upgrading to v1.62.0</a></h1>
  269. <h2 id="new-signatures-for-spam-checker-callbacks"><a class="header" href="#new-signatures-for-spam-checker-callbacks">New signatures for spam checker callbacks</a></h2>
  270. <p>As a followup to changes in v1.60.0, the following spam-checker callbacks have changed signature:</p>
  271. <ul>
  272. <li><code>user_may_join_room</code></li>
  273. <li><code>user_may_invite</code></li>
  274. <li><code>user_may_send_3pid_invite</code></li>
  275. <li><code>user_may_create_room</code></li>
  276. <li><code>user_may_create_room_alias</code></li>
  277. <li><code>user_may_publish_room</code></li>
  278. <li><code>check_media_file_for_spam</code></li>
  279. </ul>
  280. <p>For each of these methods, the previous callback signature has been deprecated.</p>
  281. <p>Whereas callbacks used to return <code>bool</code>, they should now return <code>Union[&quot;synapse.module_api.NOT_SPAM&quot;, &quot;synapse.module_api.errors.Codes&quot;]</code>.</p>
  282. <p>For instance, if your module implements <code>user_may_join_room</code> as follows:</p>
  283. <pre><code class="language-python">async def user_may_join_room(self, user_id: str, room_id: str, is_invited: bool)
  284. if ...:
  285. # Request is spam
  286. return False
  287. # Request is not spam
  288. return True
  289. </code></pre>
  290. <p>you should rewrite it as follows:</p>
  291. <pre><code class="language-python">async def user_may_join_room(self, user_id: str, room_id: str, is_invited: bool)
  292. if ...:
  293. # Request is spam, mark it as forbidden (you may use some more precise error
  294. # code if it is useful).
  295. return synapse.module_api.errors.Codes.FORBIDDEN
  296. # Request is not spam, mark it as such.
  297. return synapse.module_api.NOT_SPAM
  298. </code></pre>
  299. <h1 id="upgrading-to-v1610"><a class="header" href="#upgrading-to-v1610">Upgrading to v1.61.0</a></h1>
  300. <h2 id="removal-of-deprecated-communitygroups"><a class="header" href="#removal-of-deprecated-communitygroups">Removal of deprecated community/groups</a></h2>
  301. <p>This release of Synapse will remove deprecated community/groups from codebase.</p>
  302. <h3 id="worker-endpoints"><a class="header" href="#worker-endpoints">Worker endpoints</a></h3>
  303. <p>For those who have deployed workers, following worker endpoints will no longer
  304. exist and they can be removed from the reverse proxy configuration:</p>
  305. <ul>
  306. <li><code>^/_matrix/federation/v1/get_groups_publicised$</code></li>
  307. <li><code>^/_matrix/client/(r0|v3|unstable)/joined_groups$</code></li>
  308. <li><code>^/_matrix/client/(r0|v3|unstable)/publicised_groups$</code></li>
  309. <li><code>^/_matrix/client/(r0|v3|unstable)/publicised_groups/</code></li>
  310. <li><code>^/_matrix/federation/v1/groups/</code></li>
  311. <li><code>^/_matrix/client/(r0|v3|unstable)/groups/</code></li>
  312. </ul>
  313. <h1 id="upgrading-to-v1600"><a class="header" href="#upgrading-to-v1600">Upgrading to v1.60.0</a></h1>
  314. <h2 id="adding-a-new-unique-index-to-state_group_edges-could-fail-if-your-database-is-corrupted"><a class="header" href="#adding-a-new-unique-index-to-state_group_edges-could-fail-if-your-database-is-corrupted">Adding a new unique index to <code>state_group_edges</code> could fail if your database is corrupted</a></h2>
  315. <p>This release of Synapse will add a unique index to the <code>state_group_edges</code> table, in order
  316. to prevent accidentally introducing duplicate information (for example, because a database
  317. backup was restored multiple times).</p>
  318. <p>Duplicate rows being present in this table could cause drastic performance problems; see
  319. <a href="https://github.com/matrix-org/synapse/issues/11779">issue 11779</a> for more details.</p>
  320. <p>If your Synapse database already has had duplicate rows introduced into this table,
  321. this could fail, with either of these errors:</p>
  322. <p><strong>On Postgres:</strong></p>
  323. <pre><code>synapse.storage.background_updates - 623 - INFO - background_updates-0 - Adding index state_group_edges_unique_idx to state_group_edges
  324. synapse.storage.background_updates - 282 - ERROR - background_updates-0 - Error doing update
  325. ...
  326. psycopg2.errors.UniqueViolation: could not create unique index &quot;state_group_edges_unique_idx&quot;
  327. DETAIL: Key (state_group, prev_state_group)=(2, 1) is duplicated.
  328. </code></pre>
  329. <p>(The numbers may be different.)</p>
  330. <p><strong>On SQLite:</strong></p>
  331. <pre><code>synapse.storage.background_updates - 623 - INFO - background_updates-0 - Adding index state_group_edges_unique_idx to state_group_edges
  332. synapse.storage.background_updates - 282 - ERROR - background_updates-0 - Error doing update
  333. ...
  334. sqlite3.IntegrityError: UNIQUE constraint failed: state_group_edges.state_group, state_group_edges.prev_state_group
  335. </code></pre>
  336. <details>
  337. <summary><b>Expand this section for steps to resolve this problem</b></summary>
  338. <h3 id="on-postgres"><a class="header" href="#on-postgres">On Postgres</a></h3>
  339. <p>Connect to your database with <code>psql</code>.</p>
  340. <pre><code class="language-sql">BEGIN;
  341. DELETE FROM state_group_edges WHERE (ctid, state_group, prev_state_group) IN (
  342. SELECT row_id, state_group, prev_state_group
  343. FROM (
  344. SELECT
  345. ctid AS row_id,
  346. MIN(ctid) OVER (PARTITION BY state_group, prev_state_group) AS min_row_id,
  347. state_group,
  348. prev_state_group
  349. FROM state_group_edges
  350. ) AS t1
  351. WHERE row_id &lt;&gt; min_row_id
  352. );
  353. COMMIT;
  354. </code></pre>
  355. <h3 id="on-sqlite"><a class="header" href="#on-sqlite">On SQLite</a></h3>
  356. <p>At the command-line, use <code>sqlite3 path/to/your-homeserver-database.db</code>:</p>
  357. <pre><code class="language-sql">BEGIN;
  358. DELETE FROM state_group_edges WHERE (rowid, state_group, prev_state_group) IN (
  359. SELECT row_id, state_group, prev_state_group
  360. FROM (
  361. SELECT
  362. rowid AS row_id,
  363. MIN(rowid) OVER (PARTITION BY state_group, prev_state_group) AS min_row_id,
  364. state_group,
  365. prev_state_group
  366. FROM state_group_edges
  367. )
  368. WHERE row_id &lt;&gt; min_row_id
  369. );
  370. COMMIT;
  371. </code></pre>
  372. <h3 id="for-more-details"><a class="header" href="#for-more-details">For more details</a></h3>
  373. <p><a href="https://github.com/matrix-org/synapse/issues/11779#issuecomment-1131545970">This comment on issue 11779</a>
  374. has queries that can be used to check a database for this problem in advance.</p>
  375. </details>
  376. <h2 id="new-signature-for-the-spam-checker-callback-check_event_for_spam"><a class="header" href="#new-signature-for-the-spam-checker-callback-check_event_for_spam">New signature for the spam checker callback <code>check_event_for_spam</code></a></h2>
  377. <p>The previous signature has been deprecated.</p>
  378. <p>Whereas <code>check_event_for_spam</code> callbacks used to return <code>Union[str, bool]</code>, they should now return <code>Union[&quot;synapse.module_api.NOT_SPAM&quot;, &quot;synapse.module_api.errors.Codes&quot;]</code>.</p>
  379. <p>This is part of an ongoing refactoring of the SpamChecker API to make it less ambiguous and more powerful.</p>
  380. <p>If your module implements <code>check_event_for_spam</code> as follows:</p>
  381. <pre><code class="language-python">async def check_event_for_spam(event):
  382. if ...:
  383. # Event is spam
  384. return True
  385. # Event is not spam
  386. return False
  387. </code></pre>
  388. <p>you should rewrite it as follows:</p>
  389. <pre><code class="language-python">async def check_event_for_spam(event):
  390. if ...:
  391. # Event is spam, mark it as forbidden (you may use some more precise error
  392. # code if it is useful).
  393. return synapse.module_api.errors.Codes.FORBIDDEN
  394. # Event is not spam, mark it as such.
  395. return synapse.module_api.NOT_SPAM
  396. </code></pre>
  397. <h1 id="upgrading-to-v1590"><a class="header" href="#upgrading-to-v1590">Upgrading to v1.59.0</a></h1>
  398. <h2 id="device-name-lookup-over-federation-has-been-disabled-by-default"><a class="header" href="#device-name-lookup-over-federation-has-been-disabled-by-default">Device name lookup over federation has been disabled by default</a></h2>
  399. <p>The names of user devices are no longer visible to users on other homeservers by default.
  400. Device IDs are unaffected, as these are necessary to facilitate end-to-end encryption.</p>
  401. <p>To re-enable this functionality, set the
  402. <a href="https://matrix-org.github.io/synapse/v1.59/usage/configuration/config_documentation.html#federation"><code>allow_device_name_lookup_over_federation</code></a>
  403. homeserver config option to <code>true</code>.</p>
  404. <h2 id="deprecation-of-the-synapseappappservice-and-synapseappuser_dir-worker-application-types"><a class="header" href="#deprecation-of-the-synapseappappservice-and-synapseappuser_dir-worker-application-types">Deprecation of the <code>synapse.app.appservice</code> and <code>synapse.app.user_dir</code> worker application types</a></h2>
  405. <p>The <code>synapse.app.appservice</code> worker application type allowed you to configure a
  406. single worker to use to notify application services of new events, as long
  407. as this functionality was disabled on the main process with <code>notify_appservices: False</code>.
  408. Further, the <code>synapse.app.user_dir</code> worker application type allowed you to configure
  409. a single worker to be responsible for updating the user directory, as long as this
  410. was disabled on the main process with <code>update_user_directory: False</code>.</p>
  411. <p>To unify Synapse's worker types, the <code>synapse.app.appservice</code> worker application
  412. type and the <code>notify_appservices</code> configuration option have been deprecated.
  413. The <code>synapse.app.user_dir</code> worker application type and <code>update_user_directory</code>
  414. configuration option have also been deprecated.</p>
  415. <p>To get the same functionality as was provided by the deprecated options, it's now recommended that the <code>synapse.app.generic_worker</code>
  416. worker application type is used and that the <code>notify_appservices_from_worker</code> and/or
  417. <code>update_user_directory_from_worker</code> options are set to the name of a worker.</p>
  418. <p>For the time being, the old options can be used alongside the new options to make
  419. it easier to transition between the two configurations, however please note that:</p>
  420. <ul>
  421. <li>the options must not contradict each other (otherwise Synapse won't start); and</li>
  422. <li>the <code>notify_appservices</code> and <code>update_user_directory</code> options will be removed in a future release of Synapse.</li>
  423. </ul>
  424. <p>Please see the <a href="workers.html#notifying-application-services"><em>Notifying Application Services</em></a> and
  425. <a href="workers.html#updating-the-user-directory"><em>Updating the User Directory</em></a> sections of the worker
  426. documentation for more information.</p>
  427. <h1 id="upgrading-to-v1580"><a class="header" href="#upgrading-to-v1580">Upgrading to v1.58.0</a></h1>
  428. <h2 id="groupscommunities-feature-has-been-disabled-by-default"><a class="header" href="#groupscommunities-feature-has-been-disabled-by-default">Groups/communities feature has been disabled by default</a></h2>
  429. <p>The non-standard groups/communities feature in Synapse has been disabled by default
  430. and will be removed in Synapse v1.61.0.</p>
  431. <h1 id="upgrading-to-v1570"><a class="header" href="#upgrading-to-v1570">Upgrading to v1.57.0</a></h1>
  432. <h2 id="changes-to-database-schema-for-application-services"><a class="header" href="#changes-to-database-schema-for-application-services">Changes to database schema for application services</a></h2>
  433. <p>Synapse v1.57.0 includes a <a href="https://github.com/matrix-org/synapse/pull/12209">change</a> to the
  434. way transaction IDs are managed for application services. If your deployment uses a dedicated
  435. worker for application service traffic, <strong>it must be stopped</strong> when the database is upgraded
  436. (which normally happens when the main process is upgraded), to ensure the change is made safely
  437. without any risk of reusing transaction IDs.</p>
  438. <p>Deployments which do not use separate worker processes can be upgraded as normal. Similarly,
  439. deployments where no application services are in use can be upgraded as normal.</p>
  440. <details>
  441. <summary><b>Recovering from an incorrect upgrade</b></summary>
  442. <p>If the database schema is upgraded <em>without</em> stopping the worker responsible
  443. for AS traffic, then the following error may be given when attempting to start
  444. a Synapse worker or master process:</p>
  445. <pre><code>**********************************************************************************
  446. Error during initialisation:
  447. Postgres sequence 'application_services_txn_id_seq' is inconsistent with associated
  448. table 'application_services_txns'. This can happen if Synapse has been downgraded and
  449. then upgraded again, or due to a bad migration.
  450. To fix this error, shut down Synapse (including any and all workers)
  451. and run the following SQL:
  452. SELECT setval('application_services_txn_id_seq', (
  453. SELECT GREATEST(MAX(txn_id), 0) FROM application_services_txns
  454. ));
  455. See docs/postgres.md for more information.
  456. There may be more information in the logs.
  457. **********************************************************************************
  458. </code></pre>
  459. <p>This error may also be seen if Synapse is <em>downgraded</em> to an earlier version,
  460. and then upgraded again to v1.57.0 or later.</p>
  461. <p>In either case:</p>
  462. <ol>
  463. <li>Ensure that the worker responsible for AS traffic is stopped.</li>
  464. <li>Run the SQL command given in the error message via <code>psql</code>.</li>
  465. </ol>
  466. <p>Synapse should then start correctly.</p>
  467. </details>
  468. <h1 id="upgrading-to-v1560"><a class="header" href="#upgrading-to-v1560">Upgrading to v1.56.0</a></h1>
  469. <h2 id="open-registration-without-verification-is-now-disabled-by-default"><a class="header" href="#open-registration-without-verification-is-now-disabled-by-default">Open registration without verification is now disabled by default</a></h2>
  470. <p>Synapse will refuse to start if registration is enabled without email, captcha, or token-based verification unless the new config
  471. flag <code>enable_registration_without_verification</code> is set to &quot;true&quot;.</p>
  472. <h2 id="groupscommunities-feature-has-been-deprecated"><a class="header" href="#groupscommunities-feature-has-been-deprecated">Groups/communities feature has been deprecated</a></h2>
  473. <p>The non-standard groups/communities feature in Synapse has been deprecated and will
  474. be disabled by default in Synapse v1.58.0.</p>
  475. <p>You can test disabling it by adding the following to your homeserver configuration:</p>
  476. <pre><code class="language-yaml">experimental_features:
  477. groups_enabled: false
  478. </code></pre>
  479. <h2 id="change-in-behaviour-for-postgresql-databases-with-unsafe-locale"><a class="header" href="#change-in-behaviour-for-postgresql-databases-with-unsafe-locale">Change in behaviour for PostgreSQL databases with unsafe locale</a></h2>
  480. <p>Synapse now refuses to start when using PostgreSQL with non-<code>C</code> values for <code>COLLATE</code> and
  481. <code>CTYPE</code> unless the config flag <code>allow_unsafe_locale</code>, found in the database section of
  482. the configuration file, is set to <code>true</code>. See the <a href="https://matrix-org.github.io/synapse/latest/postgres.html#fixing-incorrect-collate-or-ctype">PostgreSQL documentation</a>
  483. for more information and instructions on how to fix a database with incorrect values.</p>
  484. <h1 id="upgrading-to-v1550"><a class="header" href="#upgrading-to-v1550">Upgrading to v1.55.0</a></h1>
  485. <h2 id="synctl-script-has-been-moved"><a class="header" href="#synctl-script-has-been-moved"><code>synctl</code> script has been moved</a></h2>
  486. <p>The <code>synctl</code> script
  487. <a href="https://github.com/matrix-org/synapse/pull/12140">has been made</a> an
  488. <a href="https://packaging.python.org/en/latest/specifications/entry-points/">entry point</a>
  489. and no longer exists at the root of Synapse's source tree. If you wish to use
  490. <code>synctl</code> to manage your homeserver, you should invoke <code>synctl</code> directly, e.g.
  491. <code>synctl start</code> instead of <code>./synctl start</code> or <code>/path/to/synctl start</code>.</p>
  492. <p>You will need to ensure <code>synctl</code> is on your <code>PATH</code>.</p>
  493. <ul>
  494. <li>This is automatically the case when using
  495. <a href="https://packages.matrix.org/debian/">Debian packages</a> or
  496. <a href="https://hub.docker.com/r/matrixdotorg/synapse">docker images</a>
  497. provided by Matrix.org.</li>
  498. <li>When installing from a wheel, sdist, or PyPI, a <code>synctl</code> executable is added
  499. to your Python installation's <code>bin</code>. This should be on your <code>PATH</code>
  500. automatically, though you might need to activate a virtual environment
  501. depending on how you installed Synapse.</li>
  502. </ul>
  503. <h2 id="compatibility-dropped-for-mjolnir-131-and-earlier"><a class="header" href="#compatibility-dropped-for-mjolnir-131-and-earlier">Compatibility dropped for Mjolnir 1.3.1 and earlier</a></h2>
  504. <p>Synapse v1.55.0 drops support for Mjolnir 1.3.1 and earlier.
  505. If you use the Mjolnir module to moderate your homeserver,
  506. please upgrade Mjolnir to version 1.3.2 or later before upgrading Synapse.</p>
  507. <h1 id="upgrading-to-v1540"><a class="header" href="#upgrading-to-v1540">Upgrading to v1.54.0</a></h1>
  508. <h2 id="legacy-structured-logging-configuration-removal"><a class="header" href="#legacy-structured-logging-configuration-removal">Legacy structured logging configuration removal</a></h2>
  509. <p>This release removes support for the <code>structured: true</code> logging configuration
  510. which was deprecated in Synapse v1.23.0. If your logging configuration contains
  511. <code>structured: true</code> then it should be modified based on the
  512. <a href="https://matrix-org.github.io/synapse/v1.56/structured_logging.html#upgrading-from-legacy-structured-logging-configuration">structured logging documentation</a>.</p>
  513. <h1 id="upgrading-to-v1530"><a class="header" href="#upgrading-to-v1530">Upgrading to v1.53.0</a></h1>
  514. <h2 id="dropping-support-for-webclient-listeners-and-non-https-web_client_location"><a class="header" href="#dropping-support-for-webclient-listeners-and-non-https-web_client_location">Dropping support for <code>webclient</code> listeners and non-HTTP(S) <code>web_client_location</code></a></h2>
  515. <p>Per the deprecation notice in Synapse v1.51.0, listeners of type <code>webclient</code>
  516. are no longer supported and configuring them is a now a configuration error.</p>
  517. <p>Configuring a non-HTTP(S) <code>web_client_location</code> configuration is is now a
  518. configuration error. Since the <code>webclient</code> listener is no longer supported, this
  519. setting only applies to the root path <code>/</code> of Synapse's web server and no longer
  520. the <code>/_matrix/client/</code> path.</p>
  521. <h2 id="stablisation-of-msc3231"><a class="header" href="#stablisation-of-msc3231">Stablisation of MSC3231</a></h2>
  522. <p>The unstable validity-check endpoint for the
  523. <a href="https://spec.matrix.org/v1.2/client-server-api/#get_matrixclientv1registermloginregistration_tokenvalidity">Registration Tokens</a>
  524. feature has been stabilised and moved from:</p>
  525. <p><code>/_matrix/client/unstable/org.matrix.msc3231/register/org.matrix.msc3231.login.registration_token/validity</code></p>
  526. <p>to:</p>
  527. <p><code>/_matrix/client/v1/register/m.login.registration_token/validity</code></p>
  528. <p>Please update any relevant reverse proxy or firewall configurations appropriately.</p>
  529. <h2 id="time-based-cache-expiry-is-now-enabled-by-default"><a class="header" href="#time-based-cache-expiry-is-now-enabled-by-default">Time-based cache expiry is now enabled by default</a></h2>
  530. <p>Formerly, entries in the cache were not evicted regardless of whether they were accessed after storing.
  531. This behavior has now changed. By default entries in the cache are now evicted after 30m of not being accessed.
  532. To change the default behavior, go to the <code>caches</code> section of the config and change the <code>expire_caches</code> and
  533. <code>cache_entry_ttl</code> flags as necessary. Please note that these flags replace the <code>expiry_time</code> flag in the config.
  534. The <code>expiry_time</code> flag will still continue to work, but it has been deprecated and will be removed in the future.</p>
  535. <h2 id="deprecation-of-capability-orgmatrixmsc3283"><a class="header" href="#deprecation-of-capability-orgmatrixmsc3283">Deprecation of <code>capability</code> <code>org.matrix.msc3283.*</code></a></h2>
  536. <p>The <code>capabilities</code> of MSC3283 from the REST API <code>/_matrix/client/r0/capabilities</code>
  537. becomes stable.</p>
  538. <p>The old <code>capabilities</code></p>
  539. <ul>
  540. <li><code>org.matrix.msc3283.set_displayname</code>,</li>
  541. <li><code>org.matrix.msc3283.set_avatar_url</code> and</li>
  542. <li><code>org.matrix.msc3283.3pid_changes</code></li>
  543. </ul>
  544. <p>are deprecated and scheduled to be removed in Synapse v1.54.0.</p>
  545. <p>The new <code>capabilities</code></p>
  546. <ul>
  547. <li><code>m.set_displayname</code>,</li>
  548. <li><code>m.set_avatar_url</code> and</li>
  549. <li><code>m.3pid_changes</code></li>
  550. </ul>
  551. <p>are now active by default.</p>
  552. <h2 id="removal-of-user_may_create_room_with_invites"><a class="header" href="#removal-of-user_may_create_room_with_invites">Removal of <code>user_may_create_room_with_invites</code></a></h2>
  553. <p>As announced with the release of <a href="#deprecation-of-the-user_may_create_room_with_invites-module-callback">Synapse 1.47.0</a>,
  554. the deprecated <code>user_may_create_room_with_invites</code> module callback has been removed.</p>
  555. <p>Modules relying on it can instead implement <a href="https://matrix-org.github.io/synapse/latest/modules/spam_checker_callbacks.html#user_may_invite"><code>user_may_invite</code></a>
  556. and use the <a href="https://github.com/matrix-org/synapse/blob/872f23b95fa980a61b0866c1475e84491991fa20/synapse/module_api/__init__.py#L869-L876"><code>get_room_state</code></a>
  557. module API to infer whether the invite is happening while creating a room (see <a href="https://github.com/matrix-org/synapse-domain-rule-checker/blob/e7d092dd9f2a7f844928771dbfd9fd24c2332e48/synapse_domain_rule_checker/__init__.py#L56-L89">this function</a>
  558. as an example). Alternately, modules can also implement <a href="https://matrix-org.github.io/synapse/latest/modules/third_party_rules_callbacks.html#on_create_room"><code>on_create_room</code></a>.</p>
  559. <h1 id="upgrading-to-v1520"><a class="header" href="#upgrading-to-v1520">Upgrading to v1.52.0</a></h1>
  560. <h2 id="twisted-security-release"><a class="header" href="#twisted-security-release">Twisted security release</a></h2>
  561. <p>Note that <a href="https://github.com/twisted/twisted/releases/tag/twisted-22.1.0">Twisted 22.1.0</a>
  562. has recently been released, which fixes a <a href="https://github.com/twisted/twisted/security/advisories/GHSA-92x2-jw7w-xvvx">security issue</a>
  563. within the Twisted library. We do not believe Synapse is affected by this vulnerability,
  564. though we advise server administrators who installed Synapse via pip to upgrade Twisted
  565. with <code>pip install --upgrade Twisted treq</code> as a matter of good practice. The Docker image
  566. <code>matrixdotorg/synapse</code> and the Debian packages from <code>packages.matrix.org</code> are using the
  567. updated library.</p>
  568. <h1 id="upgrading-to-v1510"><a class="header" href="#upgrading-to-v1510">Upgrading to v1.51.0</a></h1>
  569. <h2 id="deprecation-of-webclient-listeners-and-non-https-web_client_location"><a class="header" href="#deprecation-of-webclient-listeners-and-non-https-web_client_location">Deprecation of <code>webclient</code> listeners and non-HTTP(S) <code>web_client_location</code></a></h2>
  570. <p>Listeners of type <code>webclient</code> are deprecated and scheduled to be removed in
  571. Synapse v1.53.0.</p>
  572. <p>Similarly, a non-HTTP(S) <code>web_client_location</code> configuration is deprecated and
  573. will become a configuration error in Synapse v1.53.0.</p>
  574. <h1 id="upgrading-to-v1500"><a class="header" href="#upgrading-to-v1500">Upgrading to v1.50.0</a></h1>
  575. <h2 id="dropping-support-for-old-python-and-postgres-versions"><a class="header" href="#dropping-support-for-old-python-and-postgres-versions">Dropping support for old Python and Postgres versions</a></h2>
  576. <p>In line with our <a href="deprecation_policy.html">deprecation policy</a>,
  577. we've dropped support for Python 3.6 and PostgreSQL 9.6, as they are no
  578. longer supported upstream.</p>
  579. <p>This release of Synapse requires Python 3.7+ and PostgreSQL 10+.</p>
  580. <h1 id="upgrading-to-v1470"><a class="header" href="#upgrading-to-v1470">Upgrading to v1.47.0</a></h1>
  581. <h2 id="removal-of-old-room-admin-api"><a class="header" href="#removal-of-old-room-admin-api">Removal of old Room Admin API</a></h2>
  582. <p>The following admin APIs were deprecated in <a href="https://github.com/matrix-org/synapse/blob/v1.34.0/CHANGES.md#deprecations-and-removals">Synapse 1.34</a>
  583. (released on 2021-05-17) and have now been removed:</p>
  584. <ul>
  585. <li><code>POST /_synapse/admin/v1/&lt;room_id&gt;/delete</code></li>
  586. </ul>
  587. <p>Any scripts still using the above APIs should be converted to use the
  588. <a href="https://matrix-org.github.io/synapse/latest/admin_api/rooms.html#delete-room-api">Delete Room API</a>.</p>
  589. <h2 id="deprecation-of-the-user_may_create_room_with_invites-module-callback"><a class="header" href="#deprecation-of-the-user_may_create_room_with_invites-module-callback">Deprecation of the <code>user_may_create_room_with_invites</code> module callback</a></h2>
  590. <p>The <code>user_may_create_room_with_invites</code> is deprecated and will be removed in a future
  591. version of Synapse. Modules implementing this callback can instead implement
  592. <a href="https://matrix-org.github.io/synapse/latest/modules/spam_checker_callbacks.html#user_may_invite"><code>user_may_invite</code></a>
  593. and use the <a href="https://github.com/matrix-org/synapse/blob/872f23b95fa980a61b0866c1475e84491991fa20/synapse/module_api/__init__.py#L869-L876"><code>get_room_state</code></a>
  594. module API method to infer whether the invite is happening in the context of creating a
  595. room.</p>
  596. <p>We plan to remove this callback in January 2022.</p>
  597. <h1 id="upgrading-to-v1450"><a class="header" href="#upgrading-to-v1450">Upgrading to v1.45.0</a></h1>
  598. <h2 id="changes-required-to-media-storage-provider-modules-when-reading-from-the-synapse-configuration-object"><a class="header" href="#changes-required-to-media-storage-provider-modules-when-reading-from-the-synapse-configuration-object">Changes required to media storage provider modules when reading from the Synapse configuration object</a></h2>
  599. <p>Media storage provider modules that read from the Synapse configuration object (i.e. that
  600. read the value of <code>hs.config.[...]</code>) now need to specify the configuration section they're
  601. reading from. This means that if a module reads the value of e.g. <code>hs.config.media_store_path</code>,
  602. it needs to replace it with <code>hs.config.media.media_store_path</code>.</p>
  603. <h1 id="upgrading-to-v1440"><a class="header" href="#upgrading-to-v1440">Upgrading to v1.44.0</a></h1>
  604. <h2 id="the-url-preview-cache-is-no-longer-mirrored-to-storage-providers"><a class="header" href="#the-url-preview-cache-is-no-longer-mirrored-to-storage-providers">The URL preview cache is no longer mirrored to storage providers</a></h2>
  605. <p>The <code>url_cache/</code> and <code>url_cache_thumbnails/</code> directories in the media store are
  606. no longer mirrored to storage providers. These two directories can be safely
  607. deleted from any configured storage providers to reclaim space.</p>
  608. <h1 id="upgrading-to-v1430"><a class="header" href="#upgrading-to-v1430">Upgrading to v1.43.0</a></h1>
  609. <h2 id="the-spaces-summary-apis-can-now-be-handled-by-workers"><a class="header" href="#the-spaces-summary-apis-can-now-be-handled-by-workers">The spaces summary APIs can now be handled by workers</a></h2>
  610. <p>The <a href="https://matrix-org.github.io/synapse/latest/workers.html#available-worker-applications">available worker applications documentation</a>
  611. has been updated to reflect that calls to the <code>/spaces</code>, <code>/hierarchy</code>, and
  612. <code>/summary</code> endpoints can now be routed to workers for both client API and
  613. federation requests.</p>
  614. <h1 id="upgrading-to-v1420"><a class="header" href="#upgrading-to-v1420">Upgrading to v1.42.0</a></h1>
  615. <h2 id="removal-of-old-room-admin-api-1"><a class="header" href="#removal-of-old-room-admin-api-1">Removal of old Room Admin API</a></h2>
  616. <p>The following admin APIs were deprecated in <a href="https://github.com/matrix-org/synapse/blob/v1.25.0/CHANGES.md#removal-warning">Synapse 1.25</a>
  617. (released on 2021-01-13) and have now been removed:</p>
  618. <ul>
  619. <li><code>POST /_synapse/admin/v1/purge_room</code></li>
  620. <li><code>POST /_synapse/admin/v1/shutdown_room/&lt;room_id&gt;</code></li>
  621. </ul>
  622. <p>Any scripts still using the above APIs should be converted to use the
  623. <a href="https://matrix-org.github.io/synapse/latest/admin_api/rooms.html#delete-room-api">Delete Room API</a>.</p>
  624. <h2 id="user-interactive-authentication-fallback-templates-can-now-display-errors"><a class="header" href="#user-interactive-authentication-fallback-templates-can-now-display-errors">User-interactive authentication fallback templates can now display errors</a></h2>
  625. <p>This may affect you if you make use of custom HTML templates for the
  626. <a href="../synapse/res/templates/recaptcha.html">reCAPTCHA</a> or
  627. <a href="../synapse/res/templates/terms.html">terms</a> fallback pages.</p>
  628. <p>The template is now provided an <code>error</code> variable if the authentication
  629. process failed. See the default templates linked above for an example.</p>
  630. <h2 id="removal-of-out-of-date-email-pushers"><a class="header" href="#removal-of-out-of-date-email-pushers">Removal of out-of-date email pushers</a></h2>
  631. <p>Users will stop receiving message updates via email for addresses that were
  632. once, but not still, linked to their account.</p>
  633. <h1 id="upgrading-to-v1410"><a class="header" href="#upgrading-to-v1410">Upgrading to v1.41.0</a></h1>
  634. <h2 id="add-support-for-routing-outbound-http-requests-via-a-proxy-for-federation"><a class="header" href="#add-support-for-routing-outbound-http-requests-via-a-proxy-for-federation">Add support for routing outbound HTTP requests via a proxy for federation</a></h2>
  635. <p>Since Synapse 1.6.0 (2019-11-26) you can set a proxy for outbound HTTP requests via
  636. http_proxy/https_proxy environment variables. This proxy was set for:</p>
  637. <ul>
  638. <li>push</li>
  639. <li>url previews</li>
  640. <li>phone-home stats</li>
  641. <li>recaptcha validation</li>
  642. <li>CAS auth validation</li>
  643. <li>OpenID Connect</li>
  644. <li>Federation (checking public key revocation)</li>
  645. </ul>
  646. <p>In this version we have added support for outbound requests for:</p>
  647. <ul>
  648. <li>Outbound federation</li>
  649. <li>Downloading remote media</li>
  650. <li>Fetching public keys of other servers</li>
  651. </ul>
  652. <p>These requests use the same proxy configuration. If you have a proxy configuration we
  653. recommend to verify the configuration. It may be necessary to adjust the <code>no_proxy</code>
  654. environment variable.</p>
  655. <p>See <a href="setup/forward_proxy.html">using a forward proxy with Synapse documentation</a> for
  656. details.</p>
  657. <h2 id="deprecation-of-template_dir"><a class="header" href="#deprecation-of-template_dir">Deprecation of <code>template_dir</code></a></h2>
  658. <p>The <code>template_dir</code> settings in the <code>sso</code>, <code>account_validity</code> and <code>email</code> sections of the
  659. configuration file are now deprecated. Server admins should use the new
  660. <code>templates.custom_template_directory</code> setting in the configuration file and use one single
  661. custom template directory for all aforementioned features. Template file names remain
  662. unchanged. See <a href="https://matrix-org.github.io/synapse/latest/templates.html">the related documentation</a>
  663. for more information and examples.</p>
  664. <p>We plan to remove support for these settings in October 2021.</p>
  665. <h2 id="_synapseadminv1usersuseridmedia-must-be-handled-by-media-workers"><a class="header" href="#_synapseadminv1usersuseridmedia-must-be-handled-by-media-workers"><code>/_synapse/admin/v1/users/{userId}/media</code> must be handled by media workers</a></h2>
  666. <p>The <a href="https://matrix-org.github.io/synapse/latest/workers.html#synapseappmedia_repository">media repository worker documentation</a>
  667. has been updated to reflect that calls to <code>/_synapse/admin/v1/users/{userId}/media</code>
  668. must now be handled by media repository workers. This is due to the new <code>DELETE</code> method
  669. of this endpoint modifying the media store.</p>
  670. <h1 id="upgrading-to-v1390"><a class="header" href="#upgrading-to-v1390">Upgrading to v1.39.0</a></h1>
  671. <h2 id="deprecation-of-the-current-third-party-rules-module-interface"><a class="header" href="#deprecation-of-the-current-third-party-rules-module-interface">Deprecation of the current third-party rules module interface</a></h2>
  672. <p>The current third-party rules module interface is deprecated in favour of the new generic
  673. modules system introduced in Synapse v1.37.0. Authors of third-party rules modules can refer
  674. to <a href="modules/porting_legacy_module.html">this documentation</a>
  675. to update their modules. Synapse administrators can refer to <a href="modules/index.html">this documentation</a>
  676. to update their configuration once the modules they are using have been updated.</p>
  677. <p>We plan to remove support for the current third-party rules interface in September 2021.</p>
  678. <h1 id="upgrading-to-v1380"><a class="header" href="#upgrading-to-v1380">Upgrading to v1.38.0</a></h1>
  679. <h2 id="re-indexing-of-events-table-on-postgres-databases"><a class="header" href="#re-indexing-of-events-table-on-postgres-databases">Re-indexing of <code>events</code> table on Postgres databases</a></h2>
  680. <p>This release includes a database schema update which requires re-indexing one of
  681. the larger tables in the database, <code>events</code>. This could result in increased
  682. disk I/O for several hours or days after upgrading while the migration
  683. completes. Furthermore, because we have to keep the old indexes until the new
  684. indexes are ready, it could result in a significant, temporary, increase in
  685. disk space.</p>
  686. <p>To get a rough idea of the disk space required, check the current size of one
  687. of the indexes. For example, from a <code>psql</code> shell, run the following sql:</p>
  688. <pre><code class="language-sql">SELECT pg_size_pretty(pg_relation_size('events_order_room'));
  689. </code></pre>
  690. <p>We need to rebuild <strong>four</strong> indexes, so you will need to multiply this result
  691. by four to give an estimate of the disk space required. For example, on one
  692. particular server:</p>
  693. <pre><code>synapse=# select pg_size_pretty(pg_relation_size('events_order_room'));
  694. pg_size_pretty
  695. ----------------
  696. 288 MB
  697. (1 row)
  698. </code></pre>
  699. <p>On this server, it would be wise to ensure that at least 1152MB are free.</p>
  700. <p>The additional disk space will be freed once the migration completes.</p>
  701. <p>SQLite databases are unaffected by this change.</p>
  702. <h1 id="upgrading-to-v1370"><a class="header" href="#upgrading-to-v1370">Upgrading to v1.37.0</a></h1>
  703. <h2 id="deprecation-of-the-current-spam-checker-interface"><a class="header" href="#deprecation-of-the-current-spam-checker-interface">Deprecation of the current spam checker interface</a></h2>
  704. <p>The current spam checker interface is deprecated in favour of a new generic modules system.
  705. Authors of spam checker modules can refer to [this
  706. documentation](modules/porting_legacy_module.md
  707. to update their modules. Synapse administrators can refer to <a href="modules/index.html">this
  708. documentation</a>
  709. to update their configuration once the modules they are using have been updated.</p>
  710. <p>We plan to remove support for the current spam checker interface in August 2021.</p>
  711. <p>More module interfaces will be ported over to this new generic system in future versions
  712. of Synapse.</p>
  713. <h1 id="upgrading-to-v1340"><a class="header" href="#upgrading-to-v1340">Upgrading to v1.34.0</a></h1>
  714. <h2 id="room_invite_state_types-configuration-setting"><a class="header" href="#room_invite_state_types-configuration-setting"><code>room_invite_state_types</code> configuration setting</a></h2>
  715. <p>The <code>room_invite_state_types</code> configuration setting has been deprecated
  716. and replaced with <code>room_prejoin_state</code>. See the <a href="https://github.com/matrix-org/synapse/blob/v1.34.0/docs/sample_config.yaml#L1515">sample configuration
  717. file</a>.</p>
  718. <p>If you have set <code>room_invite_state_types</code> to the default value you
  719. should simply remove it from your configuration file. The default value
  720. used to be:</p>
  721. <pre><code class="language-yaml">room_invite_state_types:
  722. - &quot;m.room.join_rules&quot;
  723. - &quot;m.room.canonical_alias&quot;
  724. - &quot;m.room.avatar&quot;
  725. - &quot;m.room.encryption&quot;
  726. - &quot;m.room.name&quot;
  727. </code></pre>
  728. <p>If you have customised this value, you should remove
  729. <code>room_invite_state_types</code> and configure <code>room_prejoin_state</code> instead.</p>
  730. <h1 id="upgrading-to-v1330"><a class="header" href="#upgrading-to-v1330">Upgrading to v1.33.0</a></h1>
  731. <h2 id="account-validity-html-templates-can-now-display-a-users-expiration-date"><a class="header" href="#account-validity-html-templates-can-now-display-a-users-expiration-date">Account Validity HTML templates can now display a user's expiration date</a></h2>
  732. <p>This may affect you if you have enabled the account validity feature,
  733. and have made use of a custom HTML template specified by the
  734. <code>account_validity.template_dir</code> or
  735. <code>account_validity.account_renewed_html_path</code> Synapse config options.</p>
  736. <p>The template can now accept an <code>expiration_ts</code> variable, which
  737. represents the unix timestamp in milliseconds for the future date of
  738. which their account has been renewed until. See the <a href="https://github.com/matrix-org/synapse/blob/release-v1.33.0/synapse/res/templates/account_renewed.html">default
  739. template</a>
  740. for an example of usage.</p>
  741. <p>ALso note that a new HTML template, <code>account_previously_renewed.html</code>,
  742. has been added. This is is shown to users when they attempt to renew
  743. their account with a valid renewal token that has already been used
  744. before. The default template contents can been found
  745. <a href="https://github.com/matrix-org/synapse/blob/release-v1.33.0/synapse/res/templates/account_previously_renewed.html">here</a>,
  746. and can also accept an <code>expiration_ts</code> variable. This template replaces
  747. the error message users would previously see upon attempting to use a
  748. valid renewal token more than once.</p>
  749. <h1 id="upgrading-to-v1320"><a class="header" href="#upgrading-to-v1320">Upgrading to v1.32.0</a></h1>
  750. <h2 id="regression-causing-connected-prometheus-instances-to-become-overwhelmed"><a class="header" href="#regression-causing-connected-prometheus-instances-to-become-overwhelmed">Regression causing connected Prometheus instances to become overwhelmed</a></h2>
  751. <p>This release introduces <a href="https://github.com/matrix-org/synapse/issues/9853">a
  752. regression</a> that can
  753. overwhelm connected Prometheus instances. This issue is not present in
  754. Synapse v1.32.0rc1.</p>
  755. <p>If you have been affected, please downgrade to 1.31.0. You then may need
  756. to remove excess writeahead logs in order for Prometheus to recover.
  757. Instructions for doing so are provided
  758. <a href="https://github.com/matrix-org/synapse/pull/9854#issuecomment-823472183">here</a>.</p>
  759. <h2 id="dropping-support-for-old-python-postgres-and-sqlite-versions"><a class="header" href="#dropping-support-for-old-python-postgres-and-sqlite-versions">Dropping support for old Python, Postgres and SQLite versions</a></h2>
  760. <p>In line with our <a href="deprecation_policy.html">deprecation policy</a>,
  761. we've dropped support for Python 3.5 and PostgreSQL 9.5, as they are no
  762. longer supported upstream.</p>
  763. <p>This release of Synapse requires Python 3.6+ and PostgresSQL 9.6+ or
  764. SQLite 3.22+.</p>
  765. <h2 id="removal-of-old-list-accounts-admin-api"><a class="header" href="#removal-of-old-list-accounts-admin-api">Removal of old List Accounts Admin API</a></h2>
  766. <p>The deprecated v1 &quot;list accounts&quot; admin API
  767. (<code>GET /_synapse/admin/v1/users/&lt;user_id&gt;</code>) has been removed in this
  768. version.</p>
  769. <p>The <a href="admin_api/user_admin_api.html#list-accounts">v2 list accounts API</a>
  770. has been available since Synapse 1.7.0 (2019-12-13), and is accessible
  771. under <code>GET /_synapse/admin/v2/users</code>.</p>
  772. <p>The deprecation of the old endpoint was announced with Synapse 1.28.0
  773. (released on 2021-02-25).</p>
  774. <h2 id="application-services-must-use-type-mloginapplication_service-when-registering-users"><a class="header" href="#application-services-must-use-type-mloginapplication_service-when-registering-users">Application Services must use type <code>m.login.application_service</code> when registering users</a></h2>
  775. <p>In compliance with the <a href="https://matrix.org/docs/spec/application_service/r0.1.2#server-admin-style-permissions">Application Service
  776. spec</a>,
  777. Application Services are now required to use the
  778. <code>m.login.application_service</code> type when registering users via the
  779. <code>/_matrix/client/r0/register</code> endpoint. This behaviour was deprecated in
  780. Synapse v1.30.0.</p>
  781. <p>Please ensure your Application Services are up to date.</p>
  782. <h1 id="upgrading-to-v1290"><a class="header" href="#upgrading-to-v1290">Upgrading to v1.29.0</a></h1>
  783. <h2 id="requirement-for-x-forwarded-proto-header"><a class="header" href="#requirement-for-x-forwarded-proto-header">Requirement for X-Forwarded-Proto header</a></h2>
  784. <p>When using Synapse with a reverse proxy (in particular, when using the
  785. <code>x_forwarded</code> option on an HTTP listener), Synapse now
  786. expects to receive an <code>X-Forwarded-Proto</code> header on incoming
  787. HTTP requests. If it is not set, Synapse will log a warning on each
  788. received request.</p>
  789. <p>To avoid the warning, administrators using a reverse proxy should ensure
  790. that the reverse proxy sets <code>X-Forwarded-Proto</code> header to
  791. <code>https</code> or <code>http</code> to indicate the protocol used
  792. by the client.</p>
  793. <p>Synapse also requires the <code>Host</code> header to be preserved.</p>
  794. <p>See the <a href="reverse_proxy.html">reverse proxy documentation</a>, where the
  795. example configurations have been updated to show how to set these
  796. headers.</p>
  797. <p>(Users of <a href="https://caddyserver.com/">Caddy</a> are unaffected, since we
  798. believe it sets <code>X-Forwarded-Proto</code> by default.)</p>
  799. <h1 id="upgrading-to-v1270"><a class="header" href="#upgrading-to-v1270">Upgrading to v1.27.0</a></h1>
  800. <h2 id="changes-to-callback-uri-for-oauth2--openid-connect-and-saml2"><a class="header" href="#changes-to-callback-uri-for-oauth2--openid-connect-and-saml2">Changes to callback URI for OAuth2 / OpenID Connect and SAML2</a></h2>
  801. <p>This version changes the URI used for callbacks from OAuth2 and SAML2
  802. identity providers:</p>
  803. <ul>
  804. <li>
  805. <p>If your server is configured for single sign-on via an OpenID
  806. Connect or OAuth2 identity provider, you will need to add
  807. <code>[synapse public baseurl]/_synapse/client/oidc/callback</code> to the list
  808. of permitted &quot;redirect URIs&quot; at the identity provider.</p>
  809. <p>See the <a href="openid.html">OpenID docs</a> for more information on setting
  810. up OpenID Connect.</p>
  811. </li>
  812. <li>
  813. <p>If your server is configured for single sign-on via a SAML2 identity
  814. provider, you will need to add
  815. <code>[synapse public baseurl]/_synapse/client/saml2/authn_response</code> as a
  816. permitted &quot;ACS location&quot; (also known as &quot;allowed callback URLs&quot;)
  817. at the identity provider.</p>
  818. <p>The &quot;Issuer&quot; in the &quot;AuthnRequest&quot; to the SAML2 identity
  819. provider is also updated to
  820. <code>[synapse public baseurl]/_synapse/client/saml2/metadata.xml</code>. If
  821. your SAML2 identity provider uses this property to validate or
  822. otherwise identify Synapse, its configuration will need to be
  823. updated to use the new URL. Alternatively you could create a new,
  824. separate &quot;EntityDescriptor&quot; in your SAML2 identity provider with
  825. the new URLs and leave the URLs in the existing &quot;EntityDescriptor&quot;
  826. as they were.</p>
  827. </li>
  828. </ul>
  829. <h2 id="changes-to-html-templates"><a class="header" href="#changes-to-html-templates">Changes to HTML templates</a></h2>
  830. <p>The HTML templates for SSO and email notifications now have <a href="https://jinja.palletsprojects.com/en/2.11.x/api/#autoescaping">Jinja2's
  831. autoescape</a>
  832. enabled for files ending in <code>.html</code>, <code>.htm</code>, and <code>.xml</code>. If you have
  833. customised these templates and see issues when viewing them you might
  834. need to update them. It is expected that most configurations will need
  835. no changes.</p>
  836. <p>If you have customised the templates <em>names</em> for these templates, it is
  837. recommended to verify they end in <code>.html</code> to ensure autoescape is
  838. enabled.</p>
  839. <p>The above applies to the following templates:</p>
  840. <ul>
  841. <li><code>add_threepid.html</code></li>
  842. <li><code>add_threepid_failure.html</code></li>
  843. <li><code>add_threepid_success.html</code></li>
  844. <li><code>notice_expiry.html</code></li>
  845. <li><code>notice_expiry.html</code></li>
  846. <li><code>notif_mail.html</code> (which, by default, includes <code>room.html</code> and
  847. <code>notif.html</code>)</li>
  848. <li><code>password_reset.html</code></li>
  849. <li><code>password_reset_confirmation.html</code></li>
  850. <li><code>password_reset_failure.html</code></li>
  851. <li><code>password_reset_success.html</code></li>
  852. <li><code>registration.html</code></li>
  853. <li><code>registration_failure.html</code></li>
  854. <li><code>registration_success.html</code></li>
  855. <li><code>sso_account_deactivated.html</code></li>
  856. <li><code>sso_auth_bad_user.html</code></li>
  857. <li><code>sso_auth_confirm.html</code></li>
  858. <li><code>sso_auth_success.html</code></li>
  859. <li><code>sso_error.html</code></li>
  860. <li><code>sso_login_idp_picker.html</code></li>
  861. <li><code>sso_redirect_confirm.html</code></li>
  862. </ul>
  863. <h1 id="upgrading-to-v1260"><a class="header" href="#upgrading-to-v1260">Upgrading to v1.26.0</a></h1>
  864. <h2 id="rolling-back-to-v1250-after-a-failed-upgrade"><a class="header" href="#rolling-back-to-v1250-after-a-failed-upgrade">Rolling back to v1.25.0 after a failed upgrade</a></h2>
  865. <p>v1.26.0 includes a lot of large changes. If something problematic
  866. occurs, you may want to roll-back to a previous version of Synapse.
  867. Because v1.26.0 also includes a new database schema version, reverting
  868. that version is also required alongside the generic rollback
  869. instructions mentioned above. In short, to roll back to v1.25.0 you need
  870. to:</p>
  871. <ol>
  872. <li>
  873. <p>Stop the server</p>
  874. </li>
  875. <li>
  876. <p>Decrease the schema version in the database:</p>
  877. <pre><code class="language-sql">UPDATE schema_version SET version = 58;
  878. </code></pre>
  879. </li>
  880. <li>
  881. <p>Delete the ignored users &amp; chain cover data:</p>
  882. <pre><code class="language-sql">DROP TABLE IF EXISTS ignored_users;
  883. UPDATE rooms SET has_auth_chain_index = false;
  884. </code></pre>
  885. <p>For PostgreSQL run:</p>
  886. <pre><code class="language-sql">TRUNCATE event_auth_chain_links;
  887. TRUNCATE event_auth_chains;
  888. </code></pre>
  889. <p>For SQLite run:</p>
  890. <pre><code class="language-sql">DELETE FROM event_auth_chain_links;
  891. DELETE FROM event_auth_chains;
  892. </code></pre>
  893. </li>
  894. <li>
  895. <p>Mark the deltas as not run (so they will re-run on upgrade).</p>
  896. <pre><code class="language-sql">DELETE FROM applied_schema_deltas WHERE version = 59 AND file = &quot;59/01ignored_user.py&quot;;
  897. DELETE FROM applied_schema_deltas WHERE version = 59 AND file = &quot;59/06chain_cover_index.sql&quot;;
  898. </code></pre>
  899. </li>
  900. <li>
  901. <p>Downgrade Synapse by following the instructions for your
  902. installation method in the &quot;Rolling back to older versions&quot;
  903. section above.</p>
  904. </li>
  905. </ol>
  906. <h1 id="upgrading-to-v1250"><a class="header" href="#upgrading-to-v1250">Upgrading to v1.25.0</a></h1>
  907. <h2 id="last-release-supporting-python-35"><a class="header" href="#last-release-supporting-python-35">Last release supporting Python 3.5</a></h2>
  908. <p>This is the last release of Synapse which guarantees support with Python
  909. 3.5, which passed its upstream End of Life date several months ago.</p>
  910. <p>We will attempt to maintain support through March 2021, but without
  911. guarantees.</p>
  912. <p>In the future, Synapse will follow upstream schedules for ending support
  913. of older versions of Python and PostgreSQL. Please upgrade to at least
  914. Python 3.6 and PostgreSQL 9.6 as soon as possible.</p>
  915. <h2 id="blacklisting-ip-ranges"><a class="header" href="#blacklisting-ip-ranges">Blacklisting IP ranges</a></h2>
  916. <p>Synapse v1.25.0 includes new settings, <code>ip_range_blacklist</code> and
  917. <code>ip_range_whitelist</code>, for controlling outgoing requests from Synapse for
  918. federation, identity servers, push, and for checking key validity for
  919. third-party invite events. The previous setting,
  920. <code>federation_ip_range_blacklist</code>, is deprecated. The new
  921. <code>ip_range_blacklist</code> defaults to private IP ranges if it is not defined.</p>
  922. <p>If you have never customised <code>federation_ip_range_blacklist</code> it is
  923. recommended that you remove that setting.</p>
  924. <p>If you have customised <code>federation_ip_range_blacklist</code> you should update
  925. the setting name to <code>ip_range_blacklist</code>.</p>
  926. <p>If you have a custom push server that is reached via private IP space
  927. you may need to customise <code>ip_range_blacklist</code> or <code>ip_range_whitelist</code>.</p>
  928. <h1 id="upgrading-to-v1240"><a class="header" href="#upgrading-to-v1240">Upgrading to v1.24.0</a></h1>
  929. <h2 id="custom-openid-connect-mapping-provider-breaking-change"><a class="header" href="#custom-openid-connect-mapping-provider-breaking-change">Custom OpenID Connect mapping provider breaking change</a></h2>
  930. <p>This release allows the OpenID Connect mapping provider to perform
  931. normalisation of the localpart of the Matrix ID. This allows for the
  932. mapping provider to specify different algorithms, instead of the
  933. <a href="https://matrix.org/docs/spec/appendices#mapping-from-other-character-sets">default
  934. way</a>.</p>
  935. <p>If your Synapse configuration uses a custom mapping provider
  936. (<code>oidc_config.user_mapping_provider.module</code> is specified and
  937. not equal to
  938. <code>synapse.handlers.oidc_handler.JinjaOidcMappingProvider</code>)
  939. then you <em>must</em> ensure that <code>map_user_attributes</code> of the
  940. mapping provider performs some normalisation of the
  941. <code>localpart</code> returned. To match previous behaviour you can
  942. use the <code>map_username_to_mxid_localpart</code> function provided
  943. by Synapse. An example is shown below:</p>
  944. <pre><code class="language-python">from synapse.types import map_username_to_mxid_localpart
  945. class MyMappingProvider:
  946. def map_user_attributes(self, userinfo, token):
  947. # ... your custom logic ...
  948. sso_user_id = ...
  949. localpart = map_username_to_mxid_localpart(sso_user_id)
  950. return {&quot;localpart&quot;: localpart}
  951. </code></pre>
  952. <h2 id="removal-historical-synapse-admin-api"><a class="header" href="#removal-historical-synapse-admin-api">Removal historical Synapse Admin API</a></h2>
  953. <p>Historically, the Synapse Admin API has been accessible under:</p>
  954. <ul>
  955. <li><code>/_matrix/client/api/v1/admin</code></li>
  956. <li><code>/_matrix/client/unstable/admin</code></li>
  957. <li><code>/_matrix/client/r0/admin</code></li>
  958. <li><code>/_synapse/admin/v1</code></li>
  959. </ul>
  960. <p>The endpoints with <code>/_matrix/client/*</code> prefixes have been removed as of
  961. v1.24.0. The Admin API is now only accessible under:</p>
  962. <ul>
  963. <li><code>/_synapse/admin/v1</code></li>
  964. </ul>
  965. <p>The only exception is the <code>/admin/whois</code> endpoint, which is
  966. <a href="https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-admin-whois-userid">also available via the client-server
  967. API</a>.</p>
  968. <p>The deprecation of the old endpoints was announced with Synapse 1.20.0
  969. (released on 2020-09-22) and makes it easier for homeserver admins to
  970. lock down external access to the Admin API endpoints.</p>
  971. <h1 id="upgrading-to-v1230"><a class="header" href="#upgrading-to-v1230">Upgrading to v1.23.0</a></h1>
  972. <h2 id="structured-logging-configuration-breaking-changes"><a class="header" href="#structured-logging-configuration-breaking-changes">Structured logging configuration breaking changes</a></h2>
  973. <p>This release deprecates use of the <code>structured: true</code> logging
  974. configuration for structured logging. If your logging configuration
  975. contains <code>structured: true</code> then it should be modified based on the
  976. <a href="https://matrix-org.github.io/synapse/v1.56/structured_logging.html#upgrading-from-legacy-structured-logging-configuration">structured logging documentation</a>.</p>
  977. <p>The <code>structured</code> and <code>drains</code> logging options are now deprecated and
  978. should be replaced by standard logging configuration of <code>handlers</code> and
  979. <code>formatters</code>.</p>
  980. <p>A future will release of Synapse will make using <code>structured: true</code> an
  981. error.</p>
  982. <h1 id="upgrading-to-v1220"><a class="header" href="#upgrading-to-v1220">Upgrading to v1.22.0</a></h1>
  983. <h2 id="thirdpartyeventrules-breaking-changes"><a class="header" href="#thirdpartyeventrules-breaking-changes">ThirdPartyEventRules breaking changes</a></h2>
  984. <p>This release introduces a backwards-incompatible change to modules
  985. making use of <code>ThirdPartyEventRules</code> in Synapse. If you make use of a
  986. module defined under the <code>third_party_event_rules</code> config option, please
  987. make sure it is updated to handle the below change:</p>
  988. <p>The <code>http_client</code> argument is no longer passed to modules as they are
  989. initialised. Instead, modules are expected to make use of the
  990. <code>http_client</code> property on the <code>ModuleApi</code> class. Modules are now passed
  991. a <code>module_api</code> argument during initialisation, which is an instance of
  992. <code>ModuleApi</code>. <code>ModuleApi</code> instances have a <code>http_client</code> property which
  993. acts the same as the <code>http_client</code> argument previously passed to
  994. <code>ThirdPartyEventRules</code> modules.</p>
  995. <h1 id="upgrading-to-v1210"><a class="header" href="#upgrading-to-v1210">Upgrading to v1.21.0</a></h1>
  996. <h2 id="forwarding-_synapseclient-through-your-reverse-proxy"><a class="header" href="#forwarding-_synapseclient-through-your-reverse-proxy">Forwarding <code>/_synapse/client</code> through your reverse proxy</a></h2>
  997. <p>The <a href="reverse_proxy.html">reverse proxy documentation</a>
  998. has been updated to include reverse proxy directives for
  999. <code>/_synapse/client/*</code> endpoints. As the user password reset flow now uses
  1000. endpoints under this prefix, <strong>you must update your reverse proxy
  1001. configurations for user password reset to work</strong>.</p>
  1002. <p>Additionally, note that the <a href="workers.html">Synapse worker documentation</a> has been updated to</p>
  1003. <p>: state that the <code>/_synapse/client/password_reset/email/submit_token</code>
  1004. endpoint can be handled</p>
  1005. <p>by all workers. If you make use of Synapse's worker feature, please
  1006. update your reverse proxy configuration to reflect this change.</p>
  1007. <h2 id="new-html-templates"><a class="header" href="#new-html-templates">New HTML templates</a></h2>
  1008. <p>A new HTML template,
  1009. <a href="https://github.com/matrix-org/synapse/blob/develop/synapse/res/templates/password_reset_confirmation.html">password_reset_confirmation.html</a>,
  1010. has been added to the <code>synapse/res/templates</code> directory. If you are
  1011. using a custom template directory, you may want to copy the template
  1012. over and modify it.</p>
  1013. <p>Note that as of v1.20.0, templates do not need to be included in custom
  1014. template directories for Synapse to start. The default templates will be
  1015. used if a custom template cannot be found.</p>
  1016. <p>This page will appear to the user after clicking a password reset link
  1017. that has been emailed to them.</p>
  1018. <p>To complete password reset, the page must include a way to make a
  1019. <code>POST</code> request to
  1020. <code>/_synapse/client/password_reset/{medium}/submit_token</code> with the query
  1021. parameters from the original link, presented as a URL-encoded form. See
  1022. the file itself for more details.</p>
  1023. <h2 id="updated-single-sign-on-html-templates"><a class="header" href="#updated-single-sign-on-html-templates">Updated Single Sign-on HTML Templates</a></h2>
  1024. <p>The <code>saml_error.html</code> template was removed from Synapse and replaced
  1025. with the <code>sso_error.html</code> template. If your Synapse is configured to use
  1026. SAML and a custom <code>sso_redirect_confirm_template_dir</code> configuration then
  1027. any customisations of the <code>saml_error.html</code> template will need to be
  1028. merged into the <code>sso_error.html</code> template. These templates are similar,
  1029. but the parameters are slightly different:</p>
  1030. <ul>
  1031. <li>The <code>msg</code> parameter should be renamed to <code>error_description</code>.</li>
  1032. <li>There is no longer a <code>code</code> parameter for the response code.</li>
  1033. <li>A string <code>error</code> parameter is available that includes a short hint
  1034. of why a user is seeing the error page.</li>
  1035. </ul>
  1036. <h1 id="upgrading-to-v1180"><a class="header" href="#upgrading-to-v1180">Upgrading to v1.18.0</a></h1>
  1037. <h2 id="docker--py3-suffix-will-be-removed-in-future-versions"><a class="header" href="#docker--py3-suffix-will-be-removed-in-future-versions">Docker <code>-py3</code> suffix will be removed in future versions</a></h2>
  1038. <p>From 10th August 2020, we will no longer publish Docker images with the
  1039. <code>-py3</code> tag suffix. The images tagged with the
  1040. <code>-py3</code> suffix have been identical to the non-suffixed tags
  1041. since release 0.99.0, and the suffix is obsolete.</p>
  1042. <p>On 10th August, we will remove the <code>latest-py3</code> tag.
  1043. Existing per-release tags (such as <code>v1.18.0-py3</code> will not
  1044. be removed, but no new <code>-py3</code> tags will be added.</p>
  1045. <p>Scripts relying on the <code>-py3</code> suffix will need to be
  1046. updated.</p>
  1047. <h2 id="redis-replication-is-now-recommended-in-lieu-of-tcp-replication"><a class="header" href="#redis-replication-is-now-recommended-in-lieu-of-tcp-replication">Redis replication is now recommended in lieu of TCP replication</a></h2>
  1048. <p>When setting up worker processes, we now recommend the use of a Redis
  1049. server for replication. <strong>The old direct TCP connection method is
  1050. deprecated and will be removed in a future release.</strong> See
  1051. the <a href="https://matrix-org.github.io/synapse/v1.66/workers.html">worker documentation</a> for more details.</p>
  1052. <h1 id="upgrading-to-v1140"><a class="header" href="#upgrading-to-v1140">Upgrading to v1.14.0</a></h1>
  1053. <p>This version includes a database update which is run as part of the
  1054. upgrade, and which may take a couple of minutes in the case of a large
  1055. server. Synapse will not respond to HTTP requests while this update is
  1056. taking place.</p>
  1057. <h1 id="upgrading-to-v1130"><a class="header" href="#upgrading-to-v1130">Upgrading to v1.13.0</a></h1>
  1058. <h2 id="incorrect-database-migration-in-old-synapse-versions"><a class="header" href="#incorrect-database-migration-in-old-synapse-versions">Incorrect database migration in old synapse versions</a></h2>
  1059. <p>A bug was introduced in Synapse 1.4.0 which could cause the room
  1060. directory to be incomplete or empty if Synapse was upgraded directly
  1061. from v1.2.1 or earlier, to versions between v1.4.0 and v1.12.x.</p>
  1062. <p>This will <em>not</em> be a problem for Synapse installations which were:</p>
  1063. <p>: - created at v1.4.0 or later,
  1064. - upgraded via v1.3.x, or
  1065. - upgraded straight from v1.2.1 or earlier to v1.13.0 or later.</p>
  1066. <p>If completeness of the room directory is a concern, installations which
  1067. are affected can be repaired as follows:</p>
  1068. <ol>
  1069. <li>
  1070. <p>Run the following sql from a <code>psql</code> or
  1071. <code>sqlite3</code> console:</p>
  1072. <pre><code class="language-sql">INSERT INTO background_updates (update_name, progress_json, depends_on) VALUES
  1073. ('populate_stats_process_rooms', '{}', 'current_state_events_membership');
  1074. INSERT INTO background_updates (update_name, progress_json, depends_on) VALUES
  1075. ('populate_stats_process_users', '{}', 'populate_stats_process_rooms');
  1076. </code></pre>
  1077. </li>
  1078. <li>
  1079. <p>Restart synapse.</p>
  1080. </li>
  1081. </ol>
  1082. <h2 id="new-single-sign-on-html-templates"><a class="header" href="#new-single-sign-on-html-templates">New Single Sign-on HTML Templates</a></h2>
  1083. <p>New templates (<code>sso_auth_confirm.html</code>, <code>sso_auth_success.html</code>, and
  1084. <code>sso_account_deactivated.html</code>) were added to Synapse. If your Synapse
  1085. is configured to use SSO and a custom
  1086. <code>sso_redirect_confirm_template_dir</code> configuration then these templates
  1087. will need to be copied from
  1088. <a href="synapse/res/templates">synapse/res/templates</a> into that directory.</p>
  1089. <h2 id="synapse-sso-plugins-method-deprecation"><a class="header" href="#synapse-sso-plugins-method-deprecation">Synapse SSO Plugins Method Deprecation</a></h2>
  1090. <p>Plugins using the <code>complete_sso_login</code> method of
  1091. <code>synapse.module_api.ModuleApi</code> should update to using the async/await
  1092. version <code>complete_sso_login_async</code> which includes additional checks. The
  1093. non-async version is considered deprecated.</p>
  1094. <h2 id="rolling-back-to-v1124-after-a-failed-upgrade"><a class="header" href="#rolling-back-to-v1124-after-a-failed-upgrade">Rolling back to v1.12.4 after a failed upgrade</a></h2>
  1095. <p>v1.13.0 includes a lot of large changes. If something problematic
  1096. occurs, you may want to roll-back to a previous version of Synapse.
  1097. Because v1.13.0 also includes a new database schema version, reverting
  1098. that version is also required alongside the generic rollback
  1099. instructions mentioned above. In short, to roll back to v1.12.4 you need
  1100. to:</p>
  1101. <ol>
  1102. <li>
  1103. <p>Stop the server</p>
  1104. </li>
  1105. <li>
  1106. <p>Decrease the schema version in the database:</p>
  1107. <pre><code class="language-sql">UPDATE schema_version SET version = 57;
  1108. </code></pre>
  1109. </li>
  1110. <li>
  1111. <p>Downgrade Synapse by following the instructions for your
  1112. installation method in the &quot;Rolling back to older versions&quot;
  1113. section above.</p>
  1114. </li>
  1115. </ol>
  1116. <h1 id="upgrading-to-v1120"><a class="header" href="#upgrading-to-v1120">Upgrading to v1.12.0</a></h1>
  1117. <p>This version includes a database update which is run as part of the
  1118. upgrade, and which may take some time (several hours in the case of a
  1119. large server). Synapse will not respond to HTTP requests while this
  1120. update is taking place.</p>
  1121. <p>This is only likely to be a problem in the case of a server which is
  1122. participating in many rooms.</p>
  1123. <ol start="0">
  1124. <li>
  1125. <p>As with all upgrades, it is recommended that you have a recent
  1126. backup of your database which can be used for recovery in the event
  1127. of any problems.</p>
  1128. </li>
  1129. <li>
  1130. <p>As an initial check to see if you will be affected, you can try
  1131. running the following query from the <code>psql</code> or
  1132. <code>sqlite3</code> console. It is safe to run it while Synapse is
  1133. still running.</p>
  1134. <pre><code class="language-sql">SELECT MAX(q.v) FROM (
  1135. SELECT (
  1136. SELECT ej.json AS v
  1137. FROM state_events se INNER JOIN event_json ej USING (event_id)
  1138. WHERE se.room_id=rooms.room_id AND se.type='m.room.create' AND se.state_key=''
  1139. LIMIT 1
  1140. ) FROM rooms WHERE rooms.room_version IS NULL
  1141. ) q;
  1142. </code></pre>
  1143. <p>This query will take about the same amount of time as the upgrade
  1144. process: ie, if it takes 5 minutes, then it is likely that Synapse
  1145. will be unresponsive for 5 minutes during the upgrade.</p>
  1146. <p>If you consider an outage of this duration to be acceptable, no
  1147. further action is necessary and you can simply start Synapse 1.12.0.</p>
  1148. <p>If you would prefer to reduce the downtime, continue with the steps
  1149. below.</p>
  1150. </li>
  1151. <li>
  1152. <p>The easiest workaround for this issue is to manually create a new
  1153. index before upgrading. On PostgreSQL, his can be done as follows:</p>
  1154. <pre><code class="language-sql">CREATE INDEX CONCURRENTLY tmp_upgrade_1_12_0_index
  1155. ON state_events(room_id) WHERE type = 'm.room.create';
  1156. </code></pre>
  1157. <p>The above query may take some time, but is also safe to run while
  1158. Synapse is running.</p>
  1159. <p>We assume that no SQLite users have databases large enough to be
  1160. affected. If you <em>are</em> affected, you can run a similar query,
  1161. omitting the <code>CONCURRENTLY</code> keyword. Note however that this
  1162. operation may in itself cause Synapse to stop running for some time.
  1163. Synapse admins are reminded that <a href="postgres.html">SQLite is not recommended for use
  1164. outside a test environment</a>.</p>
  1165. </li>
  1166. <li>
  1167. <p>Once the index has been created, the <code>SELECT</code> query in step 1 above
  1168. should complete quickly. It is therefore safe to upgrade to Synapse
  1169. 1.12.0.</p>
  1170. </li>
  1171. <li>
  1172. <p>Once Synapse 1.12.0 has successfully started and is responding to
  1173. HTTP requests, the temporary index can be removed:</p>
  1174. <pre><code class="language-sql">DROP INDEX tmp_upgrade_1_12_0_index;
  1175. </code></pre>
  1176. </li>
  1177. </ol>
  1178. <h1 id="upgrading-to-v1100"><a class="header" href="#upgrading-to-v1100">Upgrading to v1.10.0</a></h1>
  1179. <p>Synapse will now log a warning on start up if used with a PostgreSQL
  1180. database that has a non-recommended locale set.</p>
  1181. <p>See <a href="postgres.html">Postgres</a> for details.</p>
  1182. <h1 id="upgrading-to-v180"><a class="header" href="#upgrading-to-v180">Upgrading to v1.8.0</a></h1>
  1183. <p>Specifying a <code>log_file</code> config option will now cause Synapse to refuse
  1184. to start, and should be replaced by with the <code>log_config</code> option.
  1185. Support for the <code>log_file</code> option was removed in v1.3.0 and has since
  1186. had no effect.</p>
  1187. <h1 id="upgrading-to-v170"><a class="header" href="#upgrading-to-v170">Upgrading to v1.7.0</a></h1>
  1188. <p>In an attempt to configure Synapse in a privacy preserving way, the
  1189. default behaviours of <code>allow_public_rooms_without_auth</code> and
  1190. <code>allow_public_rooms_over_federation</code> have been inverted. This means that
  1191. by default, only authenticated users querying the Client/Server API will
  1192. be able to query the room directory, and relatedly that the server will
  1193. not share room directory information with other servers over federation.</p>
  1194. <p>If your installation does not explicitly set these settings one way or
  1195. the other and you want either setting to be <code>true</code> then it will
  1196. necessary to update your homeserver configuration file accordingly.</p>
  1197. <p>For more details on the surrounding context see our
  1198. <a href="https://matrix.org/blog/2019/11/09/avoiding-unwelcome-visitors-on-private-matrix-servers">explainer</a>.</p>
  1199. <h1 id="upgrading-to-v150"><a class="header" href="#upgrading-to-v150">Upgrading to v1.5.0</a></h1>
  1200. <p>This release includes a database migration which may take several
  1201. minutes to complete if there are a large number (more than a million or
  1202. so) of entries in the <code>devices</code> table. This is only likely to a be a
  1203. problem on very large installations.</p>
  1204. <h1 id="upgrading-to-v140"><a class="header" href="#upgrading-to-v140">Upgrading to v1.4.0</a></h1>
  1205. <h2 id="new-custom-templates"><a class="header" href="#new-custom-templates">New custom templates</a></h2>
  1206. <p>If you have configured a custom template directory with the
  1207. <code>email.template_dir</code> option, be aware that there are new templates
  1208. regarding registration and threepid management (see below) that must be
  1209. included.</p>
  1210. <ul>
  1211. <li><code>registration.html</code> and <code>registration.txt</code></li>
  1212. <li><code>registration_success.html</code> and <code>registration_failure.html</code></li>
  1213. <li><code>add_threepid.html</code> and <code>add_threepid.txt</code></li>
  1214. <li><code>add_threepid_failure.html</code> and <code>add_threepid_success.html</code></li>
  1215. </ul>
  1216. <p>Synapse will expect these files to exist inside the configured template
  1217. directory, and <strong>will fail to start</strong> if they are absent. To view the
  1218. default templates, see
  1219. <a href="https://github.com/matrix-org/synapse/tree/master/synapse/res/templates">synapse/res/templates</a>.</p>
  1220. <h2 id="3pid-verification-changes"><a class="header" href="#3pid-verification-changes">3pid verification changes</a></h2>
  1221. <p><strong>Note: As of this release, users will be unable to add phone numbers or
  1222. email addresses to their accounts, without changes to the Synapse
  1223. configuration. This includes adding an email address during
  1224. registration.</strong></p>
  1225. <p>It is possible for a user to associate an email address or phone number
  1226. with their account, for a number of reasons:</p>
  1227. <ul>
  1228. <li>for use when logging in, as an alternative to the user id.</li>
  1229. <li>in the case of email, as an alternative contact to help with account
  1230. recovery.</li>
  1231. <li>in the case of email, to receive notifications of missed messages.</li>
  1232. </ul>
  1233. <p>Before an email address or phone number can be added to a user's
  1234. account, or before such an address is used to carry out a
  1235. password-reset, Synapse must confirm the operation with the owner of the
  1236. email address or phone number. It does this by sending an email or text
  1237. giving the user a link or token to confirm receipt. This process is
  1238. known as '3pid verification'. ('3pid', or 'threepid', stands for
  1239. third-party identifier, and we use it to refer to external identifiers
  1240. such as email addresses and phone numbers.)</p>
  1241. <p>Previous versions of Synapse delegated the task of 3pid verification to
  1242. an identity server by default. In most cases this server is <code>vector.im</code>
  1243. or <code>matrix.org</code>.</p>
  1244. <p>In Synapse 1.4.0, for security and privacy reasons, the homeserver will
  1245. no longer delegate this task to an identity server by default. Instead,
  1246. the server administrator will need to explicitly decide how they would
  1247. like the verification messages to be sent.</p>
  1248. <p>In the medium term, the <code>vector.im</code> and <code>matrix.org</code> identity servers
  1249. will disable support for delegated 3pid verification entirely. However,
  1250. in order to ease the transition, they will retain the capability for a
  1251. limited period. Delegated email verification will be disabled on Monday
  1252. 2nd December 2019 (giving roughly 2 months notice). Disabling delegated
  1253. SMS verification will follow some time after that once SMS verification
  1254. support lands in Synapse.</p>
  1255. <p>Once delegated 3pid verification support has been disabled in the
  1256. <code>vector.im</code> and <code>matrix.org</code> identity servers, all Synapse versions that
  1257. depend on those instances will be unable to verify email and phone
  1258. numbers through them. There are no imminent plans to remove delegated
  1259. 3pid verification from Sydent generally. (Sydent is the identity server
  1260. project that backs the <code>vector.im</code> and <code>matrix.org</code> instances).</p>
  1261. <h3 id="email"><a class="header" href="#email">Email</a></h3>
  1262. <p>Following upgrade, to continue verifying email (e.g. as part of the
  1263. registration process), admins can either:-</p>
  1264. <ul>
  1265. <li>Configure Synapse to use an email server.</li>
  1266. <li>Run or choose an identity server which allows delegated email
  1267. verification and delegate to it.</li>
  1268. </ul>
  1269. <h4 id="configure-smtp-in-synapse"><a class="header" href="#configure-smtp-in-synapse">Configure SMTP in Synapse</a></h4>
  1270. <p>To configure an SMTP server for Synapse, modify the configuration
  1271. section headed <code>email</code>, and be sure to have at least the
  1272. <code>smtp_host, smtp_port</code> and <code>notif_from</code> fields filled out.</p>
  1273. <p>You may also need to set <code>smtp_user</code>, <code>smtp_pass</code>, and
  1274. <code>require_transport_security</code>.</p>
  1275. <p>See the <a href="usage/configuration/homeserver_sample_config.html">sample configuration file</a>
  1276. for more details on these settings.</p>
  1277. <h4 id="delegate-email-to-an-identity-server"><a class="header" href="#delegate-email-to-an-identity-server">Delegate email to an identity server</a></h4>
  1278. <p>Some admins will wish to continue using email verification as part of
  1279. the registration process, but will not immediately have an appropriate
  1280. SMTP server at hand.</p>
  1281. <p>To this end, we will continue to support email verification delegation
  1282. via the <code>vector.im</code> and <code>matrix.org</code> identity servers for two months.
  1283. Support for delegated email verification will be disabled on Monday 2nd
  1284. December.</p>
  1285. <p>The <code>account_threepid_delegates</code> dictionary defines whether the
  1286. homeserver should delegate an external server (typically an <a href="https://matrix.org/docs/spec/identity_service/r0.2.1">identity
  1287. server</a>) to handle
  1288. sending confirmation messages via email and SMS.</p>
  1289. <p>So to delegate email verification, in <code>homeserver.yaml</code>, set
  1290. <code>account_threepid_delegates.email</code> to the base URL of an identity
  1291. server. For example:</p>
  1292. <pre><code class="language-yaml">account_threepid_delegates:
  1293. email: https://example.com # Delegate email sending to example.com
  1294. </code></pre>
  1295. <p>Note that <code>account_threepid_delegates.email</code> replaces the deprecated
  1296. <code>email.trust_identity_server_for_password_resets</code>: if
  1297. <code>email.trust_identity_server_for_password_resets</code> is set to <code>true</code>, and
  1298. <code>account_threepid_delegates.email</code> is not set, then the first entry in
  1299. <code>trusted_third_party_id_servers</code> will be used as the
  1300. <code>account_threepid_delegate</code> for email. This is to ensure compatibility
  1301. with existing Synapse installs that set up external server handling for
  1302. these tasks before v1.4.0. If
  1303. <code>email.trust_identity_server_for_password_resets</code> is <code>true</code> and no
  1304. trusted identity server domains are configured, Synapse will report an
  1305. error and refuse to start.</p>
  1306. <p>If <code>email.trust_identity_server_for_password_resets</code> is <code>false</code> or
  1307. absent and no <code>email</code> delegate is configured in
  1308. <code>account_threepid_delegates</code>, then Synapse will send email verification
  1309. messages itself, using the configured SMTP server (see above). that
  1310. type.</p>
  1311. <h3 id="phone-numbers"><a class="header" href="#phone-numbers">Phone numbers</a></h3>
  1312. <p>Synapse does not support phone-number verification itself, so the only
  1313. way to maintain the ability for users to add phone numbers to their
  1314. accounts will be by continuing to delegate phone number verification to
  1315. the <code>matrix.org</code> and <code>vector.im</code> identity servers (or another identity
  1316. server that supports SMS sending).</p>
  1317. <p>The <code>account_threepid_delegates</code> dictionary defines whether the
  1318. homeserver should delegate an external server (typically an <a href="https://matrix.org/docs/spec/identity_service/r0.2.1">identity
  1319. server</a>) to handle
  1320. sending confirmation messages via email and SMS.</p>
  1321. <p>So to delegate phone number verification, in <code>homeserver.yaml</code>, set
  1322. <code>account_threepid_delegates.msisdn</code> to the base URL of an identity
  1323. server. For example:</p>
  1324. <pre><code class="language-yaml">account_threepid_delegates:
  1325. msisdn: https://example.com # Delegate sms sending to example.com
  1326. </code></pre>
  1327. <p>The <code>matrix.org</code> and <code>vector.im</code> identity servers will continue to
  1328. support delegated phone number verification via SMS until such time as
  1329. it is possible for admins to configure their servers to perform phone
  1330. number verification directly. More details will follow in a future
  1331. release.</p>
  1332. <h2 id="rolling-back-to-v131"><a class="header" href="#rolling-back-to-v131">Rolling back to v1.3.1</a></h2>
  1333. <p>If you encounter problems with v1.4.0, it should be possible to roll
  1334. back to v1.3.1, subject to the following:</p>
  1335. <ul>
  1336. <li>
  1337. <p>The 'room statistics' engine was heavily reworked in this release
  1338. (see <a href="https://github.com/matrix-org/synapse/pull/5971">#5971</a>),
  1339. including significant changes to the database schema, which are not
  1340. easily reverted. This will cause the room statistics engine to stop
  1341. updating when you downgrade.</p>
  1342. <p>The room statistics are essentially unused in v1.3.1 (in future
  1343. versions of Synapse, they will be used to populate the room
  1344. directory), so there should be no loss of functionality. However,
  1345. the statistics engine will write errors to the logs, which can be
  1346. avoided by setting the following in <code>homeserver.yaml</code>:</p>
  1347. <pre><code class="language-yaml">stats:
  1348. enabled: false
  1349. </code></pre>
  1350. <p>Don't forget to re-enable it when you upgrade again, in preparation
  1351. for its use in the room directory!</p>
  1352. </li>
  1353. </ul>
  1354. <h1 id="upgrading-to-v120"><a class="header" href="#upgrading-to-v120">Upgrading to v1.2.0</a></h1>
  1355. <p>Some counter metrics have been renamed, with the old names deprecated.
  1356. See <a href="metrics-howto.html#renaming-of-metrics--deprecation-of-old-names-in-12">the metrics
  1357. documentation</a>
  1358. for details.</p>
  1359. <h1 id="upgrading-to-v110"><a class="header" href="#upgrading-to-v110">Upgrading to v1.1.0</a></h1>
  1360. <p>Synapse v1.1.0 removes support for older Python and PostgreSQL versions,
  1361. as outlined in <a href="https://matrix.org/blog/2019/04/08/synapse-deprecating-postgres-9-4-and-python-2-x">our deprecation
  1362. notice</a>.</p>
  1363. <h2 id="minimum-python-version"><a class="header" href="#minimum-python-version">Minimum Python Version</a></h2>
  1364. <p>Synapse v1.1.0 has a minimum Python requirement of Python 3.5. Python
  1365. 3.6 or Python 3.7 are recommended as they have improved internal string
  1366. handling, significantly reducing memory usage.</p>
  1367. <p>If you use current versions of the Matrix.org-distributed Debian
  1368. packages or Docker images, action is not required.</p>
  1369. <p>If you install Synapse in a Python virtual environment, please see
  1370. &quot;Upgrading to v0.34.0&quot; for notes on setting up a new virtualenv under
  1371. Python 3.</p>
  1372. <h2 id="minimum-postgresql-version"><a class="header" href="#minimum-postgresql-version">Minimum PostgreSQL Version</a></h2>
  1373. <p>If using PostgreSQL under Synapse, you will need to use PostgreSQL 9.5
  1374. or above. Please see the <a href="https://www.postgresql.org/docs/11/upgrading.html">PostgreSQL
  1375. documentation</a> for
  1376. more details on upgrading your database.</p>
  1377. <h1 id="upgrading-to-v10"><a class="header" href="#upgrading-to-v10">Upgrading to v1.0</a></h1>
  1378. <h2 id="validation-of-tls-certificates"><a class="header" href="#validation-of-tls-certificates">Validation of TLS certificates</a></h2>
  1379. <p>Synapse v1.0 is the first release to enforce validation of TLS
  1380. certificates for the federation API. It is therefore essential that your
  1381. certificates are correctly configured.</p>
  1382. <p>Note, v1.0 installations will also no longer be able to federate with
  1383. servers that have not correctly configured their certificates.</p>
  1384. <p>In rare cases, it may be desirable to disable certificate checking: for
  1385. example, it might be essential to be able to federate with a given
  1386. legacy server in a closed federation. This can be done in one of two
  1387. ways:-</p>
  1388. <ul>
  1389. <li>Configure the global switch <code>federation_verify_certificates</code> to
  1390. <code>false</code>.</li>
  1391. <li>Configure a whitelist of server domains to trust via
  1392. <code>federation_certificate_verification_whitelist</code>.</li>
  1393. </ul>
  1394. <p>See the <a href="usage/configuration/homeserver_sample_config.html">sample configuration file</a>
  1395. for more details on these settings.</p>
  1396. <h2 id="email-1"><a class="header" href="#email-1">Email</a></h2>
  1397. <p>When a user requests a password reset, Synapse will send an email to the
  1398. user to confirm the request.</p>
  1399. <p>Previous versions of Synapse delegated the job of sending this email to
  1400. an identity server. If the identity server was somehow malicious or
  1401. became compromised, it would be theoretically possible to hijack an
  1402. account through this means.</p>
  1403. <p>Therefore, by default, Synapse v1.0 will send the confirmation email
  1404. itself. If Synapse is not configured with an SMTP server, password reset
  1405. via email will be disabled.</p>
  1406. <p>To configure an SMTP server for Synapse, modify the configuration
  1407. section headed <code>email</code>, and be sure to have at least the <code>smtp_host</code>,
  1408. <code>smtp_port</code> and <code>notif_from</code> fields filled out. You may also need to set
  1409. <code>smtp_user</code>, <code>smtp_pass</code>, and <code>require_transport_security</code>.</p>
  1410. <p>If you are absolutely certain that you wish to continue using an
  1411. identity server for password resets, set
  1412. <code>trust_identity_server_for_password_resets</code> to <code>true</code>.</p>
  1413. <p>See the <a href="usage/configuration/homeserver_sample_config.html">sample configuration file</a>
  1414. for more details on these settings.</p>
  1415. <h2 id="new-email-templates"><a class="header" href="#new-email-templates">New email templates</a></h2>
  1416. <p>Some new templates have been added to the default template directory for the purpose of
  1417. the homeserver sending its own password reset emails. If you have configured a
  1418. custom <code>template_dir</code> in your Synapse config, these files will need to be added.</p>
  1419. <p><code>password_reset.html</code> and <code>password_reset.txt</code> are HTML and plain text
  1420. templates respectively that contain the contents of what will be emailed
  1421. to the user upon attempting to reset their password via email.
  1422. <code>password_reset_success.html</code> and <code>password_reset_failure.html</code> are HTML
  1423. files that the content of which (assuming no redirect URL is set) will
  1424. be shown to the user after they attempt to click the link in the email
  1425. sent to them.</p>
  1426. <h1 id="upgrading-to-v0990"><a class="header" href="#upgrading-to-v0990">Upgrading to v0.99.0</a></h1>
  1427. <p>Please be aware that, before Synapse v1.0 is released around March 2019,
  1428. you will need to replace any self-signed certificates with those
  1429. verified by a root CA. Information on how to do so can be found at the
  1430. ACME docs.</p>
  1431. <h1 id="upgrading-to-v0340"><a class="header" href="#upgrading-to-v0340">Upgrading to v0.34.0</a></h1>
  1432. <ol>
  1433. <li>
  1434. <p>This release is the first to fully support Python 3. Synapse will
  1435. now run on Python versions 3.5, or 3.6 (as well as 2.7). We
  1436. recommend switching to Python 3, as it has been shown to give
  1437. performance improvements.</p>
  1438. <p>For users who have installed Synapse into a virtualenv, we recommend
  1439. doing this by creating a new virtualenv. For example:</p>
  1440. <pre><code class="language-sh">virtualenv -p python3 ~/synapse/env3
  1441. source ~/synapse/env3/bin/activate
  1442. pip install matrix-synapse
  1443. </code></pre>
  1444. <p>You can then start synapse as normal, having activated the new
  1445. virtualenv:</p>
  1446. <pre><code class="language-sh">cd ~/synapse
  1447. source env3/bin/activate
  1448. synctl start
  1449. </code></pre>
  1450. <p>Users who have installed from distribution packages should see the
  1451. relevant package documentation. See below for notes on Debian
  1452. packages.</p>
  1453. <ul>
  1454. <li>
  1455. <p>When upgrading to Python 3, you <strong>must</strong> make sure that your log
  1456. files are configured as UTF-8, by adding <code>encoding: utf8</code> to the
  1457. <code>RotatingFileHandler</code> configuration (if you have one) in your
  1458. <code>&lt;server&gt;.log.config</code> file. For example, if your <code>log.config</code>
  1459. file contains:</p>
  1460. <pre><code class="language-yaml">handlers:
  1461. file:
  1462. class: logging.handlers.RotatingFileHandler
  1463. formatter: precise
  1464. filename: homeserver.log
  1465. maxBytes: 104857600
  1466. backupCount: 10
  1467. filters: [context]
  1468. console:
  1469. class: logging.StreamHandler
  1470. formatter: precise
  1471. filters: [context]
  1472. </code></pre>
  1473. <p>Then you should update this to be:</p>
  1474. <pre><code class="language-yaml">handlers:
  1475. file:
  1476. class: logging.handlers.RotatingFileHandler
  1477. formatter: precise
  1478. filename: homeserver.log
  1479. maxBytes: 104857600
  1480. backupCount: 10
  1481. filters: [context]
  1482. encoding: utf8
  1483. console:
  1484. class: logging.StreamHandler
  1485. formatter: precise
  1486. filters: [context]
  1487. </code></pre>
  1488. <p>There is no need to revert this change if downgrading to
  1489. Python 2.</p>
  1490. </li>
  1491. </ul>
  1492. <p>We are also making available Debian packages which will run Synapse
  1493. on Python 3. You can switch to these packages with
  1494. <code>apt-get install matrix-synapse-py3</code>, however, please read
  1495. <a href="https://github.com/matrix-org/synapse/blob/release-v0.34.0/debian/NEWS">debian/NEWS</a>
  1496. before doing so. The existing <code>matrix-synapse</code> packages will
  1497. continue to use Python 2 for the time being.</p>
  1498. </li>
  1499. <li>
  1500. <p>This release removes the <code>riot.im</code> from the default list of trusted
  1501. identity servers.</p>
  1502. <p>If <code>riot.im</code> is in your homeserver's list of
  1503. <code>trusted_third_party_id_servers</code>, you should remove it. It was added
  1504. in case a hypothetical future identity server was put there. If you
  1505. don't remove it, users may be unable to deactivate their accounts.</p>
  1506. </li>
  1507. <li>
  1508. <p>This release no longer installs the (unmaintained) Matrix Console
  1509. web client as part of the default installation. It is possible to
  1510. re-enable it by installing it separately and setting the
  1511. <code>web_client_location</code> config option, but please consider switching
  1512. to another client.</p>
  1513. </li>
  1514. </ol>
  1515. <h1 id="upgrading-to-v0337"><a class="header" href="#upgrading-to-v0337">Upgrading to v0.33.7</a></h1>
  1516. <p>This release removes the example email notification templates from
  1517. <code>res/templates</code> (they are now internal to the python package). This
  1518. should only affect you if you (a) deploy your Synapse instance from a
  1519. git checkout or a github snapshot URL, and (b) have email notifications
  1520. enabled.</p>
  1521. <p>If you have email notifications enabled, you should ensure that
  1522. <code>email.template_dir</code> is either configured to point at a directory where
  1523. you have installed customised templates, or leave it unset to use the
  1524. default templates.</p>
  1525. <h1 id="upgrading-to-v0273"><a class="header" href="#upgrading-to-v0273">Upgrading to v0.27.3</a></h1>
  1526. <p>This release expands the anonymous usage stats sent if the opt-in
  1527. <code>report_stats</code> configuration is set to <code>true</code>. We now capture RSS memory
  1528. and cpu use at a very coarse level. This requires administrators to
  1529. install the optional <code>psutil</code> python module.</p>
  1530. <p>We would appreciate it if you could assist by ensuring this module is
  1531. available and <code>report_stats</code> is enabled. This will let us see if
  1532. performance changes to synapse are having an impact to the general
  1533. community.</p>
  1534. <h1 id="upgrading-to-v0150"><a class="header" href="#upgrading-to-v0150">Upgrading to v0.15.0</a></h1>
  1535. <p>If you want to use the new URL previewing API
  1536. (<code>/_matrix/media/r0/preview_url</code>) then you have to explicitly enable it
  1537. in the config and update your dependencies dependencies. See README.rst
  1538. for details.</p>
  1539. <h1 id="upgrading-to-v0110"><a class="header" href="#upgrading-to-v0110">Upgrading to v0.11.0</a></h1>
  1540. <p>This release includes the option to send anonymous usage stats to
  1541. matrix.org, and requires that administrators explictly opt in or out by
  1542. setting the <code>report_stats</code> option to either <code>true</code> or <code>false</code>.</p>
  1543. <p>We would really appreciate it if you could help our project out by
  1544. reporting anonymized usage statistics from your homeserver. Only very
  1545. basic aggregate data (e.g. number of users) will be reported, but it
  1546. helps us to track the growth of the Matrix community, and helps us to
  1547. make Matrix a success, as well as to convince other networks that they
  1548. should peer with us.</p>
  1549. <h1 id="upgrading-to-v090"><a class="header" href="#upgrading-to-v090">Upgrading to v0.9.0</a></h1>
  1550. <p>Application services have had a breaking API change in this version.</p>
  1551. <p>They can no longer register themselves with a home server using the AS
  1552. HTTP API. This decision was made because a compromised application
  1553. service with free reign to register any regex in effect grants full
  1554. read/write access to the home server if a regex of <code>.*</code> is used. An
  1555. attack where a compromised AS re-registers itself with <code>.*</code> was deemed
  1556. too big of a security risk to ignore, and so the ability to register
  1557. with the HS remotely has been removed.</p>
  1558. <p>It has been replaced by specifying a list of application service
  1559. registrations in <code>homeserver.yaml</code>:</p>
  1560. <pre><code class="language-yaml">app_service_config_files: [&quot;registration-01.yaml&quot;, &quot;registration-02.yaml&quot;]
  1561. </code></pre>
  1562. <p>Where <code>registration-01.yaml</code> looks like:</p>
  1563. <pre><code class="language-yaml">url: &lt;String&gt; # e.g. &quot;https://my.application.service.com&quot;
  1564. as_token: &lt;String&gt;
  1565. hs_token: &lt;String&gt;
  1566. sender_localpart: &lt;String&gt; # This is a new field which denotes the user_id localpart when using the AS token
  1567. namespaces:
  1568. users:
  1569. - exclusive: &lt;Boolean&gt;
  1570. regex: &lt;String&gt; # e.g. &quot;@prefix_.*&quot;
  1571. aliases:
  1572. - exclusive: &lt;Boolean&gt;
  1573. regex: &lt;String&gt;
  1574. rooms:
  1575. - exclusive: &lt;Boolean&gt;
  1576. regex: &lt;String&gt;
  1577. </code></pre>
  1578. <h1 id="upgrading-to-v080"><a class="header" href="#upgrading-to-v080">Upgrading to v0.8.0</a></h1>
  1579. <p>Servers which use captchas will need to add their public key to:</p>
  1580. <pre><code>static/client/register/register_config.js
  1581. window.matrixRegistrationConfig = {
  1582. recaptcha_public_key: &quot;YOUR_PUBLIC_KEY&quot;
  1583. };
  1584. </code></pre>
  1585. <p>This is required in order to support registration fallback (typically
  1586. used on mobile devices).</p>
  1587. <h1 id="upgrading-to-v070"><a class="header" href="#upgrading-to-v070">Upgrading to v0.7.0</a></h1>
  1588. <p>New dependencies are:</p>
  1589. <ul>
  1590. <li>pydenticon</li>
  1591. <li>simplejson</li>
  1592. <li>syutil</li>
  1593. <li>matrix-angular-sdk</li>
  1594. </ul>
  1595. <p>To pull in these dependencies in a virtual env, run:</p>
  1596. <pre><code>python synapse/python_dependencies.py | xargs -n 1 pip install
  1597. </code></pre>
  1598. <h1 id="upgrading-to-v060"><a class="header" href="#upgrading-to-v060">Upgrading to v0.6.0</a></h1>
  1599. <p>To pull in new dependencies, run:</p>
  1600. <pre><code>python setup.py develop --user
  1601. </code></pre>
  1602. <p>This update includes a change to the database schema. To upgrade you
  1603. first need to upgrade the database by running:</p>
  1604. <pre><code>python scripts/upgrade_db_to_v0.6.0.py &lt;db&gt; &lt;server_name&gt; &lt;signing_key&gt;
  1605. </code></pre>
  1606. <p>Where <code>&lt;db&gt;</code> is the location of the database,
  1607. <code>&lt;server_name&gt;</code> is the server name as specified in the
  1608. synapse configuration, and <code>&lt;signing_key&gt;</code> is the location
  1609. of the signing key as specified in the synapse configuration.</p>
  1610. <p>This may take some time to complete. Failures of signatures and content
  1611. hashes can safely be ignored.</p>
  1612. <h1 id="upgrading-to-v051"><a class="header" href="#upgrading-to-v051">Upgrading to v0.5.1</a></h1>
  1613. <p>Depending on precisely when you installed v0.5.0 you may have ended up
  1614. with a stale release of the reference matrix webclient installed as a
  1615. python module. To uninstall it and ensure you are depending on the
  1616. latest module, please run:</p>
  1617. <pre><code>$ pip uninstall syweb
  1618. </code></pre>
  1619. <h1 id="upgrading-to-v050"><a class="header" href="#upgrading-to-v050">Upgrading to v0.5.0</a></h1>
  1620. <p>The webclient has been split out into a seperate repository/pacakage in
  1621. this release. Before you restart your homeserver you will need to pull
  1622. in the webclient package by running:</p>
  1623. <pre><code>python setup.py develop --user
  1624. </code></pre>
  1625. <p>This release completely changes the database schema and so requires
  1626. upgrading it before starting the new version of the homeserver.</p>
  1627. <p>The script &quot;database-prepare-for-0.5.0.sh&quot; should be used to upgrade
  1628. the database. This will save all user information, such as logins and
  1629. profiles, but will otherwise purge the database. This includes messages,
  1630. which rooms the home server was a member of and room alias mappings.</p>
  1631. <p>If you would like to keep your history, please take a copy of your
  1632. database file and ask for help in #matrix:matrix.org. The upgrade
  1633. process is, unfortunately, non trivial and requires human intervention
  1634. to resolve any resulting conflicts during the upgrade process.</p>
  1635. <p>Before running the command the homeserver should be first completely
  1636. shutdown. To run it, simply specify the location of the database, e.g.:</p>
  1637. <blockquote>
  1638. <p>./scripts/database-prepare-for-0.5.0.sh &quot;homeserver.db&quot;</p>
  1639. </blockquote>
  1640. <p>Once this has successfully completed it will be safe to restart the
  1641. homeserver. You may notice that the homeserver takes a few seconds
  1642. longer to restart than usual as it reinitializes the database.</p>
  1643. <p>On startup of the new version, users can either rejoin remote rooms
  1644. using room aliases or by being reinvited. Alternatively, if any other
  1645. homeserver sends a message to a room that the homeserver was previously
  1646. in the local HS will automatically rejoin the room.</p>
  1647. <h1 id="upgrading-to-v040"><a class="header" href="#upgrading-to-v040">Upgrading to v0.4.0</a></h1>
  1648. <p>This release needs an updated syutil version. Run:</p>
  1649. <pre><code>python setup.py develop
  1650. </code></pre>
  1651. <p>You will also need to upgrade your configuration as the signing key
  1652. format has changed. Run:</p>
  1653. <pre><code>python -m synapse.app.homeserver --config-path &lt;CONFIG&gt; --generate-config
  1654. </code></pre>
  1655. <h1 id="upgrading-to-v030"><a class="header" href="#upgrading-to-v030">Upgrading to v0.3.0</a></h1>
  1656. <p>This registration API now closely matches the login API. This introduces
  1657. a bit more backwards and forwards between the HS and the client, but
  1658. this improves the overall flexibility of the API. You can now GET on
  1659. /register to retrieve a list of valid registration flows. Upon choosing
  1660. one, they are submitted in the same way as login, e.g:</p>
  1661. <pre><code>{
  1662. type: m.login.password,
  1663. user: foo,
  1664. password: bar
  1665. }
  1666. </code></pre>
  1667. <p>The default HS supports 2 flows, with and without Identity Server email
  1668. authentication. Enabling captcha on the HS will add in an extra step to
  1669. all flows: <code>m.login.recaptcha</code> which must be completed before you can
  1670. transition to the next stage. There is a new login type:
  1671. <code>m.login.email.identity</code> which contains the <code>threepidCreds</code> key which
  1672. were previously sent in the original register request. For more
  1673. information on this, see the specification.</p>
  1674. <h2 id="web-client"><a class="header" href="#web-client">Web Client</a></h2>
  1675. <p>The VoIP specification has changed between v0.2.0 and v0.3.0. Users
  1676. should refresh any browser tabs to get the latest web client code. Users
  1677. on v0.2.0 of the web client will not be able to call those on v0.3.0 and
  1678. vice versa.</p>
  1679. <h1 id="upgrading-to-v020"><a class="header" href="#upgrading-to-v020">Upgrading to v0.2.0</a></h1>
  1680. <p>The home server now requires setting up of SSL config before it can run.
  1681. To automatically generate default config use:</p>
  1682. <pre><code>$ python synapse/app/homeserver.py \
  1683. --server-name machine.my.domain.name \
  1684. --bind-port 8448 \
  1685. --config-path homeserver.config \
  1686. --generate-config
  1687. </code></pre>
  1688. <p>This config can be edited if desired, for example to specify a different
  1689. SSL certificate to use. Once done you can run the home server using:</p>
  1690. <pre><code>$ python synapse/app/homeserver.py --config-path homeserver.config
  1691. </code></pre>
  1692. <p>See the README.rst for more information.</p>
  1693. <p>Also note that some config options have been renamed, including:</p>
  1694. <ul>
  1695. <li>&quot;host&quot; to &quot;server-name&quot;</li>
  1696. <li>&quot;database&quot; to &quot;database-path&quot;</li>
  1697. <li>&quot;port&quot; to &quot;bind-port&quot; and &quot;unsecure-port&quot;</li>
  1698. </ul>
  1699. <h1 id="upgrading-to-v001"><a class="header" href="#upgrading-to-v001">Upgrading to v0.0.1</a></h1>
  1700. <p>This release completely changes the database schema and so requires
  1701. upgrading it before starting the new version of the homeserver.</p>
  1702. <p>The script &quot;database-prepare-for-0.0.1.sh&quot; should be used to upgrade
  1703. the database. This will save all user information, such as logins and
  1704. profiles, but will otherwise purge the database. This includes messages,
  1705. which rooms the home server was a member of and room alias mappings.</p>
  1706. <p>Before running the command the homeserver should be first completely
  1707. shutdown. To run it, simply specify the location of the database, e.g.:</p>
  1708. <blockquote>
  1709. <p>./scripts/database-prepare-for-0.0.1.sh &quot;homeserver.db&quot;</p>
  1710. </blockquote>
  1711. <p>Once this has successfully completed it will be safe to restart the
  1712. homeserver. You may notice that the homeserver takes a few seconds
  1713. longer to restart than usual as it reinitializes the database.</p>
  1714. <p>On startup of the new version, users can either rejoin remote rooms
  1715. using room aliases or by being reinvited. Alternatively, if any other
  1716. homeserver sends a message to a room that the homeserver was previously
  1717. in the local HS will automatically rejoin the room.</p>
  1718. </main>
  1719. <nav class="nav-wrapper" aria-label="Page navigation">
  1720. <!-- Mobile navigation buttons -->
  1721. <a rel="prev" href="delegate.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
  1722. <i class="fa fa-angle-left"></i>
  1723. </a>
  1724. <a rel="next" href="federate.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
  1725. <i class="fa fa-angle-right"></i>
  1726. </a>
  1727. <div style="clear: both"></div>
  1728. </nav>
  1729. </div>
  1730. </div>
  1731. <nav class="nav-wide-wrapper" aria-label="Page navigation">
  1732. <a rel="prev" href="delegate.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
  1733. <i class="fa fa-angle-left"></i>
  1734. </a>
  1735. <a rel="next" href="federate.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
  1736. <i class="fa fa-angle-right"></i>
  1737. </a>
  1738. </nav>
  1739. </div>
  1740. <script type="text/javascript">
  1741. window.playground_copyable = true;
  1742. </script>
  1743. <script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
  1744. <script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
  1745. <script src="searcher.js" type="text/javascript" charset="utf-8"></script>
  1746. <script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
  1747. <script src="highlight.js" type="text/javascript" charset="utf-8"></script>
  1748. <script src="book.js" type="text/javascript" charset="utf-8"></script>
  1749. <!-- Custom JS scripts -->
  1750. <script type="text/javascript" src="docs/website_files/table-of-contents.js"></script>
  1751. <script type="text/javascript" src="docs/website_files/version-picker.js"></script>
  1752. <script type="text/javascript" src="docs/website_files/version.js"></script>
  1753. </body>
  1754. </html>