# Deployment Guide (Maintainers)

This guide covers how to host the API base, configure environments, and publish the CLI.

## Environments
- **API Base URLs**
  - Dev: `http://localhost:4000`
  - Prod: `https://app.compair.sh/api`

Expose the API base to users via `COMPAIR_API_BASE` or `--api-base`.

## Secrets
- The CLI reads user tokens from `~/.compair/credentials.json`.
- The API should validate the `Authorization: Bearer` header.

## Publishing binaries (optional)
See [CI & Release](ci_release.md). With GitHub Actions + GoReleaser you can:
- Build macOS/Linux/Windows archives
- Build Linux `.deb` and `.rpm` packages
- Publish a Linux APT/RPM repository once `RocketResearch-Inc/compair-packages` exists and Pages is enabled
- Publish a Homebrew cask once `RocketResearch-Inc/homebrew-tap` exists
- Publish WinGet manifests once `RocketResearch-Inc/winget-pkgs` exists
- Generate release notes and optional SBOMs

What this repo can automate directly:
- Building archives and checksums
- Building Linux packages
- Updating the GitHub Pages Linux package repo
- Embedding CLI version metadata
- Uploading GitHub release artifacts
- Updating the Homebrew tap
- Generating and submitting WinGet manifests
- Running Compair review/gate jobs in CI

What still depends on external infrastructure:
- Linux package repo ownership, GitHub Pages config, and signing secrets
- Homebrew tap ownership and credentials
- WinGet fork ownership and credentials
- CI secrets for `COMPAIR_AUTH_TOKEN` and any PR comment integrations

For the exact setup steps, see [Package Distribution Setup](package_distribution.md).

## GitHub Pages (docs site)
- Put docs in `docs/` (already structured).
- Enable **Pages** in repo settings -> build from `main` branch `/docs`.
- (Optional) Edit `_config.yml` to change theme and navigation.

## Operational notes
- Monitor `/process_doc` task throughput; scale workers as needed.
- Consider webhooks from GitHub/GitLab to prewarm or accelerate processing (CLI doesn't require this).
- Add rate limiting and structured errors on the API; the CLI prints body text if a request fails.
- If CI should keep updating the same repo document, commit `.compair/config.yaml` so ephemeral runners reuse the existing binding.