Spaces:
Configuration error
Configuration error
Upload folder using huggingface_hub
Browse files- README.md +3 -1
- deploy/kubernetes/arf-api/secret.yaml +14 -1
README.md
CHANGED
|
@@ -24,9 +24,11 @@ ARF_HMC_MODEL – path to HMC model JSON (default: models/hmc_model.json)
|
|
| 24 |
|
| 25 |
ARF_USE_HYPERPRIORS – true/false
|
| 26 |
|
| 27 |
-
API_KEY –
|
| 28 |
```
|
| 29 |
|
|
|
|
|
|
|
| 30 |
3. **Run the app locally**:
|
| 31 |
|
| 32 |
```bash
|
|
|
|
| 24 |
|
| 25 |
ARF_USE_HYPERPRIORS – true/false
|
| 26 |
|
| 27 |
+
API_KEY – dead setting, not read by any current route (see docs/authentication.md)
|
| 28 |
```
|
| 29 |
|
| 30 |
+
The settings that actually gate access are `ARF_INTERNAL_API_KEY` and `ARF_ADMIN_API_KEY`, not `API_KEY` above — see [docs/authentication.md](docs/authentication.md) for what's actually enforced and what isn't yet.
|
| 31 |
+
|
| 32 |
3. **Run the app locally**:
|
| 33 |
|
| 34 |
```bash
|
deploy/kubernetes/arf-api/secret.yaml
CHANGED
|
@@ -1,3 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
apiVersion: v1
|
| 2 |
kind: Secret
|
| 3 |
metadata:
|
|
@@ -5,7 +18,7 @@ metadata:
|
|
| 5 |
namespace: arf-system
|
| 6 |
type: Opaque
|
| 7 |
stringData:
|
| 8 |
-
#
|
| 9 |
DATABASE_URL: "postgresql://user:password@host:5432/arf"
|
| 10 |
ARF_INTERNAL_API_KEY: "change-me-to-a-strong-random-key"
|
| 11 |
ARF_API_KEYS: '{}'
|
|
|
|
| 1 |
+
# DO NOT apply this file as-is. Every value below is a placeholder, not a
|
| 2 |
+
# real secret -- ARF_INTERNAL_API_KEY in particular is a fixed, publicly
|
| 3 |
+
# visible string in this repo's git history. Applying it unmodified means
|
| 4 |
+
# the "secret" is a known value, not a secret.
|
| 5 |
+
#
|
| 6 |
+
# Generate real values instead, e.g.:
|
| 7 |
+
# kubectl create secret generic arf-api-secrets -n arf-system \
|
| 8 |
+
# --from-literal=DATABASE_URL=... \
|
| 9 |
+
# --from-literal=ARF_INTERNAL_API_KEY=$(openssl rand -hex 32) \
|
| 10 |
+
# --from-literal=ARF_API_KEYS='{}' \
|
| 11 |
+
# --from-literal=ARF_REDIS_URL=...
|
| 12 |
+
# or manage this via a secrets operator (External Secrets, Sealed Secrets,
|
| 13 |
+
# SOPS) rather than a plain committed manifest.
|
| 14 |
apiVersion: v1
|
| 15 |
kind: Secret
|
| 16 |
metadata:
|
|
|
|
| 18 |
namespace: arf-system
|
| 19 |
type: Opaque
|
| 20 |
stringData:
|
| 21 |
+
# Placeholders only -- see warning above. Replace before applying.
|
| 22 |
DATABASE_URL: "postgresql://user:password@host:5432/arf"
|
| 23 |
ARF_INTERNAL_API_KEY: "change-me-to-a-strong-random-key"
|
| 24 |
ARF_API_KEYS: '{}'
|