diff options
| author | David Robertson <davidr@element.io> | 2022-04-20 15:18:21 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-20 15:18:21 +0100 |
| commit | ecef741add0adfdd59f960e8b46503a5604303bd (patch) | |
| tree | da1b6498189c205c12e0948ffdb889baa0016e0b /docs/upgrade.md | |
| parent | Remove unnecessary config overrides for MSC3666. (#12511) (diff) | |
| download | synapse-ecef741add0adfdd59f960e8b46503a5604303bd.tar.xz | |
Recommend poetry in docs (#12475)
* Recommend poetry in docs - readme - contributor guide - upgrade notes - new dev cheat sheet for poetry Co-authored-by: Shay <hillerys@element.io> Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com>
Diffstat (limited to '')
| -rw-r--r-- | docs/upgrade.md | 34 |
1 files changed, 19 insertions, 15 deletions
diff --git a/docs/upgrade.md b/docs/upgrade.md index a0c797ea9f..3a8aeb0395 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -19,32 +19,36 @@ this document. packages](setup/installation.md#prebuilt-packages), you will need to follow the normal process for upgrading those packages. +- If Synapse was installed using pip then upgrade to the latest + version by running: + + ```bash + pip install --upgrade matrix-synapse + ``` + - If Synapse was installed from source, then: - 1. Activate the virtualenv before upgrading. For example, if - Synapse is installed in a virtualenv in `~/synapse/env` then + 1. Obtain the latest version of the source code. Git users can run + `git pull` to do this. + + 2. 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 `~/synapse/env` then run: ```bash source ~/synapse/env/bin/activate + pip install --upgrade . ``` + Include any relevant extras between square brackets, e.g. `pip install --upgrade ".[postgres,oidc]"`. - 2. If Synapse was installed using pip then upgrade to the latest - version by running: - - ```bash - pip install --upgrade matrix-synapse - ``` - - If Synapse was installed using git then upgrade to the latest - version by running: - + 3. If you're using `poetry` to manage a Synapse installation, run: ```bash - git pull - pip install --upgrade . + poetry install ``` + Include any relevant extras with `--extras`, e.g. `poetry install --extras postgres --extras oidc`. + It's probably easiest to run `poetry install --extras all`. - 3. Restart Synapse: + 4. Restart Synapse: ```bash synctl restart |