add docs on default noVNC settings (#1020)

OSC · Nov 21, 2024 · fdaa4f3 · fdaa4f3
1 parent 30686b1
commit fdaa4f3
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 0 deletions.
diff --git a/source/reference/files/ondemand-d-ymls.rst b/source/reference/files/ondemand-d-ymls.rst
@@ -929,3 +929,43 @@ Configuration Properties
     .. code-block:: yaml
 
       motd_render_html: true
+
+.. _novnc_default_compression:
+.. describe:: novnc_default_compression (Integer, 6)
+
+  The default compression value for noVNC batch connect
+  applications.
+
+  Default
+    The default compression of 6.
+
+    .. code-block:: yaml
+
+      novnc_default_compression: 6
+
+  Example
+    Increase the default compression to 9.
+
+    .. code-block:: yaml
+
+      novnc_default_compression: 9
+
+.. _novnc_default_quality:
+.. describe:: novnc_default_quality (Integer, 2)
+
+  The default quality value for noVNC batch connect
+  applications.
+
+  Default
+    The default quality of 2.
+
+    .. code-block:: yaml
+
+      novnc_default_quality: 2
+
+  Example
+    Increas the default quality setting to 9.
+
+    .. code-block:: yaml
+
+      novnc_default_quality: 9
diff --git a/source/release-notes/v4.0-release-notes.rst b/source/release-notes/v4.0-release-notes.rst
@@ -12,6 +12,7 @@ New Features
 ------------
 
 - `Global Batch Connect items`_
+- `noVNC quality and compression defaults`_
 
 Thanks!
 -------
@@ -103,3 +104,11 @@ in ondemand.d files to be used in any batch connect
 application.
 
 See :ref:`global_bc_form_items` for more details.
+
+noVNC quality and compression defaults
+......................................
+
+Sites can now set the default compression and quality values
+for noVNC batch connect applications through the two ``ondemand.d``
+properties :ref:`novnc_default_compression <novnc_default_compression>`
+and :ref:`novnc_default_quality <novnc_default_quality>`.