Skip to content

Commit c05bf68

Browse files
committed
docs(install): document how to install gpg 2.0
Add link in install doc to upgrading doc and document pip command there.
1 parent 7bed77a commit c05bf68

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

doc/installation.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,11 @@ gpg
248248
If gpg_ is installed you can configure the mail gateway to perform
249249
verification or decryption of incoming OpenPGP MIME messages. When
250250
configured, you can require email to be cryptographically signed
251-
before roundup will allow it to make modifications to issues.
251+
before roundup will allow it to make modifications to issues. (Note
252+
with python 3.13 or newer on some platforms, you may need to install
253+
version 2.0 of gpg from test.pypi.org. See the `gpg install
254+
directions in the upgrading document`_.
255+
252256

253257
jinja2
254258
To use the jinja2 template (may still be experimental, check out
@@ -318,6 +322,9 @@ requests
318322
.. _Using Redis for Session Databases:
319323
admin_guide.html#using-redis-for-session-databases
320324

325+
.. _gpg install directions in the upgrading document:
326+
upgrading.html#directions-for-installing-gpg
327+
321328
Installing Roundup
322329
==================
323330

doc/upgrading.txt

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -441,6 +441,23 @@ the database (client.db), form (client.form).
441441

442442
You can find an example in :ref:`dynamic_csp`.
443443

444+
Directions for installing gpg
445+
-----------------------------
446+
447+
In this release a new version of the gpg module was needed for Ubuntu
448+
24.04 and python 3.13. Paul Schwabauer produced a new version of the
449+
gpg module. However it is only on the test instance of pypi. If you
450+
run into issues installing gpg with pip, you can use::
451+
452+
pip install --index-url https://test.pypi.org/simple/ \
453+
--extra-index-url https://pypi.org/simple gpg;
454+
455+
to installed version 2.0 of gpg from test.pypi.org obtaining it's
456+
requirements from pypi.org.
457+
458+
When `issue2551368 <https://issues.roundup-tracker.org/issue2551368>`_
459+
is closed, you should be able to use ``pip install gpg`` again.
460+
444461
.. index:: Upgrading; 2.3.0 to 2.4.0
445462

446463
Migrating from 2.3.0 to 2.4.0

0 commit comments

Comments
 (0)