Update security instructions for API-M web portals#11249
Conversation
Removed detailed instructions for restricting access to the management console and added a note about controlling access to all web applications.
|
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughDocumentation Update: Web Portal Access ControlThis PR updates the "Securing Web Portals" documentation by removing references to an unsupported configuration option for restricting Management Console access. Changes Made
What Remains UnchangedDocumentation still covers the supported access-restriction options:
Affected file: en/docs/install-and-setup/setup/security/securing-api-m-web-portals.md WalkthroughThe PR revises the "Restricting access to web portals" documentation: it removes references to the standalone management console access-control configuration ( 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
⚔️ Resolve merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Removes outdated documentation from the “Securing Web portals” page that described restricting access to the Management Console via an unsupported [admin_console.control_access] configuration.
Changes:
- Removed the
[admin_console.control_access]deployment.tomlexample and its explanatory note from “Restricting access to web portals”. - Adjusted the introduction to the “Restricting access to web portals” section (but it still contains a misleading reference that needs follow-up).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/docs/install-and-setup/setup/security/securing-api-m-web-portals.md`:
- Line 35: Reword the sentence that currently reads "You can restrict access to
the management console of the API-M runtime by binding the management console
with selected IP addresses." so it no longer implies a standalone
management-console-only IP-binding option; instead explicitly state that access
is controlled via the general web-portal IP-binding/configuration methods
described below (refer to the phrase "restrict access to all web portals" and
the subsequent configuration sections), e.g., replace the sentence with a clear
pointer that management console access is restricted using the same IP-binding
and portal configuration methods documented in the following sections.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e3014ae5-d86d-4aa6-91b5-8e78f798b18f
📒 Files selected for processing (1)
en/docs/install-and-setup/setup/security/securing-api-m-web-portals.md
|
@Rami2212 Please address the suggestion from CodeRabbit and Copilot. |
|
@Rami2212 shall we resolve the file conflicts as well? |
…rtals.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
Hi @Rami2212, I don't see any file changes in this PR. Will you be able to check and do the needful? Thanks, |
Remove unsupported Management Console access control configuration
Summary
Removed the documentation for restricting access to the Management Console via
[admin_console.control_access]configuration, as this feature is no longer supported at the product level.Problem
The following configuration was documented under the Restricting access to web portals section of the Securing Web Portals page:
This configuration is no longer functional at the product level, making the documentation misleading and potentially causing confusion for users who attempt to use it.
Changes
[admin_console.control_access]indeployment.toml.Affected Pages
Type of Change
Additional Notes
The remaining access restriction options — controlling access to all web applications via
[web_app.control_access]and restricting access to specific servlets via[[servlet_access_control_filter]]— are unaffected and remain documented as before.