Skip to main content

Quickstart Guide

This guide will help you set up and run OLIVE locally using Docker Compose.

Prerequisites

  • Docker and Docker Compose installed
  • At least 4GB of available memory
  • Git to clone the repository

Setup

1. Clone the Repository

2. Configure Environment

Copy the example environment file and configure your settings:
Edit .env with your configuration:

3. Start Services

4. Verify Health

Expected response:

Your First API Call

Check Balance

Create a Payment

Service Ports

Viewing Logs

Stopping Services

Next Steps

Subscriber Registration

Learn how to register users and complete KYC

API Reference

Explore all available endpoints

Agent-TS

Set up the WhatsApp conversational agent

Security

Configure authentication and TLS