Skip to content

Commit

Permalink
[ci skip] Autodoc commit for 87cff26.
Browse files Browse the repository at this point in the history
  • Loading branch information
oscwiag committed Jul 17, 2024
1 parent 6bb3f84 commit 554667a
Show file tree
Hide file tree
Showing 9 changed files with 103 additions and 43 deletions.
31 changes: 31 additions & 0 deletions develop/_sources/customizations.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,37 @@ Customizations
Check out the :ref:`pun-environment` for an overview of how environment variables can be
added.

.. _disabling_applications:

Disabling applications
----------------------

OnDemand is comprised of a few components. Each of which you can disable or limit
access by simply changing the file permissions of the application.

All the applications OnDemand installs are located in `/var/www/ood/apps/sys`.
So, for example, if you wished to disable the file browser you would simply
change it's directory to 700 so it's unreadable by regular users.

When this directory is unreadable by regular users, the functionality
it provides will be disabeled.

.. code-block:: sh
sudo chmod 700 /var/www/ood/apps/sys/files
Alternatively, if you wished to limit acess you can do so through group
permissions. For example, if you wanted to limit access to the file browser
to only memebers in the Unix group ``staff``, you would simply apply the
applicable file permission such that anonymous users cannot access the
directory while members of the ``staff`` Unix group can.

.. code-block:: sh
sudo chmod 750 /var/www/ood/apps/sys/files
sudo chown root:staff /var/www/ood/apps/sys/files
Announcements
-------------

Expand Down
3 changes: 2 additions & 1 deletion develop/_sources/security.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ that some centers may want to change or disable altogether.
- **File Access**: OnDemand lets users navigate the file system. While file permissions
limit what a user can view and navigate to, some centers may want to limit this even further.
One option is to :ref:`set-file-allowlist` to limit what directories users may navigate to.

Additionally, you may want to disable or limit access to the application. You can do this
through :ref:`disabling_applications`.

Conclusion
----------
Expand Down
100 changes: 62 additions & 38 deletions develop/customizations.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions develop/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,7 @@ <h2>Special Thanks<a class="headerlink" href="#special-thanks" title="Permalink
<p class="caption"><span class="caption-text">How-Tos</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="customizations.html">Customizations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="customizations.html#disabling-applications">Disabling applications</a></li>
<li class="toctree-l2"><a class="reference internal" href="customizations.html#announcements">Announcements</a></li>
<li class="toctree-l2"><a class="reference internal" href="customizations.html#message-of-the-day-motd">Message of the Day (MOTD)</a></li>
<li class="toctree-l2"><a class="reference internal" href="customizations.html#branding">Branding</a></li>
Expand Down
Binary file modified develop/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion develop/release-notes/v1.7-release-notes.html
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ <h3>Job Composer and Active Jobs match Dashboard Branding<a class="headerlink" h
<p>The Job Composer and Active Jobs apps’ top navigation bar now share the same branding
scheme configured for the dashboard.</p>
<p>There’s no additional configuration required for this other than what’s documented
<a class="reference internal" href="../customizations.html#id2"><span class="std std-ref">here</span></a>.</p>
<a class="reference internal" href="../customizations.html#id3"><span class="std std-ref">here</span></a>.</p>
<p>Special thanks to <a class="reference external" href="https://github.com/zooley">&#64;zooley</a> (Shawn Rice) for implementing this feature!</p>
</div>
<div class="section" id="maintenance-mode">
Expand Down
2 changes: 1 addition & 1 deletion develop/release-notes/v1.8-release-notes.html
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,7 @@ <h3>Ability to add additional info to batch connect app<a class="headerlink" hre
<div class="section" id="support-for-svg-dashboard-logos">
<h3>Support for SVG dashboard logos<a class="headerlink" href="#support-for-svg-dashboard-logos" title="Permalink to this headline"></a></h3>
<p>Logos can now be SVG images and controlled through the <code class="docutils literal notranslate"><span class="pre">OOD_DASHBOARD_LOGO_HEIGHT</span></code>
configuration to resize them. <a class="reference internal" href="../customizations.html#id2"><span class="std std-ref">See documentation on branding for form information.</span></a></p>
configuration to resize them. <a class="reference internal" href="../customizations.html#id3"><span class="std std-ref">See documentation on branding for form information.</span></a></p>
</div>
<div class="section" id="support-for-new-native-vnc-views">
<h3>Support for new Native VNC views<a class="headerlink" href="#support-for-new-native-vnc-views" 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.

5 changes: 4 additions & 1 deletion develop/security.html
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,9 @@ <h3>Controls<a class="headerlink" href="#controls" title="Permalink to this head
<ul class="simple">
<li><p><strong>File Access</strong>: OnDemand lets users navigate the file system. While file permissions
limit what a user can view and navigate to, some centers may want to limit this even further.
One option is to <a class="reference internal" href="customizations.html#set-file-allowlist"><span class="std std-ref">Block or Allow Directory Access</span></a> to limit what directories users may navigate to.</p></li>
One option is to <a class="reference internal" href="customizations.html#set-file-allowlist"><span class="std std-ref">Block or Allow Directory Access</span></a> to limit what directories users may navigate to.
Additionally, you may want to disable or limit access to the application. You can do this
through <a class="reference internal" href="customizations.html#disabling-applications"><span class="std std-ref">Disabling applications</span></a>.</p></li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -280,6 +282,7 @@ <h2>Relevant References<a class="headerlink" href="#relevant-references" title="
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="customizations.html">Customizations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="customizations.html#disabling-applications">Disabling applications</a></li>
<li class="toctree-l2"><a class="reference internal" href="customizations.html#announcements">Announcements</a></li>
<li class="toctree-l2"><a class="reference internal" href="customizations.html#message-of-the-day-motd">Message of the Day (MOTD)</a></li>
<li class="toctree-l2"><a class="reference internal" href="customizations.html#branding">Branding</a></li>
Expand Down

0 comments on commit 554667a

Please sign in to comment.