diff --git a/Installation.md b/Installation.md new file mode 100644 index 0000000..31c4de0 --- /dev/null +++ b/Installation.md @@ -0,0 +1,98 @@ +# 📦 Installation + +All installation methods for the Strava MCP Server. + +--- + +## Option 1: uvx (Recommended — no install needed) + +Run directly from PyPI without installing anything permanently: + +```bash +# Authenticate (once) +uvx --from strava-mcp-server-hnrx auth + +# Run the server +uvx --from strava-mcp-server-hnrx server +``` + +`uvx` downloads, caches, and runs the package in an isolated environment. +Requires [uv](https://docs.astral.sh/uv/) (`curl -LsSf https://astral.sh/uv/install.sh | sh`). + +--- + +## Option 2: Docker (Recommended for self-hosting) + +A pre-built multi-arch image (amd64/arm64) is automatically published on every release. + +```bash +# Pull the latest image +docker pull git.hnrx.net/hnrx/strava-mcp-server:latest + +# Run with config file +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 +``` + +Pin to a specific version for production stability: + +```bash +docker pull git.hnrx.net/hnrx/strava-mcp-server:v0.1.1 +``` + +
+Build from source + +```bash +git clone https://git.hnrx.net/hnrx/strava-mcp-server.git +cd strava-mcp-server +docker build -t 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 +``` +
+ +--- + +## Option 3: pip / uv add + +Install permanently into your Python environment: + +```bash +pip install strava-mcp-server-hnrx +# or +uv add strava-mcp-server-hnrx +``` + +Then run: + +```bash +auth # Interactive setup wizard +server # Start the MCP server +``` + +--- + +## Option 4: From Source (for Contributors) + +```bash +git clone https://git.hnrx.net/hnrx/strava-mcp-server.git +cd strava-mcp-server + +# Install dependencies +uv sync + +# Authenticate +uv run auth + +# Start the server +uv run server +``` + +--- + +*Back to [Home](Home)*