Add Docker support and rewrite the installation guide - #7
Merged
Merged
Conversation
Multi-stage build compiles the SDK, then ships a lean runtime with Python 3 and cloudscraper in an isolated venv, running as a non-root user. Boots the MCP server in a single command; verified end-to-end (daemon ping).
Drop the stale auto-install/postinstall narrative (removed in 0.2.0) in favor of explicit pip/venv/helper paths, and add a Docker section plus a README pointer.
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.
What
Dockerfile(+.dockerignore). The build stage compiles the SDK; the runtime stage ships a lean image bundling Node 22, Python 3 andcloudscraperin an isolated venv, running as a non-root user.docker run -i --rm cloudscraper-jsboots the MCP server in a single command.INSTALLATION.mdto drop the stale auto-install /postinstallnarrative (removed in 0.2.0) in favor of explicit pip / venv / helper paths, added a Docker section, and added a Docker pointer to the README.Why
INSTALLATION.mdstill described the privileged auto-install onpostinstallthat was removed for security in 0.2.0 — contradicting both the README andpackage.json. The project also had no container image despite needing Node and Python 3 at runtime, so there was no one-command way to run the stack (or the MCP server) in a clean environment.Verification
docker buildsucceeds; thecloudscraperimport is checked at build time.cloudscraperreachable as the non-root user (uid 1000) via the venv onPATH.createScraper, MCP, LangChain tool, function schemas, markdown).pingreturns{"ok":true,"pong":true,"cloudscraper":true}.Commits
chore(docker): add container image with Node, Python and cloudscraperdocs(install): rewrite guide for opt-in setup and document Docker