Skip to content

Commit b56e574

Browse files
committed
docs: update README on how to use container
1 parent 842ee70 commit b56e574

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

Dockerfile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ RUN --mount=type=cache,target=/root/.cache/uv \
2525

2626
FROM python:3.12-alpine
2727

28+
LABEL org.opencontainers.image.source=https://github.com/sparfenyuk/mcp-proxy
29+
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."
30+
LABEL org.opencontainers.image.licenses=MIT
31+
2832
COPY --from=uv --chown=app:app /app/.venv /app/.venv
2933

3034
# Place executables in the environment at the front of the path

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
- [2.2 Example usage](#22-example-usage)
1717
- [Installation](#installation)
1818
- [Installing via Smithery](#installing-via-smithery)
19+
- [Installing via PyPI](#installing-via-pypi)
20+
- [Installing via Github repository (latest)](#installing-via-github-repository-latest)
21+
- [Installing as container](#installing-as-container)
1922
- [Command line arguments](#command-line-arguments)
2023
- [Testing](#testing)
2124

@@ -139,6 +142,8 @@ To install MCP Proxy for Claude Desktop automatically via [Smithery](https://smi
139142
npx -y @smithery/cli install mcp-proxy --client claude
140143
```
141144

145+
### Installing via PyPI
146+
142147
The stable version of the package is available on the PyPI repository. You can install it using the following command:
143148

144149
```bash
@@ -151,6 +156,8 @@ pipx install mcp-proxy
151156

152157
Once installed, you can run the server using the `mcp-proxy` command. See configuration options for each mode above.
153158

159+
### Installing via Github repository (latest)
160+
154161
The latest version of the package can be installed from the git repository using the following command:
155162

156163
```bash
@@ -163,6 +170,14 @@ uv tool install git+https://github.com/sparfenyuk/mcp-proxy
163170
> [!NOTE]
164171
> If you want to delete the server, use the `uv tool uninstall mcp-proxy` command.
165172
173+
### Installing as container
174+
175+
Starting from version 0.3.2, it's possible to pull and run the corresponding container image:
176+
177+
```bash
178+
docker run -t ghcr.io/sparfenyuk/mcp-proxy:v0.3.2 --help
179+
```
180+
166181
## Command line arguments
167182

168183
```bash

0 commit comments

Comments
 (0)