diff --git a/README.md b/README.md index a52fc8a..88ffadf 100644 --- a/README.md +++ b/README.md @@ -49,21 +49,52 @@ Built with [FastMCP](https://github.com/jlowin/fastmcp) and the [MCP Python SDK] ## Installation & Deployment -### Docker (Recommended) +### Docker (Recommended for self-hosting) -The project includes a multi-arch Docker build (amd64/arm64). +A pre-built multi-arch image (amd64/arm64) is automatically published to the Gitea registry on every release. + +**1. Authenticate first** (only needed once, saves credentials to `~/.config/strava-mcp-server/config.env`): + +```bash +uvx --from strava-mcp-server-hnrx auth +``` + +**2. Pull and run the image:** + +```bash +# Pull the latest release +docker pull git.hnrx.net/hnrx/strava-mcp-server:latest + +# Run with your credentials from the config file +docker run --rm -p 8000:8000 \ + -e STRAVA_CLIENT_ID= \ + -e STRAVA_CLIENT_SECRET= \ + -e STRAVA_REFRESH_TOKEN= \ + -e MCP_TRANSPORT=http \ + git.hnrx.net/hnrx/strava-mcp-server:latest +``` + +Or using your config file directly: + +```bash +docker run --rm -p 8000:8000 \ + --env-file ~/.config/strava-mcp-server/config.env \ + -e MCP_TRANSPORT=http \ + git.hnrx.net/hnrx/strava-mcp-server:latest +``` + +> **Tip:** Pin to a specific version for stability, e.g. `git.hnrx.net/hnrx/strava-mcp-server:v0.2.0` + +
+Build from source ```bash -# Clone the repository git clone https://git.hnrx.net/hnrx/strava-mcp-server.git cd strava-mcp-server - -# Build the image locally docker build -t strava-mcp-server:latest . - -# Run the container (injecting your .env file) -docker run --rm -p 8000:8000 --env-file .env strava-mcp-server:latest +docker run --rm -p 8000:8000 --env-file ~/.config/strava-mcp-server/config.env -e MCP_TRANSPORT=http strava-mcp-server:latest ``` +
### Local Python (PyPI)