Collateral-Provider/collateral_provider/sample.env at main · logical-mechanism/Collateral-Provider · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# Required ----------------------------------------------------------------

PKH=
DJANGO_SECRET_KEY=

# "production" or "development". Controls ALLOWED_HOSTS handling and
# default log levels.
ENVIRONMENT=development

# Comma-separated list. Required when ENVIRONMENT != "development".
ALLOWED_HOSTS=your-production-domain.com,www.your-production-domain.com

# Per-network: which collateral UTxO this provider sponsors.
PREPROD_TXID=
PREPROD_TXIDX=
PREPROD_NETWORK=--testnet-magic 1

MAINNET_TXID=
MAINNET_TXIDX=0
MAINNET_NETWORK=--mainnet

# Optional ----------------------------------------------------------------

# Where to find the Cardano-CLI-style payment.skey / payment.vkey files.
# Defaults to the api/key/ directory inside the repo (fine for dev/tests;
# production deployments should put keys outside the checkout).
# SKEY_PATH=/etc/collateral-provider/keys/payment.skey
# VKEY_PATH=/etc/collateral-provider/keys/payment.vkey

# Per-IP rate limit for /<env>/collateral/. Format: "<count>/<period>"
# where period is sec/min/hour/day. Default: 60/min.
# COLLATERAL_THROTTLE_RATE=60/min

# Koios JSON-RPC ogmios endpoint per network. Override to self-host or use
# alternate networks (preview, sanchonet). Defaults match Koios's public
# hosting (https://preprod.koios.rest/api/v1/ogmios for preprod,
# https://api.koios.rest/api/v1/ogmios for mainnet).
# PREPROD_KOIOS_URL=https://preprod.koios.rest/api/v1/ogmios
# MAINNET_KOIOS_URL=https://api.koios.rest/api/v1/ogmios

# Logging. LOG_LEVEL applies to the api logger; LOG_FILE is the rotated
# file path (1 MiB x 3 backups). Defaults: DEBUG and ./debug.log.
# LOG_LEVEL=INFO
# LOG_FILE=/var/log/collateral-provider/app.log

# Log line format: "text" (default; human-readable, what the file currently
# looks like) or "json" (one JSON object per line, for ingest into Datadog,
# Loki, Splunk, etc.).
# LOG_FORMAT=json

# Throttle / DRF cache directory. Default: ./.cache inside the project.
# CACHE_DIR=/var/cache/collateral-provider

# Operator-curated data files. Both are read on every request but only
# re-parsed when the file's mtime advances — edit them live without
# bouncing the service.
#   bans.json    -> {"addresses": [<hex>...], "ips": [<v4|v6>...]}
#   known.hosts  -> registry of providers keyed by PKH (also used by /
#                   landing page and /known_hosts/).
# Defaults are bans.json next to manage.py and known.hosts.json at the
# repo root. See bans.json.example for the bans shape.
# BANS_PATH=/etc/collateral-provider/bans.json
# KNOWN_HOSTS_PATH=/etc/collateral-provider/known.hosts.json

# Prometheus /metrics. Off by default (the URL 404s). When on, only IPs in
# METRICS_ALLOW_IPS can reach it (default: localhost only). Run the scraper
# on the same host or behind a private network.
# METRICS_ENABLED=True
# METRICS_ALLOW_IPS=127.0.0.1,::1,10.0.0.5

# X-Forwarded-For is only trusted if the request's immediate peer is one
# of these IPs. Each entry is either a bare IP (127.0.0.1) or a CIDR
# block (10.0.0.0/8) — the latter is what container platforms like
# DigitalOcean App Platform need, since their load-balancer egress isn't
# a single pinned IP. Defaults to localhost (right when nginx/Caddy is
# on the same host as gunicorn). An empty list disables XFF trust
# entirely.
# TRUSTED_PROXY_IPS=127.0.0.1,::1
# TRUSTED_PROXY_IPS=10.0.0.0/8,172.16.0.0/12,192.168.0.0/16