Skip to content

docs(installation): document GHCR pre-built image and unprivileged runtime - #355

Merged
jlucaso1 merged 1 commit into
mainfrom
claude/nifty-bohr-egdxuu
Jun 30, 2026
Merged

jlucaso1 merged 1 commit into
mainfrom
claude/nifty-bohr-egdxuu

Conversation

@jlucaso1

@jlucaso1 jlucaso1 commented Jun 30, 2026

Copy link
Copy Markdown
Collaborator

Summary

Updates installation.mdx to reflect changes from whatsapp-rust#927.

  • New "Pre-built image" subsection — documents ghcr.io/oxidezap/whatsapp-rust:latest, the multi-arch manifest (amd64/arm64 resolved automatically), tagged release images, and publish triggers.
  • "Build the image" → "Build from source" — renamed to make clear it's now an alternative to pulling.
  • Updated "Run the container" — switches example commands to use the GHCR image reference and a named volume (whatsapp-data:/data). Named volumes are now recommended because the container runs as uid 65532 and a named volume inherits that ownership automatically; host bind mounts require manual chown.
  • Host bind-mount note — explains the uid 65532 ownership requirement for users who prefer bind mounts.
  • Upgrade path — one-time chown command for existing volumes that were created under the old root-running image.

Generated by Claude Code


Summary by cubic

Add docs for the pre-built multi-arch Docker image on GHCR and the unprivileged runtime (uid 65532). Examples now pull ghcr.io/oxidezap/whatsapp-rust:latest, prefer a named volume for /data, rename “Build from source,” and include bind-mount guidance.

  • Migration
    • Upgrading from older root-based images? Fix existing named volumes once: docker run --rm -v whatsapp-data:/data alpine chown -R 65532:65532 /data

Written for commit 53c73d0. Summary will update on new commits.

Review in cubic

…ntime

Reflects whatsapp-rust#927: the Docker workflow now publishes a multi-arch
image to ghcr.io/oxidezap/whatsapp-rust. Users can pull instead of building
locally. Also documents the unprivileged uid 65532 runtime, the named-volume
preference, and the one-time chown upgrade path for existing volumes.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01J4qcHkiE4H25nr7Z4VrkTR
@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@jlucaso1, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 28 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 564e516d-89f7-4718-ba3d-7a006b5ca845

📥 Commits

Reviewing files that changed from the base of the PR and between f4ceb3d and 53c73d0.

📒 Files selected for processing (1)
  • installation.mdx

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

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

@mintlify

mintlify Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
whatsapp-rust 🟢 Ready View Preview Jun 30, 2026, 3:55 AM

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

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 53c73d015d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread installation.mdx
Pull from GitHub Container Registry — a single manifest resolves to `linux/amd64` or `linux/arm64` automatically based on the host:

```bash
docker pull ghcr.io/oxidezap/whatsapp-rust:latest

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Don't point Docker users at an unpublished image

This new pre-built-image path is currently not pullable: the public oxidezap package list shows no container package for whatsapp-rust, so users following this command will get a GHCR not-found/authorization error instead of an installable image. Please either publish and make the GHCR package public before merging these docs, or frame this as a future/after-publish reference rather than the primary Docker install path.

Useful? React with 👍 / 👎.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Re-trigger cubic

@jlucaso1
jlucaso1 merged commit 4f978d5 into main Jun 30, 2026
3 checks passed
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.

2 participants