docs(self-hosting): document API_ONLY_SERVICE_MODE

[mintlify]

Summary

Adds API_ONLY_SERVICE_MODE to the self-hosting webapp env var table, next to the origin settings.

Self-hosters can now run webapp instances that only serve the SDK, CLI and worker APIs. enforce redirects dashboard requests to APP_ORIGIN and returns 404 for other non-API requests. report only logs them.

Based on feat(webapp): API_ONLY_SERVICE_MODE to keep the dashboard off API-only services, which added the setting.

Docs only. Mark ready for review to merge.

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

• Configuration used: Repository UI
• Review profile: CHILL
• Plan: Advanced
• Run ID: 4202908e-66f8-4776-89a9-4825caf20041

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving 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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[changeset-bot]

⚠️ No Changeset found

Latest commit: 7ba17db

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[ericallam]

@claude address ci review comments please

[claude]

Claude finished @ericallam's task in 58s —— View job

---

Addressing CI Review Comments

• Review Devin's feedback about API_ONLY_SERVICE_MODE behavior
• Read the actual implementation to understand correct behavior
• Update the documentation to be accurate
• Commit and push changes

Done. Updated the API_ONLY_SERVICE_MODE description to clarify that:

• GET/HEAD non-API requests redirect to APP_ORIGIN when set
• Other methods or requests without APP_ORIGIN return 404
• report mode logs without blocking

This addresses Devin's review comment about the 404 behavior being more nuanced than the original wording implied.
|