Skip to content

Commit

Permalink
[ci skip] Autodoc commit for 68495e1.
Browse files Browse the repository at this point in the history
  • Loading branch information
oscwiag committed Dec 19, 2024
1 parent 9736277 commit 5d394ab
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 1 deletion.
4 changes: 4 additions & 0 deletions develop/_sources/reference/files/ondemand-d-ymls.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ These properties support profile based configuration, see the :ref:`profile conf
i.e. ``OOD_BRAND_BG_COLOR: '#0000ff'``. If you omit the quotes, YAML will see ``#`` as a comment and the value of the ``OOD_BRAND_BG_COLOR`` will be ``nil``


.. warning::
OnDemand will only respond to root owned files. Configuration files
that are not owned by the root user (uid 0) will not be read.

.. _profile_properties:

Configuration Properties with profile support
Expand Down
13 changes: 13 additions & 0 deletions develop/_sources/release-notes/v4.0-release-notes.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,19 @@ id of the form item will be lowercase as shown below.

id="batch_connect_session_context_my_cool_form_item"

Root owned configuration files
******************************

In an effort to increase the security of the Open OnDemand platform,
the system will now start to only respond to root owned configuration
files.

This will mean that all configfuration files in ``/etc/ood/config``
will need to be owned by the ``root`` user (uid 0) in order to be used.

While these files need to be root owned, they can continue to have any
group ownership.

Deprecations
............

Expand Down
5 changes: 5 additions & 0 deletions develop/reference/files/ondemand-d-ymls.html
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,11 @@
<p>When using environment variables with <code class="docutils literal notranslate"><span class="pre">nginx_stage.yml</span></code> file, be careful to set the value using quotes
i.e. <code class="docutils literal notranslate"><span class="pre">OOD_BRAND_BG_COLOR:</span> <span class="pre">'#0000ff'</span></code>. If you omit the quotes, YAML will see <code class="docutils literal notranslate"><span class="pre">#</span></code> as a comment and the value of the <code class="docutils literal notranslate"><span class="pre">OOD_BRAND_BG_COLOR</span></code> will be <code class="docutils literal notranslate"><span class="pre">nil</span></code></p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>OnDemand will only respond to root owned files. Configuration files
that are not owned by the root user (uid 0) will not be read.</p>
</div>
<div class="section" id="configuration-properties-with-profile-support">
<span id="profile-properties"></span><h2>Configuration Properties with profile support<a class="headerlink" href="#configuration-properties-with-profile-support" title="Permalink to this headline"></a></h2>
<dl class="describe">
Expand Down
10 changes: 10 additions & 0 deletions develop/release-notes/v4.0-release-notes.html
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,16 @@ <h4>Batch connect form ids are now lowercase.<a class="headerlink" href="#batch-
</pre></div>
</div>
</div>
<div class="section" id="root-owned-configuration-files">
<h4>Root owned configuration files<a class="headerlink" href="#root-owned-configuration-files" title="Permalink to this headline"></a></h4>
<p>In an effort to increase the security of the Open OnDemand platform,
the system will now start to only respond to root owned configuration
files.</p>
<p>This will mean that all configfuration files in <code class="docutils literal notranslate"><span class="pre">/etc/ood/config</span></code>
will need to be owned by the <code class="docutils literal notranslate"><span class="pre">root</span></code> user (uid 0) in order to be used.</p>
<p>While these files need to be root owned, they can continue to have any
group ownership.</p>
</div>
</div>
<div class="section" id="deprecations">
<h3>Deprecations<a class="headerlink" href="#deprecations" title="Permalink to this headline"></a></h3>
Expand Down
2 changes: 1 addition & 1 deletion develop/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 5d394ab

Please sign in to comment.