diff options
| author | DMRobertson <DMRobertson@users.noreply.github.com> | 2022-04-20 14:18:55 +0000 |
|---|---|---|
| committer | DMRobertson <DMRobertson@users.noreply.github.com> | 2022-04-20 14:18:55 +0000 |
| commit | 570ffadd0a5d3743700664132fa87cac84738ca3 (patch) | |
| tree | 3869a7a8a8b80c16355f3cbb42029fafb87ae1b6 /develop/upgrade.html | |
| parent | deploy: 0921d93dcdd64101cc2433892f7a8cd1caf2b1f5 (diff) | |
| download | synapse-570ffadd0a5d3743700664132fa87cac84738ca3.tar.xz | |
deploy: ecef741add0adfdd59f960e8b46503a5604303bd
Diffstat (limited to 'develop/upgrade.html')
| -rw-r--r-- | develop/upgrade.html | 28 |
1 files changed, 18 insertions, 10 deletions
diff --git a/develop/upgrade.html b/develop/upgrade.html index 8e807862f5..dcb62658f7 100644 --- a/develop/upgrade.html +++ b/develop/upgrade.html @@ -167,25 +167,33 @@ packages</a>, you will need to follow the normal process for upgrading those packages.</p> </li> <li> +<p>If Synapse was installed using pip then upgrade to the latest +version by running:</p> +<pre><code class="language-bash">pip install --upgrade matrix-synapse +</code></pre> +</li> +<li> <p>If Synapse was installed from source, then:</p> <ol> <li> -<p>Activate the virtualenv before upgrading. For example, if -Synapse is installed in a virtualenv in <code>~/synapse/env</code> then +<p>Obtain the latest version of the source code. Git users can run +<code>git pull</code> to do this.</p> +</li> +<li> +<p>If you're running Synapse in a virtualenv, make sure to activate it before +upgrading. For example, if Synapse is installed in a virtualenv in <code>~/synapse/env</code> then run:</p> <pre><code class="language-bash">source ~/synapse/env/bin/activate +pip install --upgrade . </code></pre> +<p>Include any relevant extras between square brackets, e.g. <code>pip install --upgrade ".[postgres,oidc]"</code>.</p> </li> <li> -<p>If Synapse was installed using pip then upgrade to the latest -version by running:</p> -<pre><code class="language-bash">pip install --upgrade matrix-synapse -</code></pre> -<p>If Synapse was installed using git then upgrade to the latest -version by running:</p> -<pre><code class="language-bash">git pull -pip install --upgrade . +<p>If you're using <code>poetry</code> to manage a Synapse installation, run:</p> +<pre><code class="language-bash">poetry install </code></pre> +<p>Include any relevant extras with <code>--extras</code>, e.g. <code>poetry install --extras postgres --extras oidc</code>. +It's probably easiest to run <code>poetry install --extras all</code>.</p> </li> <li> <p>Restart Synapse:</p> |