Skip to content

Commit d054fbb

Browse files
missytakej-g00da
andauthored
docs: document how to upgrade to new version (#965)
Co-authored-by: Jagoda Estera Ślązak <128227338+j-g00da@users.noreply.github.com>
1 parent def08c5 commit d054fbb

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

doc/source/faq.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,28 @@ Dovecot, and are configured to run unattended without much maintenance
4848
effort. Chatmail relays happily run on low-end hardware like a Raspberry
4949
Pi.
5050

51+
.. _upgrade:
52+
53+
How can I upgrade my chatmail relay?
54+
------------------------------------
55+
56+
To upgrade to the latest ``main`` branch,
57+
``cd`` into your local checkout of `https://github.com/chatmail/relay/`_
58+
and run the following commands:
59+
60+
::
61+
62+
git pull origin main --rebase --autostash
63+
scripts/cmdeploy run
64+
65+
If you don't want the latest development version,
66+
but a specific tagged release like `1.10.0 <https://github.com/chatmail/relay/releases/tag/1.10.0>`_,
67+
run ``git pull origin 1.10.0`` instead.
68+
69+
If you made local changes for your setup,
70+
they will be reapplied as long as they don't conflict with the upgrade.
71+
If a conflict arises, ``git status`` will tell you how to resolve it.
72+
5173

5274
How trustable are chatmail relays?
5375
----------------------------------

0 commit comments

Comments
 (0)