docs: document PUBLIC_API_EXPOSED_URL

[eric-intuitem]

Summary by CodeRabbit

• Documentation
  • Updated README with configuration details for Single Sign-On (SSO) setup
  • Added explanation for PUBLIC_BACKEND_API_EXPOSED_URL environment variable

[coderabbitai]

Walkthrough

The pull request updates the README.md file by adding documentation for the PUBLIC_BACKEND_API_EXPOSED_URL environment variable. This new line provides clarity on the configuration required for Single Sign-On (SSO) functionality, specifically explaining how the variable is constructed by combining the backend's URL with "/api" to expose the API endpoint as seen from the browser.

Changes

File	Change Summary
README.md	Added documentation for PUBLIC_BACKEND_API_EXPOSED_URL environment variable, explaining its role in SSO configuration

Poem

🐰 A rabbit's guide to SSO's might,
One line of docs to set things right,
PUBLIC_BACKEND_API_EXPOSED_URL so clear,
Helping devs configure without fear,
Documentation hopping with delight! 🌐

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

442-443: Enhance the documentation with more details.

Consider adding:

• Whether this is a required variable for SSO
• Example values (e.g., if CISO_ASSISTANT_URL is "https://example.com", then PUBLIC_BACKEND_API_EXPOSED_URL should be "https://example.com/api")
• The impact if not set correctly

-The PUBLIC_BACKEND_API_EXPOSED_URL is necessary for proper functioning of the SSO. It points to the URL of the API as seen from the browser. It should be equal to the concatenation of CISO_ASSISTANT_URL (in the backend) with "/api".
+# Required for SSO functionality
+export PUBLIC_BACKEND_API_EXPOSED_URL=<CISO_ASSISTANT_URL>/api
+# Example: If CISO_ASSISTANT_URL=https://example.com, then PUBLIC_BACKEND_API_EXPOSED_URL=https://example.com/api
+# This variable is required for Single Sign-On (SSO) to function properly, as it defines the API endpoint URL
+# that the browser uses to communicate with the backend. If not set correctly, SSO authentication will fail.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between adcb8d3 and 93c1f6b.

📒 Files selected for processing (1)

• README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: startup-functional-test (3.12)
• GitHub Check: startup-docker-compose-test
• GitHub Check: enterprise-startup-functional-test (3.12)
• GitHub Check: functional-tests (3.12, chromium)
• GitHub Check: enterprise-functional-tests (3.12, chromium)
• GitHub Check: enterprise-startup-docker-compose-test

🔇 Additional comments (1)

README.md (1)

442-443: ⚠️ Potential issue

Inconsistent variable name in PR title vs documentation.

The PR title mentions PUBLIC_API_EXPOSED_URL but the documentation uses PUBLIC_BACKEND_API_EXPOSED_URL. Please ensure consistency to avoid confusion.

[Mohamed-Hacene]

0k