Closes #15, #22, #24, #25. Closes #1 and #27 (already shipped in 0.2.0). ## CI/CD (#22) - .forgejo/workflows/ci.yml — Python lint (ruff) + pytest + Vue typecheck + vitest on every PR/push. Installs cf-core from GitHub mirror for the CI runner. - .forgejo/workflows/release.yml — Docker build/push (api + web) to Forgejo registry on v* tags; git-cliff changelog; multi-arch amd64+arm64. - .forgejo/workflows/mirror.yml — push to GitHub + Codeberg mirrors. ## Self-hosted installer (#25) - install.sh rewritten to match CF installer pattern: coloured output, named functions, --docker / --bare-metal / --help flags, auto-detect Docker/conda/ Python/Node/Chromium/Xvfb, license key prompting with format validation. ## Nginx docs (#24) - docs/nginx-self-hosted.conf — sample nginx config: SPA fallback, SSE proxy (proxy_buffering off), long-term asset cache headers. - docs/getting-started/installation.md — bare-metal install section with nginx setup, Chromium/Xvfb note, serve-ui.sh vs nginx trade-off. ## cf-orch agent (#15) - compose.override.yml — cf-orch-agent sidecar service (profiles: [orch]). Starts only with docker compose --profile orch. Registers with coordinator at CF_ORCH_COORDINATOR_URL (default 10.1.10.71:7700). - .env.example — CF_ORCH_URL / CF_ORCH_COORDINATOR_URL comments expanded. ## Docs - mkdocs.yml + full docs/ tree (getting-started, reference, user-guide) staged from prior session work. Bump version 0.2.0 → 0.3.0.
90 lines
4.9 KiB
Text
90 lines
4.9 KiB
Text
# Snipe works out of the box with the scraper (no credentials needed).
|
|
# Set eBay API credentials to unlock full trust scores —
|
|
# account age and category history signals require the eBay Browse API.
|
|
# Without credentials the app logs a warning and falls back to the scraper.
|
|
|
|
# ── eBay Developer Keys — Production ──────────────────────────────────────────
|
|
# From https://developer.ebay.com/my/keys (Production tab)
|
|
EBAY_APP_ID=
|
|
EBAY_DEV_ID=
|
|
EBAY_CERT_ID=
|
|
|
|
# ── eBay Developer Keys — Sandbox ─────────────────────────────────────────────
|
|
# From https://developer.ebay.com/my/keys (Sandbox tab)
|
|
EBAY_SANDBOX_APP_ID=
|
|
EBAY_SANDBOX_DEV_ID=
|
|
EBAY_SANDBOX_CERT_ID=
|
|
|
|
# ── Active environment ─────────────────────────────────────────────────────────
|
|
# production | sandbox
|
|
EBAY_ENV=production
|
|
|
|
# ── eBay Account Deletion Webhook ──────────────────────────────────────────────
|
|
# Register endpoint at https://developer.ebay.com/my/notification — required for
|
|
# production key activation. Set EBAY_NOTIFICATION_ENDPOINT to the public HTTPS
|
|
# URL eBay will POST to (e.g. https://snipe.circuitforge.tech/api/ebay/account-deletion).
|
|
EBAY_NOTIFICATION_TOKEN=
|
|
EBAY_NOTIFICATION_ENDPOINT=
|
|
# Set to false during sandbox/registration (no production token available yet).
|
|
# Set to true once production credentials are active — enforces ECDSA verification.
|
|
EBAY_WEBHOOK_VERIFY_SIGNATURES=true
|
|
|
|
# ── Database ───────────────────────────────────────────────────────────────────
|
|
SNIPE_DB=data/snipe.db
|
|
|
|
# ── Cloud mode (managed / menagerie instance only) ─────────────────────────────
|
|
# Leave unset for self-hosted / local use. When set, per-user DB isolation
|
|
# and Heimdall licensing are enabled. compose.cloud.yml sets CLOUD_MODE=true
|
|
# automatically — only set manually if running without Docker.
|
|
|
|
# CLOUD_MODE=true
|
|
# CLOUD_DATA_ROOT=/devl/snipe-cloud-data
|
|
|
|
# JWT secret from cf-directus (must match Directus SECRET env var exactly).
|
|
# DIRECTUS_JWT_SECRET=
|
|
|
|
# Heimdall license server — for tier resolution and free-key auto-provisioning.
|
|
# HEIMDALL_URL=https://license.circuitforge.tech
|
|
# HEIMDALL_ADMIN_TOKEN=
|
|
|
|
# ── eBay Affiliate (optional) ─────────────────────────────────────────────────
|
|
# Set to your eBay Partner Network (EPN) campaign ID to earn commissions on
|
|
# listing click-throughs. Leave blank for clean /itm/ URLs (no tracking).
|
|
# Register at https://partnernetwork.ebay.com — self-hosted users can use their
|
|
# own ID; the CF cloud instance uses CF's campaign ID (disclosed in the UI).
|
|
# EBAY_AFFILIATE_CAMPAIGN_ID=
|
|
|
|
# ── LLM inference (vision / photo analysis) ──────────────────────────────────
|
|
# circuitforge-core LLMRouter auto-detects backends from these env vars
|
|
# (no llm.yaml required). Backends are tried in this priority order:
|
|
# 1. ANTHROPIC_API_KEY → Claude API (cloud; requires Paid tier key)
|
|
# 2. OPENAI_API_KEY → OpenAI-compatible endpoint
|
|
# 3. OLLAMA_HOST → local Ollama (default: http://localhost:11434)
|
|
# Leave all unset to disable LLM features (photo analysis won't run).
|
|
|
|
# ANTHROPIC_API_KEY=
|
|
# ANTHROPIC_MODEL=claude-haiku-4-5-20251001
|
|
|
|
# OPENAI_API_KEY=
|
|
# OPENAI_BASE_URL=https://api.openai.com/v1
|
|
# OPENAI_MODEL=gpt-4o-mini
|
|
|
|
# OLLAMA_HOST=http://localhost:11434
|
|
# OLLAMA_MODEL=llava:7b
|
|
|
|
# CF Orchestrator — routes vision/LLM tasks to a cf-orch coordinator for VRAM management.
|
|
# Self-hosted: point at a local cf-orch coordinator if you have one running.
|
|
# Cloud (internal): managed coordinator at orch.circuitforge.tech.
|
|
# Leave unset to run vision tasks inline (no VRAM coordination).
|
|
# CF_ORCH_URL=http://10.1.10.71:7700
|
|
#
|
|
# cf-orch agent (compose --profile orch) — coordinator URL for the sidecar agent.
|
|
# Defaults to CF_ORCH_URL if unset.
|
|
# CF_ORCH_COORDINATOR_URL=http://10.1.10.71:7700
|
|
|
|
# ── In-app feedback (beta) ────────────────────────────────────────────────────
|
|
# When set, a feedback FAB appears in the UI and routes submissions to Forgejo.
|
|
# Leave unset to silently hide the button (demo/offline deployments).
|
|
# FORGEJO_API_TOKEN=
|
|
# FORGEJO_REPO=Circuit-Forge/snipe
|
|
# FORGEJO_API_URL=https://git.opensourcesolarpunk.com/api/v1
|