Repository navigation
docs: deprecate the built-in Playground and drop it from the Docker guides - #1407
Draft
cluelessno1 wants to merge 2 commits into
Draft
cluelessno1 wants to merge 2 commits into
cluelessno1 wants to merge 2 commits into
Conversation
…ocker examples - playground: add a deprecation warning (disabled by default since v1.14.0), note it only works with authn method `none`, document enabling it (binary, Docker with --playground-addr 0.0.0.0:3000, different address), mark --playground-port deprecated, and add a browser restrictions section covering Chrome Local Network Access (openfga/openfga#3318) and blocked third-party storage. - docker: remove -p 3000:3000 and the Compose playground port mappings from every example, and stop describing port 3000 as the Playground. - configure-openfga: drop -p 3000:3000 from the profiler Docker example. - refresh the native deployment fingerprint in docs.json. Follows the maintainer's direction in #1371. Co-Authored-By: Claude <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Contributor
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: true
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. CodeRabbit Verify
|
This was referenced Oct 29, 2026
Member
Author
|
Leaving this PR as Draft for now as I need more clarity on the status of OpenFGA Playground before making the necessary changes. |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Marks the built-in Playground as deprecated and stops publishing it in the Docker setup guide. The Playground page keeps one opt-in path with commands that work.
Note
This PR changes content that the
docs-site/parity contract freezes, sotest:mintlify-content-parity(the "Check repository-owned Mintlify content" job) fails on purpose. See Question for maintainers.Description
What problem is being solved?
Following the Docker guide,
http://localhost:3000/playgroundnever loads:-p 3000:3000, and the guide says port 3000 serves the Playground. The Playground has been disabled by default since v1.14.0, so nothing listens there.--playground-addr, it binds to127.0.0.1:3000inside the container, which a published port cannot reach.--playground-portflag, and says only OIDC is unsupported (it now requires authn methodnone).allow="local-network-access"openfga#3318). The docs don't mention it.How is it being solved?
This follows the maintainer direction from the #1371 review: stop enabling and publishing the Playground in the Docker examples, mark it deprecated and limited by browser restrictions, point readers to the OpenFGA CLI and VS Code extension, and remove the stray port 3000 mappings from the profiling examples. The Playground page keeps one opt-in section for readers who still want it.
What changes are made to solve it?
setup-openfga/playground.mdx.fga.yamltests.none, and link to the new browser restrictions section.openfga run --playground-enabled, plus the Docker formdocker run -p 8080:8080 -p 3000:3000 openfga/openfga run --playground-enabled --playground-addr 0.0.0.0:3000.--playground-addr 127.0.0.1:3001and notes that--playground-portis deprecated.best-practices/running-in-production.mdxlinks to it.setup-openfga/docker.mdx: removed-p 3000:3000from everydocker runexample (including profiling) and the Playground port entry from the three Compose files. The step-by-step text now describes ports 8080 and 8081 only.setup-openfga/configure-openfga.mdx: removed-p 3000:3000from the profiler Docker example.docs.json: refreshed the native deployment fingerprint.Testing
npm run check:mintlifytest:mintlify-content-parity. Its 5 failures are the intended edits (listed below).mint broken-linksperform-check,contextual-tuples,relationship-queries).openfga/openfga:v1.22.1with--playground-enabled --playground-addr 0.0.0.0:3000starting openfga playground on http://0.0.0.0:3000/playground;/playgroundreturns 200.--playground-addr127.0.0.1:3000; the host request gets an empty reply.Host ports were bound to
127.0.0.1in these runs. That doesn't change the in-container behavior being tested. I haven't checked the pages in a local Mintlify render, so please use the Mintlify preview.Question for maintainers
docs-site/README.mdfreezes page prose, headings and examples during the migration, and says intentional changes need a reviewed update to the contract rather than regenerated fixtures. I haven't touched the fixtures. The failures:live-original-parity: body content ofplayground.mdxanddocker-setup.mdxlive-foundations-parity: production prose ofplayground.mdxanddocker-setup.mdx, and the changed bash example inconfigure-openfga.mdx@Siddhant-K-code, how would you like the contract updated? I can add page-scoped expectations in this PR, following the
parentChildHeadingCorrectionpattern from e0d745e. Or, if you'd rather have a general mechanism for post-migration content edits (#1401 runs into the same check), I'll wait for that.References
allow="local-network-access"openfga#3318Review Checklist
main🤖 Generated with Claude Code