-
-
Notifications
You must be signed in to change notification settings - Fork 5.4k
Update README.md with latest docker image #1483
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
The outdated documentation suggested pulling 0.7.0 which is not available. Proposing to always pull latest.
WalkthroughDocumentation update in README: Docker instructions changed from using a fixed image tag (0.7.0) and “release candidate” wording to using the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal). Please share your feedback with us on this Discord post. 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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
README.md (3)
307-309
: Don’t recommend:latest
for production; add a pinning note (and example).Using
latest
harms reproducibility and can break deployments on rebuilds. Keeplatest
for quickstart, but add a one‑liner showing how to pin a specific tag for prod.Apply this minimal tweak to the snippet/comment:
-# Pull and run the latest release version -docker pull unclecode/crawl4ai:latest -docker run -d -p 11235:11235 --name crawl4ai --shm-size=1g unclecode/crawl4ai:latest +# Quickstart: run the latest image (for production, pin a specific version tag) +docker run --pull=always -d -p 11235:11235 --name crawl4ai --shm-size=1g unclecode/crawl4ai:latest +# Example (recommended for prod): replace 'latest' with a tag, e.g. '0.7.4' +# docker run -d -p 11235:11235 --name crawl4ai --shm-size=1g unclecode/crawl4ai:0.7.4
307-309
: Use--pull=always
and add a restart policy.This removes the separate
docker pull
step and makes the container more resilient across host reboots.-docker pull unclecode/crawl4ai:latest -docker run -d -p 11235:11235 --name crawl4ai --shm-size=1g unclecode/crawl4ai:latest +docker run --pull=always --restart unless-stopped -d -p 11235:11235 --name crawl4ai --shm-size=1g unclecode/crawl4ai:latest
307-307
: Micro copy nit: clarify it’s the “latest Docker image.”“Latest release version” can be misread as the Python package. Minor clarity gain.
-# Pull and run the latest release version +# Pull and run the latest Docker image
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
(1 hunks)
🔇 Additional comments (1)
README.md (1)
307-309
: Confirmlatest
points to the current release (0.7.4)File: README.md lines 307–309
Registry check returned: 0.7.2, 0.7.3, 0.7.4, latest —
latest
exists. Ensurelatest
resolves to 0.7.4 (digest compare):latest=$(curl -s -L 'https://hub.docker.com/v2/repositories/unclecode/crawl4ai/tags/latest' | jq -r '.images[]?.digest' | sort -u | tr '\n' ';'); v=$(curl -s -L 'https://hub.docker.com/v2/repositories/unclecode/crawl4ai/tags/0.7.4' | jq -r '.images[]?.digest' | sort -u | tr '\n' ';'); [ "$latest" = "$v" ] && echo MATCH || echo DIFFER
Summary
The outdated documentation suggested pulling 0.7.0 which is not available. Proposing to always pull latest.
List of files changed and why
README.md - Update docker example with latest image
How Has This Been Tested?
Locally, seems to run fine
Checklist:
Summary by CodeRabbit