Skip to content

Commit

Permalink
More release notes work (#925)
Browse files Browse the repository at this point in the history
* fix globus example

* add custom directives to release notes
  • Loading branch information
johrstrom authored Jan 23, 2024
1 parent 87f1fe9 commit b240416
Show file tree
Hide file tree
Showing 3 changed files with 83 additions and 2 deletions.
7 changes: 5 additions & 2 deletions source/reference/files/ondemand-d-ymls.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down
64 changes: 64 additions & 0 deletions source/reference/files/ood-portal-yml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ Configure General Options
ssl: null
Example
Supply ssl information.

.. code-block:: yaml
Expand All @@ -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
Expand Down Expand Up @@ -475,6 +497,48 @@ Configure General Options
- "AuthType openid-connect"
- "Require valid-user"
.. _custom_vhost_directives:
.. describe:: custom_vhost_directives (Array<String>, [])

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<String>, [])

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
Expand Down
14 changes: 14 additions & 0 deletions source/release-notes/v3.1-release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`_
Expand Down Expand Up @@ -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 <disable_logs>` 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 <custom_location_directives>`
and :ref:`custom virtual host directives <custom_vhost_directives>`.

aarch64/arm64 and ppc64le packages
..................................

Expand Down

0 comments on commit b240416

Please sign in to comment.