Fix --base64encode flag drift in image pull secret docs#791
Closed
jamsea wants to merge 4 commits into
Closed
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
The CLI flag is --encode (default true), not --base64encode. Three pages referenced the wrong flag name and framed encoding as opt-in when it's the default. Updates the wording to match the CLI reference: encoding happens by default; pass --encode=false to opt out. Affects: - pipecat-cloud/fundamentals/secrets.mdx - pipecat-cloud/guides/container-registries/docker-hub.mdx - pipecat-cloud/security/security-and-compliance.mdx (two occurrences) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
jamsea
force-pushed
the
docs/ghcr-image-pull-secret
branch
from
d1f5a37 to
3aca637
Compare
jamsea
changed the title
jamsea
requested review from
Copilot and
markbackman
and removed request for
Copilot
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Pipecat Cloud documentation to reflect the correct CLI flag for pipecat cloud secrets image-pull-secret: credentials are base64-encoded by default via --encode (default true), and users can opt out with --encode=false.
Changes:
- Replaced incorrect
--base64encodereferences with--encode=false. - Updated wording to clarify that base64 encoding is the default behavior (not opt-in).
- Adjusted example/snippet text in security guidance to align with the CLI’s default encoding behavior.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| pipecat-cloud/fundamentals/secrets.mdx | Updates image pull secret docs to reflect default base64 encoding and the --encode=false opt-out. |
| pipecat-cloud/guides/container-registries/docker-hub.mdx | Aligns Docker Hub guide wording with the correct flag name and default encoding behavior. |
| pipecat-cloud/security/security-and-compliance.mdx | Updates security guidance examples and Tip callout to use --encode=false and describe default encoding. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…docs Mirrors the Copilot Autofix that landed on secrets.mdx and docker-hub.mdx: describe `--encode=false` as "store credentials without base64 encoding" rather than "use only if your credentials are already encoded." The CLI takes raw `username:password` and the flag controls whether the CLI encodes them for storage; the original wording could mislead readers into pre-encoding their credentials. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
markbackman
reviewed
May 5, 2026
Contributor
markbackman
left a comment
markbackman
left a comment
There was a problem hiding this comment.
I'm going to close this out and open a separate PR with a slightly different solution:
#797
|
|
||
| Running this command will prompt you for account credentials. | ||
| You can optionally encode your credentials in base64 with the `--base64encode` flag. | ||
| Credentials are base64-encoded by default; pass `--encode=false` to store them without base64 encoding. |
Contributor
There was a problem hiding this comment.
--encode=false isn't an option.
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.
Summary
The CLI flag for
pipecat cloud secrets image-pull-secretis--encode(defaulttrue), not--base64encode. Three pages referenced the wrong flag name and framed encoding as opt-in when it's actually the default.Updates the wording on all three to match the CLI reference: encoding happens by default; pass
--encode=falseto opt out.Files changed
pipecat-cloud/fundamentals/secrets.mdxpipecat-cloud/guides/container-registries/docker-hub.mdxpipecat-cloud/security/security-and-compliance.mdx(two occurrences)Test plan
grep -rn base64encode docsreturns 0 hits (verified locally)🤖 Generated with Claude Code