Add some documentation about compression

mamba-org · Dec 10, 2023 · c5c3e38 · c5c3e38
1 parent 381bcee
commit c5c3e38
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git 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
@@ -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,