Skip to content

Installation

gitea edited this page Aug 14, 2026 · 2 revisions

Installation

Skeleton — to be filled in.

Planned content:

Requirements

  • Python version, dependencies (requirements.txt)
  • A Portfolio Performance .portfolio file (optionally password-protected)

Local installation (no Docker)

  • pip install -r requirements.txt
  • Required env vars: PP_FILE_PATH (+ PP_PASSWORD if encrypted)
  • Running: python -m src.main (must run from repo root — python src/main.py fails with ModuleNotFoundError)
  • Default transport/port (streamable-http on :8080)

Docker installation

  • docker-compose.dev.yml — simple local single-source setup
  • docker-compose.yml — multi-source production setup (PP_PORTFOLIOS_CONFIG + portfolios.json, MCP_AUTH_TOKEN required)
  • Read-only file mounts, portfolios.json.example

Running as a background service (optional, e.g. macOS launchd)

  • Brief pointer only (this is a personal-setup detail, not core install docs)

Verifying the installation

  • ping tool
  • TCP healthcheck on port 8080

Multi-source vs. single-source configuration

  • When to use PP_FILE_PATH vs. PP_PORTFOLIOS_CONFIG

← Introduction · Configuring AI Tools →

Clone this wiki locally