fixup notes around enabling & disabling #1129
Conversation
|
@moffatsadeghi please advise - you opened #1072, so here's the potential fix for it. |
source/customizations.rst
Outdated
| @@ -32,6 +32,9 @@ to only members 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. | |||
|
|
|||
| Conversely, if the directory is already ``700`` just reverse the process to | |||
There was a problem hiding this comment.
I really like where you are coming from - adding more information to this second to make it clearer and adding examples. I wonder if we need to step back and analyze this section as a whole because reading through it, I get confused with some of the organization and wording.
There was a problem hiding this comment.
OK - I added a little bit above, kind of like a TLDR. LMK what you think.
There was a problem hiding this comment.
How about this?:
Disabling or Limiting Access to System Applications
Open OnDemand includes several system applications that are installed by default and located in the following directory:
/var/www/ood/apps/sys/
If you want to disable a specific application or limit who can access it, you can do so by adjusting the file permissions on that application's directory.
Disabling an Application
To completely disable an application, such as the File Browser, you can restrict read and execute permissions so that only root (or administrators) can access it. This effectively hides the application from regular users in the web interface.
Example:
sudo chmod 700 /var/www/ood/apps/sys/files
This command makes the files application (the File Browser) inaccessible to anyone who is not the root user.
Limiting Access by Group
If you prefer to limit access to a specific group of users instead of disabling the application entirely, you can do so using Unix group permissions.
Example: To allow access only to users in the staff group:
sudo chmod 750 /var/www/ood/apps/sys/files
sudo chown root:staff /var/www/ood/apps/sys/files
This ensures:
- The application is readable and executable by the staff group.
- All other users (not in staff) will not see or access it through the OnDemand interface.
There was a problem hiding this comment.
I've updated this section to have headings. Should get published to the URL below in a few minutes.
https://osc.github.io/ood-documentation-test/40-rn-updates/customizations.html
source/customizations.rst
Outdated
| @@ -32,6 +32,9 @@ to only members 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. | |||
|
|
|||
| Conversely, if the directory is already ``700`` just reverse the process to | |||
There was a problem hiding this comment.
How about this?:
Disabling or Limiting Access to System Applications
Open OnDemand includes several system applications that are installed by default and located in the following directory:
/var/www/ood/apps/sys/
If you want to disable a specific application or limit who can access it, you can do so by adjusting the file permissions on that application's directory.
Disabling an Application
To completely disable an application, such as the File Browser, you can restrict read and execute permissions so that only root (or administrators) can access it. This effectively hides the application from regular users in the web interface.
Example:
sudo chmod 700 /var/www/ood/apps/sys/files
This command makes the files application (the File Browser) inaccessible to anyone who is not the root user.
Limiting Access by Group
If you prefer to limit access to a specific group of users instead of disabling the application entirely, you can do so using Unix group permissions.
Example: To allow access only to users in the staff group:
sudo chmod 750 /var/www/ood/apps/sys/files
sudo chown root:staff /var/www/ood/apps/sys/files
This ensures:
- The application is readable and executable by the staff group.
- All other users (not in staff) will not see or access it through the OnDemand interface.
| To enable the Project Manager, simply follow the instructions in :ref:`disabling_applications` | ||
| to enable this application. | ||
| To enable the Project Manager, refer to the instructions in the | ||
| :ref:`disabling_applications` section. |
There was a problem hiding this comment.
Looks great! I guess to go above and beyond, how do you feel about these additions?
Introducing the Project Manager (Job Composer Replacement Preview)
The Open OnDemand development team is actively working on a new application designed to eventually replace the existing Job Composer. This new tool is called the Project Manager.
A preview version of the Project Manager was first included in version 3.1, and we've continued to make improvements since then. However, it's still under active development and does not yet have full feature parity with the current Job Composer. For that reason, the Project Manager remains disabled by default in this release.
That said, if you're interested in testing it—perhaps within your team or among a small group of early adopters—you can manually enable it.
How to Enable the Project Manager
The Project Manager is installed along with other system applications in:
/var/www/ood/apps/sys/project_manager
To enable it for specific users or groups, follow the same approach described in the Disabling Applications section by adjusting file permissions.
For example, to make it visible only to users in the staff group:
sudo chmod 750 /var/www/ood/apps/sys/project_manager
sudo chown root:staff /var/www/ood/apps/sys/project_manager
This gives access to members of the staff Unix group, while keeping it hidden from other users.
There was a problem hiding this comment.
Instead of having the same documentation in 2 places - I've updated the link to point directly to the enabling applications section in the customizations page.
|
Yea we could likely benefit from headings. I'll fix that up soon. |
https://osc.github.io/ood-documentation-test/40-rn-updates/
Fixes #1072