docs: update README on how to use container
This commit is contained in:
@@ -25,6 +25,10 @@ RUN --mount=type=cache,target=/root/.cache/uv \
|
||||
|
||||
FROM python:3.12-alpine
|
||||
|
||||
LABEL org.opencontainers.image.source=https://github.com/sparfenyuk/mcp-proxy
|
||||
LABEL org.opencontainers.image.description="Connect to MCP servers that run on SSE transport, or expose stdio servers as an SSE server using the MCP Proxy server."
|
||||
LABEL org.opencontainers.image.licenses=MIT
|
||||
|
||||
COPY --from=uv --chown=app:app /app/.venv /app/.venv
|
||||
|
||||
# Place executables in the environment at the front of the path
|
||||
|
||||
15
README.md
15
README.md
@@ -16,6 +16,9 @@
|
||||
- [2.2 Example usage](#22-example-usage)
|
||||
- [Installation](#installation)
|
||||
- [Installing via Smithery](#installing-via-smithery)
|
||||
- [Installing via PyPI](#installing-via-pypi)
|
||||
- [Installing via Github repository (latest)](#installing-via-github-repository-latest)
|
||||
- [Installing as container](#installing-as-container)
|
||||
- [Command line arguments](#command-line-arguments)
|
||||
- [Testing](#testing)
|
||||
|
||||
@@ -139,6 +142,8 @@ To install MCP Proxy for Claude Desktop automatically via [Smithery](https://smi
|
||||
npx -y @smithery/cli install mcp-proxy --client claude
|
||||
```
|
||||
|
||||
### Installing via PyPI
|
||||
|
||||
The stable version of the package is available on the PyPI repository. You can install it using the following command:
|
||||
|
||||
```bash
|
||||
@@ -151,6 +156,8 @@ pipx install mcp-proxy
|
||||
|
||||
Once installed, you can run the server using the `mcp-proxy` command. See configuration options for each mode above.
|
||||
|
||||
### Installing via Github repository (latest)
|
||||
|
||||
The latest version of the package can be installed from the git repository using the following command:
|
||||
|
||||
```bash
|
||||
@@ -163,6 +170,14 @@ uv tool install git+https://github.com/sparfenyuk/mcp-proxy
|
||||
> [!NOTE]
|
||||
> If you want to delete the server, use the `uv tool uninstall mcp-proxy` command.
|
||||
|
||||
### Installing as container
|
||||
|
||||
Starting from version 0.3.2, it's possible to pull and run the corresponding container image:
|
||||
|
||||
```bash
|
||||
docker run -t ghcr.io/sparfenyuk/mcp-proxy:v0.3.2 --help
|
||||
```
|
||||
|
||||
## Command line arguments
|
||||
|
||||
```bash
|
||||
|
||||
Reference in New Issue
Block a user