openbankproject/obp-api repository overview

⁠About

This⁠ docker image contains the OpenBankProject: API⁠, licensed under the AGPL v3⁠ and commercial licenses from TESOBE GmbH.

⁠Quickstart

⁠Prerequisites:

⁠Redis

OBP expects Redis server running on localhost:6379 per default. You can use the official Redis⁠ image to run a Redis server.

Run the following command to start a Redis server using the host network for easy access:

$ sudo docker run --name some-redis --network host -d redis

⁠Database

OBP needs a database to persist data. Read more about OBP's database requirements here⁠.

The image uses a local H2 database by default. To persist the h2 database, a persistent volume need to be mounted to the container, and the database path adjusted.

For production use, it is recommended to use a PostgreSQL database. You can use a PostgreSQL⁠ image to run a PostgreSQL server.

Run the following command to start a PostgreSQL server using the host network for easy access with the data directory persising on the host:

docker run --network host -d \
    -v /your/local/path/to/postgresql-persistence:/bitnami/postgresql \
    bitnami/postgresql:latest

⁠Configuration

Use environment variables to configure OBP API. A list of available props can be found in the OBP API documentation⁠. Every OBP props key needs to be modified for use as environment variable using the following algorithm:

Props need to be prefixed with OBP_, . replaced with _, and all upper-case, e.g.:

openid_connect.enabled=true becomes OBP_OPENID_CONNECT_ENABLED=true

Minimal configuration for NON PRODUCTION use with postgresql database:

OBP_CONNECTOR=mapped
OBP_HOSTNAME=http://localhost:8080
OBP_DB_DRIVER=org.postgresql.Driver
OBP_DB_URL=jdbc:postgresql://localhost:5432/dbname?user=dbusername&password=dbpassword
OBP_MIGRATION_SCRIPTS_EXECUTE_ALL=true
OBP_MIGRATION_SCRIPTS_ENABLED=true
OBP_CONSUMERS_ENABLED_BY_DEFAULT=true
OBP_AUTHUSER_SKIPEMAILVALIDATION=true

⁠Run OBP API

Save the configuration in a file named e.g obp-api.env. Run the following command to start the OBP API container on host network:

docker run --network host -d --env-file obp-api.env openbankproject/obp-api

Alternatively, you can pass the configuration as environment variables directly:

docker run --network host \
-e OBP_CONNECTOR=mapped \
-e OBP_HOSTNAME=http://localhost:8080 \
-e OBP_DB_DRIVER=org.postgresql.Driver \
-e OBP_DB_URL=jdbc:postgresql://localhost:5432/dbname?user=dbusername&password=dbpassword \
-e OBP_MIGRATION_SCRIPTS_EXECUTE_ALL=true \
-e OBP_MIGRATION_SCRIPTS_ENABLED=true \
-e OBP_DEV_PORT=8080 \
-e OBP_APIPATHZERO=obp \
-e OBP_CONSUMERS_ENABLED_BY_DEFAULT=true \
-e OBP_AUTHUSER_SKIPEMAILVALIDATION=true \
openbankproject/obp-api

⁠Validate Image Signature

Paste image public cosign key into a file cosign.pub:

-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEiIhxZCZZ/KDvlSwMFO3clGXhiiXu
G+FtuBGJqw9guyd3NotlWNUUt9OUdffFSZOu536uV0w7RNG3NjYgvA3SXw==
-----END PUBLIC KEY-----

get cosign⁠ and run

cosign verify --key cosign.pub docker.io/openbankproject/obp-api:latest