From 29074c22991aa358774b94bf156dac1f776300fd Mon Sep 17 00:00:00 2001 From: Matthias Dellweg Date: Tue, 22 Nov 2022 14:49:39 +0100 Subject: [PATCH] Document settings fixes #571 Co-authored-by: Gerrod --- CHANGES/571.doc | 1 + docs/index.rst | 1 + docs/settings.rst | 20 ++++++++++++++++++++ 3 files changed, 22 insertions(+) create mode 100644 CHANGES/571.doc create mode 100644 docs/settings.rst diff --git a/CHANGES/571.doc b/CHANGES/571.doc new file mode 100644 index 000000000..8d7507142 --- /dev/null +++ b/CHANGES/571.doc @@ -0,0 +1 @@ +Documented ``pulp_python`` specific settings. diff --git a/docs/index.rst b/docs/index.rst index a52d5c208..5f018566b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -51,6 +51,7 @@ Table of Contents :maxdepth: 1 installation + settings workflows/index changes contributing diff --git a/docs/settings.rst b/docs/settings.rst new file mode 100644 index 000000000..6d3cc15b9 --- /dev/null +++ b/docs/settings.rst @@ -0,0 +1,20 @@ +.. _settings: + +Settings +======== + +``pulp_python`` adds configuration options to those offered by ``pulpcore``. + +PYTHON_GROUP_UPLOADS +^^^^^^^^^^^^^^^^^^^^ + + This setting controls whether the uploading of packages through the PyPI APIs can be grouped + inside http sessions. When enabled, Pulp tries to group the uploaded distributions of a package + into one task generating one repository version. Defaults to False. + +PYPI_API_HOSTNAME +^^^^^^^^^^^^^^^^^ + + This specifies the hostname where the PyPI API is served. It defaults to the fully qualified + hostname of the system where the process is running. This needs to be adjusted if running behind + a non local reverse proxy.