Skip to content

Full config reference for service.yaml - #578

Open
benitav wants to merge 20 commits into
mainfrom
service-yaml-reference
Open

Full config reference for service.yaml#578
benitav wants to merge 20 commits into
mainfrom
service-yaml-reference

Conversation

@benitav

@benitav benitav commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Our drift agent pointed out a lot of undocumented config options for self-hosted instances, which inspired me to add a full reference (internal Slack ref).

Examples:

Main changes:

  • Rewrote the Self-Hosted Instance Configuration page to include a better intro, better flow, and added a full service.yaml reference, covering all user-facing config options
  • Claude Code verified every option in the reference against the powersync-service source code; fixed inaccuracies and added missing options
  • Made sure to exclude deprecated and internal options from the reference (debug_api, block_local_jwks, use_legacy probe, internal telemetry endpoint)
  • Added a section about the necessary permissions for MongoDB bucket storage

Other:

  • Improved the Cloud Instances page with a proper intro, added a CLI tab for creating an instance, and generally just a better flow
  • Added a shared snippet for the CLI instance creation steps, reused on the setup guide and Cloud Instances page
  • Removed outdated SDK version mentions ("available since version X") across several pages where the version was very old

AI usage: Claude Code did most of the actual work - checking what's available and writing the content - using my guidance. It referenced the powersync-service repo for all available options and we then went through multiple review cycles (using the repo reviewer skills and my own manual review) to polish and improve readability. The Configuration Reference section would still benefit from a more technical review/once-over.

@mintlify

mintlify Bot commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
powersync 🟢 Ready View Preview Aug 19, 2026, 2:34 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Comment thread configuration/powersync-service/self-hosted-instances.mdx Outdated
Comment thread configuration/powersync-service/self-hosted-instances.mdx Outdated
Comment thread configuration/powersync-service/self-hosted-instances.mdx Outdated
Comment thread configuration/powersync-service/self-hosted-instances.mdx Outdated
@benitav
benitav marked this pull request as draft August 19, 2026 15:06
@benitav benitav changed the title WIP: full reference for service.yaml Full config reference for service.yaml Aug 20, 2026
@benitav
benitav marked this pull request as ready for review August 20, 2026 09:46
Comment thread configuration/powersync-service/self-hosted-instances.mdx Outdated
Comment thread configuration/powersync-service/self-hosted-instances.mdx Outdated
Comment thread configuration/powersync-service/self-hosted-instances.mdx Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant