From f9ffdba9249014d5f08186d2d5be8cb2fd0677f5 Mon Sep 17 00:00:00 2001 From: Jeff Ohrstrom Date: Fri, 19 Jan 2024 14:35:19 -0500 Subject: [PATCH 1/2] fix globus example --- source/reference/files/ondemand-d-ymls.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/source/reference/files/ondemand-d-ymls.rst b/source/reference/files/ondemand-d-ymls.rst index e19849d3..71b0a54f 100644 --- a/source/reference/files/ondemand-d-ymls.rst +++ b/source/reference/files/ondemand-d-ymls.rst @@ -820,6 +820,9 @@ Configuration Properties Add a Globus button to the file browser that opens the current directory in the Globus transfer web app. + Note that ``endpoint_path`` is the path that Globus will initialize to + and is very likely to be ``/`` regardless of the actual storage path. + Default Null, do not enable the Globus button @@ -829,9 +832,9 @@ Configuration Properties .. code-block:: yaml globus_endpoints: - - path "/" + - path: "/" endpoint: "716de4ac-xxxx-xxxx-xxxx-xxxxxxxxxxxx" - endpoint_path "/" + endpoint_path: "/" Example Use multiple endpoints. From aa531d0a97993387c9baa28d7673694adc452f22 Mon Sep 17 00:00:00 2001 From: Jeff Ohrstrom Date: Fri, 19 Jan 2024 14:49:40 -0500 Subject: [PATCH 2/2] add custom directives to release notes --- source/reference/files/ood-portal-yml.rst | 64 +++++++++++++++++++++ source/release-notes/v3.1-release-notes.rst | 14 +++++ 2 files changed, 78 insertions(+) diff --git a/source/reference/files/ood-portal-yml.rst b/source/reference/files/ood-portal-yml.rst index 9c183d0f..0180a2a5 100644 --- a/source/reference/files/ood-portal-yml.rst +++ b/source/reference/files/ood-portal-yml.rst @@ -126,6 +126,7 @@ Configure General Options ssl: null Example + Supply ssl information. .. code-block:: yaml @@ -135,6 +136,27 @@ Configure General Options - SSLCertificateChainFile /etc/letsencrypt/live/change-me/chain.pem +.. _disable_logs: +.. describe:: disable_logs (Boolean, false) + + Disable logs in favor of supplying log directives in some other + configuration file. + + Default + Logs are enabled and defined in this virtual host. + + .. code-block:: yaml + + disable_logs: false + + Example + Disable logs in favor of supplying log directives in some other + configuration file. + + .. code-block:: yaml + + disable_logs: true + .. describe:: logroot (String) the root directory where log files are stored (can be relative to @@ -475,6 +497,48 @@ Configure General Options - "AuthType openid-connect" - "Require valid-user" +.. _custom_vhost_directives: +.. describe:: custom_vhost_directives (Array, []) + + Supply custom directives at the virtual host level. + + Default + No custom virtual host directives. + + .. code-block:: yaml + + custom_vhost_directives: [] + + Example + Add a single custom virutal host directive + to set an environment variable. + + .. code-block:: yaml + + custom_vhost_directives: + - SetEnv FOO BAR + +.. _custom_location_directives: +.. describe:: custom_location_directives (Array, []) + + Supply custom directives for every ``Location`` in the virtual host. + + Default + No custom location directives. + + .. code-block:: yaml + + custom_location_directives: [] + + Example + Add a single custom location directive + to set an environment variable. + + .. code-block:: yaml + + custom_location_directives: + - SetEnv FOO BAR + .. describe:: root_uri (String) the URI a user is redirected to when they access the root of the website diff --git a/source/release-notes/v3.1-release-notes.rst b/source/release-notes/v3.1-release-notes.rst index 0ad1415b..9ebf71ef 100644 --- a/source/release-notes/v3.1-release-notes.rst +++ b/source/release-notes/v3.1-release-notes.rst @@ -19,6 +19,7 @@ New Features - `Dynamic Checkboxes`_ - `Disabling uploads and downloads`_ - `Custom Javascript files`_ +- `Updated Apache options`_ - `aarch64/arm64 and ppc64le packages`_ - `Amazon Linux 2023 packages`_ - `Debian 12 packages`_ @@ -250,6 +251,19 @@ to display information on the session's card when the job has completed. See :ref:`bc_completed_html_md_erb` for more information. +Updated Apache options +...................... + +We've updated ``ood_portal.yml`` for two common apache configurations +sites may wish to enable. + +The first is to :ref:`disable apache logging ` in favor of +supplying a global log configuration in a seperate file. + +The second is to alllow for custom directives. You can now supply +:ref:`custom location directives ` +and :ref:`custom virtual host directives `. + aarch64/arm64 and ppc64le packages ..................................