coulomb/reuse-surface
2
0
Fork 0
generated from coulomb/repo-seed
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Align naming with coulomb.social reuse-surface conventions
Some checks failed
ci / validate-registry (push) Has been cancelled
Details

Browse Source 
Use reuse.coulomb.social, REUSE_SURFACE_URL/TOKEN env vars, reuse-surface
image and reuse-surface-env secret. Replace reuse-surface-hub entrypoint with
reuse-surface serve; CLI uses --base-url.
This commit is contained in:
Bernd Worsch
2026-06-15 09:02:02 +02:00
parent 4f98506f18
commit cbcd097214
13 changed files with 120 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
specs/FederationHubAPI.md
View File

@@ -21,7 +21,7 @@ Companion deployment workplan: `railiance-apps` **RAILIANCE-WP-0007**.
| Item | Value |
|---|---|
| Default production URL | `https://reuse-hub.whywhynot.de` (confirm at deploy) |
| Default production URL | `https://reuse.coulomb.social` |
| API prefix | `/v1` |
| Read formats | JSON (default), YAML via `Accept: application/yaml` or `?format=yaml` |
| Write content type | `application/json` |
@@ -30,8 +30,8 @@ Environment variables for clients:
| Variable | Purpose |
|---|---|
| `REUSE_SURFACE_HUB_URL` | Hub base URL (no trailing slash) |
| `REUSE_SURFACE_HUB_TOKEN` | Bearer token for write operations |
| `REUSE_SURFACE_URL` | Service base URL (no trailing slash) |
| `REUSE_SURFACE_TOKEN` | Bearer token for write operations |
---
@@ -45,7 +45,7 @@ Environment variables for clients:
Write requests must include:
```http
Authorization: Bearer <REUSE_SURFACE_HUB_TOKEN>
Authorization: Bearer <REUSE_SURFACE_TOKEN>
```
Missing or invalid token → `401 Unauthorized`.
@@ -88,7 +88,7 @@ Liveness/readiness probe.
```json
{
"status": "ok",
"service": "reuse-surface-hub",
"service": "reuse-surface",
"version": "0.1.0"
}
```
@@ -232,10 +232,10 @@ Non-2xx responses use:
| Env var | Required | Purpose |
|---|---|---|
| `REUSE_SURFACE_HUB_TOKEN` | yes | Write API bearer token |
| `REUSE_SURFACE_HUB_DB` | no | SQLite path (default `/data/hub.db`) |
| `REUSE_SURFACE_HUB_CACHE_DIR` | no | Remote index cache (default `/data/cache`) |
| `REUSE_SURFACE_HUB_DOMAIN` | no | Default federated `domain` (default `helix_forge`) |
| `REUSE_SURFACE_TOKEN` | yes | Write API bearer token |
| `REUSE_SURFACE_DB` | no | SQLite path (default `/data/reuse.db`) |
| `REUSE_SURFACE_CACHE_DIR` | no | Remote index cache (default `/data/cache`) |
| `REUSE_SURFACE_DOMAIN` | no | Default federated `domain` (default `helix_forge`) |
---
@@ -249,13 +249,16 @@ Non-2xx responses use:
| `reuse-surface hub register ...` | `POST /v1/repos` |
| `reuse-surface hub update ...` | `PATCH /v1/repos/{repo}` |
Global flags: `--hub-url`, env `REUSE_SURFACE_HUB_URL`, `REUSE_SURFACE_HUB_TOKEN`.
Run locally: `reuse-surface serve`. Global client flags: `--base-url`, env
`REUSE_SURFACE_URL`, `REUSE_SURFACE_TOKEN`.
---
## 9. Deployment reference
- Image: `gitea.coulomb.social/coulomb/reuse-surface-hub:<tag>`
- Image: `gitea.coulomb.social/coulomb/reuse-surface:<tag>`
- Public URL: `https://reuse.coulomb.social`
- Secret: `reuse-surface-env` with `REUSE_SURFACE_TOKEN`
- Probe path: `/health`
- Persistence: PVC at `/data` (SQLite + fetch cache)
- Helm release: `railiance-apps` RAILIANCE-WP-0007