Skip to content

Conversation

@offendingcommit
Copy link
Owner

@offendingcommit offendingcommit commented Jun 20, 2025

Summary

This PR transforms this repository into a Docker-focused distribution of mcp-remote, providing:

  • Pre-built multi-platform Docker images on ghcr.io
  • Comprehensive Docker documentation
  • Easy integration with MCP clients using Docker

Changes

Docker Infrastructure

  • Dockerfile: Multi-stage build with Node 22 Alpine, runs as non-root user
  • docker-compose.yml: Easy container management with volume mounting
  • GitHub Actions: Automated multi-platform builds (linux/amd64, linux/arm64) and publishing to ghcr.io
  • .dockerignore: Optimized build context

Documentation Refactor

  • README.md: Now Docker-focused with examples for all MCP clients
  • README.Docker.md: Detailed Docker usage guide
  • README.npm.md: Preserved npm documentation for reference
  • CLAUDE.md: Added Docker commands section

Workflow Updates

  • Removed npm publish workflow (not needed for Docker distribution)
  • Enhanced Docker workflow with detailed documentation
  • Maintained code quality checks (prettier, TypeScript)

Test Results

  • Build Docker image locally
  • Test running proxy in container
  • Test OAuth flow with port forwarding (verified container runs and attempts connection)
  • Verify multi-platform builds in CI (confirmed linux/amd64 and linux/arm64)
  • Confirm images publish to ghcr.io on merge (workflow configured correctly)

Docker Usage

# Using pre-built images
docker pull ghcr.io/offendingcommit/mcp-remote:latest
docker run -it ghcr.io/offendingcommit/mcp-remote:latest https://your-server/sse

# With persistent OAuth tokens
docker run -it -v mcp-auth:/home/mcp/.mcp-auth ghcr.io/offendingcommit/mcp-remote:latest https://your-server/sse

Ready for review and merge!

- Add Dockerfile with multi-stage build for optimal image size
- Add docker-compose.yml for easier container management
- Add comprehensive Docker documentation in README.Docker.md
- Add GitHub Actions workflow to build and publish to ghcr.io
- Update CLAUDE.md with Docker commands
- Support for linux/amd64 and linux/arm64 platforms
The proxy.ts file expects a server URL as first argument, so having
--help as default CMD causes parsing errors. Empty CMD allows proper
argument passing.
Applied prettier formatting to:
- .github/workflows/docker.yml
- CLAUDE.md
- docker-compose.yml
- README.Docker.md
- Replace npm-focused README with Docker-focused documentation
- Move npm documentation to README.npm.md for reference
- Remove npm publish workflow (not needed for Docker distribution)
- Add comprehensive Docker usage examples for all MCP clients
- Document multi-platform support and ghcr.io publishing
- Update workflow documentation to clarify Docker focus
@offendingcommit offendingcommit merged commit 1c1821c into main Jun 20, 2025
2 checks passed
@offendingcommit offendingcommit deleted the feat/docker-support branch June 20, 2025 16:18
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