pyr0ball
2dda26a911
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.
39 lines
1.3 KiB
Markdown
39 lines
1.3 KiB
Markdown
# eBay API Keys (Optional)
|
|
|
|
Snipe works without any credentials using its Playwright scraper fallback. Adding eBay API credentials unlocks faster searches and higher rate limits.
|
|
|
|
## What API keys enable
|
|
|
|
| Feature | Without keys | With keys |
|
|
|---------|-------------|-----------|
|
|
| Listing search | Playwright scraper | eBay Browse API (faster, higher limits) |
|
|
| Market comps (completed sales) | Not available | eBay Marketplace Insights API |
|
|
| Seller account data | BTF scraper (Xvfb) | BTF scraper (same — eBay API doesn't expose join date) |
|
|
|
|
## Getting credentials
|
|
|
|
1. Create a developer account at [developer.ebay.com](https://developer.ebay.com/my/keys)
|
|
2. Create a new application (choose **Production**)
|
|
3. Copy your **App ID (Client ID)** and **Cert ID (Client Secret)**
|
|
|
|
## Configuration
|
|
|
|
Add your credentials to `.env`:
|
|
|
|
```bash
|
|
EBAY_APP_ID=YourAppID-...
|
|
EBAY_CERT_ID=YourCertID-...
|
|
```
|
|
|
|
Then restart:
|
|
|
|
```bash
|
|
./manage.sh restart
|
|
```
|
|
|
|
## Verifying
|
|
|
|
After restart, the search bar shows **API** as available in the data source selector. The auto mode will use the API by default.
|
|
|
|
!!! note
|
|
The Marketplace Insights API (for completed sales comps) requires an approved eBay developer account. New accounts may not have access. Snipe gracefully falls back to Browse API results when Insights returns 403 or 404.
|