OBP API with Docker

These instructions guide how to run OBP API, API Explorer, PostgreSQL, and Kafka using Docker. We first build the OBP API and API Explorer projects using maven, and then use Jetty Docker containers to run them.

Build the OBP API Project using Maven

1. Clone the OBP API project from github

git clone https://github.com/OpenBankProject/OBP-API.git

2. Create the props file for the project

Create a props file named default.props under the directory OBP-API/src/main/resources/props containing the following minimal configurations. Change the values as necessary

connector=kafka_vMar2017 # Replace this with connector=mapped if you are not using Kafka
kafka.bootstrap_hosts=kafka:9092
kafka.request_topic=Request
kafka.response_topic=Response
kafka.zookeeper_host=zookeeper:2181
kafka.host=kafka:9092
db.driver=org.postgresql.Driver
db.url=jdbc:postgresql://obp-postgres:5432/obp-api-db?user=obp-api-db-user&password=thepassword
hostname=http://obpapi:8080
webui_header_logo_left_url = /media/images/logo.png
webui_header_logo_right_url =
webui_index_page_about_section_background_image_url = /media/images/about-background.jpg
webui_index_page_about_section_text = <p class="about-text"> \
                                        Welcome to the API Sandbox powered by the Open Bank Project! <br/> \
                                      </p>
webui_api_explorer_url = http://apiexplorer:8080
super_admin_user_ids=USER1

3. Build the project

• Go to the directory of the project cd OBP-API
• Build using maven mvn package
• This will generate the OBP-API-1.0.war file of the project under the directory OBP-API/tartget/

Build the API Explorer Project using Maven

Run the containers using Docker Compose