Als je verzoeken binnen je eigen infrastructuur wilt houden, draai dan een eigen instantie met de officiële image van Docker Hub. De image werkt op amd64 en arm64.

Snel aan de slag

De snelste manier om te starten:

docker run -d --init -p 8080:8080 lineofflight/frankfurter

Dit start Frankfurter op poort 8080 met een tijdelijke database in het geheugen. Totdat de eerste synchronisatie is voltooid, kunnen sommige endpoints leeg zijn.

Productie

Koppel in productie een volume zodat de SQLite-database behouden blijft bij herstarts:

docker run -d --init -p 8080:8080 \
  -e DATABASE_URL="sqlite:///data/db.sqlite3" \
  -v ./data:/data \
  --pull always \
  lineofflight/frankfurter

Zonder volume is de database tijdelijk en wordt deze bij elke herstart opnieuw opgebouwd.

Met --pull always haalt Docker bij elke start de nieuwste image op.

API-sleutels

Enkele gegevensbronnen vereisen een API-sleutel. Deze sleutels zijn gratis en optioneel.

docker run -d --init -p 8080:8080 \
  -e DATABASE_URL="sqlite:///data/db.sqlite3" \
  -e BAM_API_KEY="your_key" \
  -e BANXICO_API_KEY="your_key" \
  -e BCCH_USER="your_email" \
  -e BCCH_PASS="your_password" \
  -e BOT_API_KEY="your_key" \
  -e FRED_API_KEY="your_key" \
  -e TCMB_API_KEY="your_key" \
  -v ./data:/data \
  --pull always \
  lineofflight/frankfurter

BAM_API_KEY

Gegevens van Bank Al-Maghrib. Registreren via apihelpdesk.centralbankofmorocco.ma.

BANXICO_API_KEY

Gegevens van Banco de México. Registreren via banxico.org.mx.

BCCH_USER en BCCH_PASS

Gegevens van Banco Central de Chile. Registreren via bcentral.cl.

BOT_API_KEY

Gegevens van Bank of Thailand. Registreren via gateway.api.bot.or.th.

FRED_API_KEY

Gegevens van de Federal Reserve. Registreren via fred.stlouisfed.org.

TCMB_API_KEY

Gegevens van de Centrale Bank van Turkije. Registreren via evds3.tcmb.gov.tr.