From c5c3e38e976a8c7ceb13220141b73723f6fac123 Mon Sep 17 00:00:00 2001 From: Benjamin Bertrand Date: Sat, 9 Dec 2023 21:43:40 +0100 Subject: [PATCH] Add some documentation about compression --- docs/source/deploying/configuration.rst | 15 +++++++++++++++ quetz/config.py | 2 +- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/source/deploying/configuration.rst b/docs/source/deploying/configuration.rst index 97672de5..995cc1d0 100644 --- a/docs/source/deploying/configuration.rst +++ b/docs/source/deploying/configuration.rst @@ -243,6 +243,21 @@ the ``redis-server``. For more information, see :ref:`task_workers`. +``compression`` section +^^^^^^^^^^^^^^^^^^^^^^^ + +You can configure which compressions are enabled for the ``repodata.json`` file. + +:gz_enabled: enable gzip compression +:bz2_enabled: enable bzip2 compression +:zst_enabled: enable zstandard compression + +.. note:: + + Compression is an expensive operation for big files. + Updating local channels index is done in the background, so this isnt' an issue. + But for proxy channels, compression is done after downloading the remote ``repodata.json`` and before to serve it. + ``quotas`` section ^^^^^^^^^^^^^^^^^^ diff --git a/quetz/config.py b/quetz/config.py index 9d529a45..13156979 100644 --- a/quetz/config.py +++ b/quetz/config.py @@ -469,7 +469,7 @@ def get_compression_config(self) -> CompressionConfig: Returns ------- compression_config : CompressionConfig - The compression configuration + Class defining which compressions are enabled (bzip2, gzip and zstandard) """ return CompressionConfig( self.compression_bz2_enabled,